diff --git a/.github/bot.yml b/.github/bot.yml index 46bdc802d..bdb62d242 100644 --- a/.github/bot.yml +++ b/.github/bot.yml @@ -2,42 +2,46 @@ # Enable "labeler" for your PR that would add labels to PRs based on the paths that are modified in the PR. labelPRBasedOnFilePath: Images: - - products/**/*.png - - products/**/*.svg - - products/**/*.jpg - - products/**/*.jpeg + - docs/**/*.png + - docs/**/*.svg + - docs/**/*.jpg + - docs/**/*.jpeg Docs: - - products/**/*.md* + - docs/**/*.md* Tools: - - products/idn/docs/identity-now/tools/**/* + - docs/tools/**/* CLI Docs: - - products/idn/docs/identity-now/tools/cli/**/* + - docs/tools/cli/**/* SDK Docs: - - products/idn/docs/identity-now/tools/sdk/**/* + - docs/tools/sdk/**/* Rule Development Kit Docs: - - products/idn/docs/identity-now/tools/rule-development-kit/**/* + - docs/tools/rule-development-kit/**/* IdentityNow: - - products/idn/**/* + - docs/extensibility/**/* + - docs/connectivity/**/* + - docs/api/**/* + - docs/guides/**/* + - docs/reporting/**/* NERM: - - products/nerm/**/* + - docs/nerm/**/* IdentityIQ: - - products/iiq/**/* + - docs/iiq/**/* Event Trigger Docs: - - products/idn/docs/identity-now/event-triggers/**/* + - docs/extensibility/event-triggers/**/* SaaS Connectivity Docs: - - products/idn/docs/identity-now/saas-connectivity/**/* + - docs/connectivity/saas-connectivity/**/* Secure Data Share (SDS): - - products/idn/docs/identity-now/secure-data-share/**/* + - docs/reporting/secure-data-share/**/* Access Intelligence Center (AIC): - - products/idn/docs/identity-now/access-intelligence-center/**/* + - docs/reporting/access-intelligence-center/**/* Transform Docs: - - products/idn/docs/identity-now/transforms/**/* + - docs/extensibility/transforms/**/* Rules Docs: - - products/idn/docs/identity-now/rules/**/* + - docs/extensibility/rules/**/* SaaS Configuration Docs: - - products/idn/docs/identity-now/saas-configuration.md* + - docs/extensibility/configuration-management/saas-configuration.md* Introduction Doc: - - products/idn/docs/identity-now/index.md* + - docs/index.md* Pages: - src/pages/**/* Static Files: diff --git a/.github/workflows/checkmarx-scan-on-pull.yml b/.github/workflows/checkmarx-scan-on-pull.yml new file mode 100644 index 000000000..d8bd1a5e9 --- /dev/null +++ b/.github/workflows/checkmarx-scan-on-pull.yml @@ -0,0 +1,85 @@ +# This workflow executes Checkmarx scans (SAST & SCA) on pull requests. It runs in a self-hosted actions runner +# hosted in AWS. The flow has 3 parts: 1) start the ec2 runner instance 2) carry out the scans via CxFlow and +# 3) stop the ec2 runner instance. It uses the following GitHub secrets: +# AWS_EC2_INSTANCE_ID +# CHECKMARX_URL +# CHECKMARX_USERNAME +# CHECKMARX_PASSWORD +# CHECKMARX_URL +# CHECKMARX_CLIENT_SECRET +# SCA_USERNAME +# SCA_PASSWORD +# +# To change the severity threshold, modify the --cx-flow.filter-severity parameter in the CxFlow job below + + +name: CheckMarx Scan on Pull Request +on: + #pull_request: + workflow_dispatch: + +jobs: + start-runner: + name: Start self-hosted EC2 runner + permissions: + id-token: write # For OIDC connection + runs-on: ubuntu-latest + steps: + - name: Configure AWS credentials + uses: aws-actions/configure-aws-credentials@v4 + with: + role-to-assume: arn:aws:iam::143694264087:role/GithubActions + role-session-name: github-actions-runner-start-ec2 + aws-region: us-east-1 + - name: Start AWS EC2 + # Run AWS Command on the GitHub Hosted runner which starts the instance + run: | + aws ec2 start-instances --instance-ids ${{secrets.AWS_EC2_INSTANCE_ID }} + + run-cxflow: + name: Execute CxFlow + # The type of runner that the job will run on - Ubuntu is required as Docker is leveraged for the action + permissions: + contents: read # for actions/checkout to fetch code + issues: write # for checkmarx-ts/checkmarx-cxflow-github-action to write feedback to github issues + pull-requests: write # for checkmarx-ts/checkmarx-cxflow-github-action to write feedback to PR + security-events: write # for github/codeql-action/upload-sarif to upload SARIF results + actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status + needs: start-runner # required to start the main job when the runner is ready + runs-on: [self-hosted, AWS, AppSec] + # Steps require - checkout code, run CxFlow Action, Upload SARIF report (optional) + steps: + # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it + - uses: actions/checkout@v4 + # Runs the Checkmarx Scan leveraging the latest version of CxFlow - REFER to Action README for list of inputs + - name: Checkmarx CxFlow Action + uses: checkmarx-ts/checkmarx-cxflow-github-action@49d8269b14ca87910ba003d47a31fa0c7a11f2fe + with: + project: sailpoint-oss-${{ github.event.repository.name }} + team: CxServer/OSS + # sast secrets + checkmarx_url: ${{ secrets.CHECKMARX_URL }} + checkmarx_username: ${{ secrets.CHECKMARX_USERNAME }} + checkmarx_password: ${{ secrets.CHECKMARX_PASSWORD }} + checkmarx_client_secret: ${{ secrets.CHECKMARX_CLIENT_SECRET }} + # sca secrets + sca_api_url: https://api-sca.checkmarx.net + sca_app_url: https://sca.checkmarx.net + sca_access_control_url: https://platform.checkmarx.net + sca_username: ${{ secrets.SCA_USERNAME }} + sca_password: ${{ secrets.SCA_PASSWORD }} + sca_tenant: sailpoint + scanners: sast, sca + params: --namespace=${{ github.repository_owner }} --repo-name=${{ github.event.repository.name }} --branch=${{ github.ref }} --cx-flow.filter-severity=high --cx-flow.filter-category --checkmarx.disable-clubbing=true --repo-url=${{ github.event.repository.url }} + + # Upload the Report for CodeQL/Security Alerts + - name: Upload SARIF file + uses: github/codeql-action/upload-sarif@v2 + with: + sarif_file: cx.sarif + # post-job task is a script referenced in .env file (cleans up the _work directory) + + ############################# + # We can't shut down the runner, as another workflow run might be queued up already. + # Shutdown will be handled with a CloudWatch Alarm + ############################# diff --git a/.github/workflows/infra-deploy.yml b/.github/workflows/infra-deploy.yml index ef2f280d8..6cdde124c 100644 --- a/.github/workflows/infra-deploy.yml +++ b/.github/workflows/infra-deploy.yml @@ -57,7 +57,7 @@ jobs: - name: run SAM build run: | sam build - sam deploy --no-confirm-changeset --no-fail-on-empty-changeset --stack-name $STACK --s3-prefix $STACK + sam deploy --no-confirm-changeset --no-fail-on-empty-changeset --stack-name $STACK --s3-prefix $STACK --parameter-overrides ParameterKey=AuthUsername,ParameterValue='${{ secrets.AUTH_USERNAME }}' ParameterKey=AuthPassword,ParameterValue='${{ secrets.AUTH_PASSWORD }}' - name: Get S3 bucket location, cloudfront url, and api gateway url run: | export S3_BUCKET=$(aws cloudformation describe-stacks --stack-name $STACK --query "Stacks[0].Outputs[?OutputKey=='DeveloperSailpointWebS3BucketName'].OutputValue" --output text) @@ -76,6 +76,7 @@ jobs: - name: Build Developer Community site run: | echo "CMS_APP_API_ENDPOINT=$API_GATEWAY_URL" >> .env + echo ${{ secrets.NPM_FONTAWESOME_CONFIG }} | base64 -d >> .npmrc export NODE_OPTIONS="--max_old_space_size=4096" npm ci --legacy-peer-deps npm run gen-api-docs-all diff --git a/.gitignore b/.gitignore index 0c6e40d0d..42833e7ae 100644 --- a/.gitignore +++ b/.gitignore @@ -28,6 +28,14 @@ yarn.lock /products/iiq/api /products/nerm/api +/docs/api/v3 +/docs/api/beta +/docs/api/iiq +/docs/api/nerm/* +!/docs/api/nerm/authentication.md +!/docs/api/nerm/pagination-metadata-filtering.md +!/docs/api/nerm/getting-started.md + #Alogolia env file /algolia/.env diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c3e100199..2e5002d89 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,81 +1,148 @@ -# Contributing to developer.sailpoint.com +# Contribute to developer.sailpoint.com -We love your input! We want to make contributing to this project as easy and transparent as possible. Look below if you would like to: +The SailPoint Developer Relations Team is always actively working to improve https://developer.sailpoint.com to make the site as useful as possible to the SailPoint Developer Community. +This means adding and maintaining new resources for the community, like new tools and educational content, along with accurate, complete, and current guides and information. +The most valuable resource of all, however, is the community itself! +We greatly appreciate any input, feedback, and direct contributions you can provide to the community, big or small. +And we want to make the process of contributing to this project as easy and transparent as possible. -- [Report an issue](#reporting-issues) -- [Make a feature request](#making-feature-requests) -- [Submit a fix](#submitting-a-fix) -- [Submit a new feature](#submitting-a-new-feature) -- [Submit a general issue or ask a question](#discussing-general-issues-or-questions) +This document will detail the different ways that you can contribute to the community. -# High-level Guidelines +These are the main ways that you can contribute: +- [Report issues](#report-issues) +- [Request new features](#request-new-features) +- [Submit a fix](#submit-a-fix) +- [Submit a new feature](#submit-a-new-feature) -## We Develop with GitHub +## How we use GitHub -We use GitHub to host code, track issues and feature requests, and accept pull requests. +We use GitHub to host code, track issues and feature requests, and manage contributions with pull requests. -## We Use GitHub Flow +This project is open source, which means that it's publicly accessible, allowing anyone who comes across it to view, share, and improve its source code. -Pull requests are the best way to propose changes to the codebase, and [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow) is our preferred method of accepting pull requests. The basics of GitHub flow are as follows: +## GitHub flow and pull requests -1. Fork the repo and create your branch from `main`. -2. Make your changes. -3. Issue your pull request! +The best way to propose changes to the codebase is to use pull requests, and [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow) is our preferred method of accepting pull requests. -## We Use the MIT Software License +This is the basic GitHub flow we use for direct contributions to the codebase: -In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. +1. Fork the repository and create your own branch from `main`. +2. Make your changes in your `main` branch. +3. Push the changes to the repository's `main` branch. +4. Create your pull request! +5. SailPoint Developer Relations team members will review your pull request and merge it in! -# Reporting Issues +## GitHub Issues -We use GitHub issues to track bugs publicly. If you see an issue with the site, please [report it here](https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here); +We use [GitHub Issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) to publicly track bugs and feature requests. -Our maintainers _love_ thorough bug reports. **Great bug reports** tend to have: +## Report issues -- A quick summary and/or description -- Steps to reproduce - - Be specific! - - Give sample code if you can. -- What you expected would happens -- What actually happens -- Screenshots! -- Operating System -- Browser -- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) +You may encounter bugs and incorrect or outdated information when you explore the site. +We appreciate your help in identifying bugs of all sizes, from broken links or typos to major issues preventing you from using a resource. -# Making Feature Requests +We use GitHub issues to track bugs publicly. If you see an issue with the site, please [report it here](https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here). -We use GitHub issues to track feature requests. Please use [this template](https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=feature-request.md&title=%5BFeature%5D+Your+Feature+Request+Here) when requesting a new feature. +We love thorough bug reports. +The more details you include, the faster we can troubleshoot and fix the issue. +Great bug reports include these details: -**Great feature requests** tend to: +1. A summary of the issue +2. The steps we can take to reproduce the issue + - Be as specific as you can when you describe these steps. + - Give us sample code if you can. +3. What you expect to happen +4. What actually happens +5. Screenshots +6. The operating system you were using when you encountered the issue +7. The browser you were using when you encountered the issue +8. Notes + - If you have an idea, tell us why you think the issue may be occurring, or what you think we should do to resolve it. + - Whatever you tried that didn't work. + - Anything else you think might be useful to us. -- Say if this is related to a problem (and describe said problem) -- Describe the solution you'd like -- Describe alternatives you use or have considered -- Notes (possibly including how you think this might benefit others) +## Request new features -# Submitting a Fix +Many of our most valuable resources originate in ideas suggested by the community! +You may have an idea that will improve the site. +We would love to hear it and possibly implement it! -Looking to fix something yourself? Great! Here are the steps to contribute a fix: +We use GitHub issues to track feature requests. Please use [this template](https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=feature-request.md&title=%5BFeature%5D+Your+Feature+Request+Here) when you request a new feature. -- Fork the repository, copy the main branch only -- Pull down the code, build, and ensure it's running properly -- Create a new branch from main with the naming convention `fix/your-fix-name` -- Create a pull request from your branch to our origin repository's main branch! +We love thorough feature requests. +The more details you include, the faster we can implement your request. +Great feature requests include these details: -# Submitting a New Feature +1. Tell us whether this feature is related to a problem. + - If it is, describe the problem. +2. Describe your desired solution. +3. Describe alternative solutions you may use yourself or other solutions you may have considered. +4. Notes + - If possible, include how you think this solution would benefit others. + - Anything else you think might be useful to us. -Looking to add a new feature yourself? Great! Here are the steps to contribute a feature: +## Submit a fix -- Fork the repository, copy the main branch only -- Pull down the code, build, and ensure it's running properly -- Create a new branch from main with the naming convention `feature/your-feature-name` -- Create a pull request from your branch to our origin repository's main branch! +One of the main benefits of making our project open source is that it makes it possible for the community to contribute directly. +We will always respond as quickly as we can to any issues you report, but if you know how to fix an issue, the fastest way to get it fixed is to submit a pull request and make the fix yourself! +If you can do this, it's tremendously helpful to us in our efforts to improve the community, and, if you're interested, you will receive ambassador points for your fix. +Check out the [ambassador program](https://developer.sailpoint.com/discuss/t/getting-started-as-a-developer-community-ambassador/11665) to learn more. -# Discussing General Issues or Questions +To submit a fix, follow these steps: +1. Fork the repository and copy the `main` branch. +2. Pull the latest code and ensure that it's running properly. +3. Create a new branch from main. + - Follow this naming convention for your branch: `fix/your-fix-name` +4. Create a pull request from your branch to our origin repository's `main` branch! -If none of the above options work for you, you can submit a general issue using GitHub's [issues](https://github.com/sailpoint-oss/developer.sailpoint.com/issues). You can also head over to the [Developer Community forum](https://developer.sailpoint.com/discuss) to discuss with us directly on the forum about what you're thinking! +Once you create the pull request, the SailPoint Developer Relations Team will be tagged. +Someone will then review the pull request and merge it in! -# License +:::note -By contributing, you agree that your contributions will be licensed under the MIT License. +You cannot directly make changes to the API specifications. These files are regularly pulled from a private repository and auto-generated. + +::: + +## Submit a new feature + +We will always respond to your feature requests and implement them as soon as we can. +However, if you have an idea for a new feature and know how to implement it yourself, the fastest way to add the feature is to submit a pull request and add the feature yourself! +If you can do this, we greatly appreciate it, and other community members will benefit from your contribution! +And if you're interested, you will receive ambassador points for your feature contribution. +Check out the [ambassador program](https://developer.sailpoint.com/discuss/t/getting-started-as-a-developer-community-ambassador/11665) to learn more. + +To submit a new feature, follow these steps: +1. Fork the repository and copy the `main` branch. +2. Pull the latest code and ensure that it's running properly. +3. Create a new branch from main. + - Follow this naming convention for your branch: `feature/your-feature-name` +4. Create a pull request from your branch to our origin repository's `main` branch! + +Once you create the pull request, the SailPoint Developer Relations Team will be tagged. +Someone will then review the pull request and merge it in! + +:::note + +You cannot directly make changes to the API specifications. These files are regularly pulled from a private repository and auto-generated. + +::: + +## Report general issues + +It's possible that none of the options listed here will properly address your issue. +If you have a general issue, you can submit a general issue by using GitHub's [issues](https://github.com/sailpoint-oss/developer.sailpoint.com/issues). +Add as much detail as you can to your issue, and we will address it as quickly as we can. + +## Discuss on the forum + +What makes the SailPoint Developer Community great is its brilliant, knowledgeable members! +If you have a question, problem, or idea, one of the best ways to get answers or resolutions is to go to the [Developer Community Forum](https://developer.sailpoint.com/discuss) to discuss them directly with the community on the forum. +The SailPoint Developer Relations Team, the community ambassadors, and other members will be there to discuss them with you. +And once you're there, you can help others on the forum too! +If you're interested, you will receive ambassador points for the issues you help others resolve on the forum.Check out the [ambassador program](https://developer.sailpoint.com/discuss/t/getting-started-as-a-developer-community-ambassador/11665) to learn more. + +## MIT Software License + +This project uses the [MIT License](http://choosealicense.com/licenses/mit/). +Whenever you submit code changes, your submissions are held under the same MIT license that covers the project. diff --git a/algolia/config.json b/algolia/config.json index bd0d916ba..07610a43e 100644 --- a/algolia/config.json +++ b/algolia/config.json @@ -2,74 +2,74 @@ "index_name": "prod_DEVELOPER_SAILPOINT_COM", "start_urls": [ { - "url": "https://developer.sailpoint.com/idn/docs/transforms", + "url": "https://developer.sailpoint.com/docs/extensibility/transforms", "tags": ["IDN Documentation", "Transforms"] }, { - "url": "https://developer.sailpoint.com/idn/docs/rules", + "url": "https://developer.sailpoint.com/docs/extensibility/rules", "tags": ["IDN Documentation", "Rules"] }, { - "url": "https://developer.sailpoint.com/idn/docs/event-triggers", + "url": "https://developer.sailpoint.com/docs/extensibility/event-triggers", "tags": ["IDN Documentation", "Event Triggers"] }, { - "url": "https://developer.sailpoint.com/idn/docs/saas-configuration", + "url": "https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration", "tags": ["IDN Documentation", "SaaS Configuration"] }, { - "url": "https://developer.sailpoint.com/idn/docs/saas-connectivity", + "url": "https://developer.sailpoint.com/docs/connectivity/saas-connectivity", "tags": ["IDN Documentation", "SaaS Connectivity"] }, { - "url": "https://developer.sailpoint.com/idn/docs/", + "url": "https://developer.sailpoint.com/docs/", "tags": ["IDN Documentation"] }, { - "url": "https://developer.sailpoint.com/idn/tools/cli", + "url": "https://developer.sailpoint.com/docs/tools/cli", "tags": ["IDN Tools", "CLI"], "selectors_key": "tools" }, { - "url": "https://developer.sailpoint.com/idn/tools/sdk", + "url": "https://developer.sailpoint.com/docs/tools/sdk", "tags": ["IDN Tools", "SDKs"], "selectors_key": "tools" }, { - "url": "https://developer.sailpoint.com/idn/api/getting-started", + "url": "https://developer.sailpoint.com/docs/api/getting-started", "selectors_key": "api_v3", "tags": ["IDN API Documenation"] }, { - "url": "https://developer.sailpoint.com/idn/api/authentication", + "url": "https://developer.sailpoint.com/docs/api/authentication", "selectors_key": "api_v3", "tags": ["IDN API Documenation"] }, { - "url": "https://developer.sailpoint.com/idn/api/standard-collection-parameters", + "url": "https://developer.sailpoint.com/docs/api/standard-collection-parameters", "selectors_key": "api_v3", "tags": ["IDN API Documenation"] }, { - "url": "https://developer.sailpoint.com/idn/api/rate-limit", + "url": "https://developer.sailpoint.com/docs/api/rate-limit", "selectors_key": "api_v3", "tags": ["IDN API Documenation"] }, { - "url": "https://developer.sailpoint.com/idn/api/v3", + "url": "https://developer.sailpoint.com/docs/api/v3", "selectors_key": "api_v3", "tags": ["IDN V3 APIs"] }, { - "url": "https://developer.sailpoint.com/idn/api/beta", + "url": "https://developer.sailpoint.com/docs/api/beta", "selectors_key": "api_v3", "tags": ["IDN Beta APIs"] }, { - "url": "https://developer.sailpoint.com/iiq/api", + "url": "https://developer.sailpoint.com/docs/api/iiq", "selectors_key": "api_iiq", "tags": ["IIQ APIs"] } diff --git a/algolia/dev_config.json b/algolia/dev_config.json index 12270a153..73dd6c85e 100644 --- a/algolia/dev_config.json +++ b/algolia/dev_config.json @@ -2,7 +2,7 @@ "index_name": "dev_DEVELOPER_SAILPOINT_COM", "start_urls": [ { - "url": "https://developer.sailpoint.com/idn/docs/transforms", + "url": "https://developer.sailpoint.com/docs/extensibility/transforms", "tags": ["IDN Documentation", "Transforms"] } ], diff --git a/backend/__tests__/unit/handlers/get-all-items.test.mjs b/backend/__tests__/unit/handlers/get-all-items.test.mjs deleted file mode 100644 index 063c71b71..000000000 --- a/backend/__tests__/unit/handlers/get-all-items.test.mjs +++ /dev/null @@ -1,43 +0,0 @@ -// Import getAllItemsHandler function from get-all-items.mjs -import { getAllItemsHandler } from '../../../src/handlers/get-all-items.mjs'; -// Import dynamodb from aws-sdk -import { DynamoDBDocumentClient, ScanCommand } from '@aws-sdk/lib-dynamodb'; -import { mockClient } from "aws-sdk-client-mock"; - -// This includes all tests for getAllItemsHandler() -describe('Test getAllItemsHandler', () => { - const ddbMock = mockClient(DynamoDBDocumentClient); - - beforeEach(() => { - ddbMock.reset(); - }); - - it('should return ids', async () => { - const items = [{ id: 'id1' }, { id: 'id2' }]; - - // Return the specified value whenever the spied scan function is called - ddbMock.on(ScanCommand).resolves({ - Items: items, - }); - - const event = { - httpMethod: 'GET' - }; - - // Invoke helloFromLambdaHandler() - const result = await getAllItemsHandler(event); - - const expectedResult = { - statusCode: 200, - headers: { - "Access-Control-Allow-Headers" : "Content-Type", - "Access-Control-Allow-Origin": "*", - "Access-Control-Allow-Methods": "OPTIONS,POST,GET" - }, - body: JSON.stringify(items) - }; - - // Compare the result with the expected result - expect(result).toEqual(expectedResult); - }); -}); diff --git a/backend/__tests__/unit/handlers/put-item.test.mjs b/backend/__tests__/unit/handlers/put-item.test.mjs deleted file mode 100644 index 03acd5288..000000000 --- a/backend/__tests__/unit/handlers/put-item.test.mjs +++ /dev/null @@ -1,45 +0,0 @@ -// Import putItemHandler function from put-item.mjs -import { putItemHandler } from '../../../src/handlers/put-item.mjs'; -// Import dynamodb from aws-sdk -import { DynamoDBDocumentClient, PutCommand } from '@aws-sdk/lib-dynamodb'; -import { mockClient } from "aws-sdk-client-mock"; -// This includes all tests for putItemHandler() -describe('Test putItemHandler', function () { - const ddbMock = mockClient(DynamoDBDocumentClient); - - beforeEach(() => { - ddbMock.reset(); - }); - - // This test invokes putItemHandler() and compare the result - it('should add id to the table', async () => { - const returnedItem = { id: 'id1', name: 'name1' }; - - // Return the specified value whenever the spied put function is called - ddbMock.on(PutCommand).resolves({ - returnedItem - }); - - const event = { - httpMethod: 'POST', - body: '{"id": "id1","name": "name1"}' - }; - - // Invoke putItemHandler() - const result = await putItemHandler(event); - - const expectedResult = { - statusCode: 200, - headers: { - "Access-Control-Allow-Headers" : "Content-Type", - "Access-Control-Allow-Origin": "*", - "Access-Control-Allow-Methods": "OPTIONS,POST,GET" - }, - body: JSON.stringify(returnedItem) - }; - - // Compare the result with the expected result - expect(result).toEqual(expectedResult); - }); -}); - \ No newline at end of file diff --git a/backend/src/auth/index.js b/backend/src/auth/index.js new file mode 100644 index 000000000..4fd93c40a --- /dev/null +++ b/backend/src/auth/index.js @@ -0,0 +1,46 @@ +exports.authHandler = async (event) => { + const token = event.headers.authorization; + + const expectedUsername = process.env.AUTH_USERNAME; + const expectedPassword = process.env.AUTH_PASSWORD; + + try { + const { username, password } = decodeAuthToken(token); + if (username === expectedUsername && password === expectedPassword) { + return generatePolicy('user', 'Allow', event.routeArn); + } else { + throw new Error('Unauthorized'); + } + } catch (err) { + console.log(err.message); + return generatePolicy('user', 'Deny', event.routeArn); + } +}; + +function decodeAuthToken(token) { + if (!token || !token.startsWith('Basic ')) { + throw new Error('Missing or invalid Authorization header'); + } + + const base64Credentials = token.split(' ')[1]; + const credentials = Buffer.from(base64Credentials, 'base64').toString('ascii'); + const [username, password] = credentials.split(':'); + return { username, password }; +} + +function generatePolicy(principalId, effect, resource) { + return { + principalId, + policyDocument: { + Version: '2012-10-17', + Statement: [ + { + Action: 'execute-api:Invoke', + Effect: effect, + Resource: resource + } + ] + } + }; +} + diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 83406e3aa..000000000 --- a/docs/README.md +++ /dev/null @@ -1 +0,0 @@ -# Developer Relations main diff --git a/docs/api/api-specifications.md b/docs/api/api-specifications.md new file mode 100644 index 000000000..9a4e3e7c9 --- /dev/null +++ b/docs/api/api-specifications.md @@ -0,0 +1,31 @@ +--- +id: api-specifications +title: API Specifications +pagination_label: API Specifications +sidebar_label: API Specifications +sidebar_position: 1 +sidebar_class_name: apiSpecifications +keywords: ['api', 'specifications'] +description: Identity Security Cloud API specifications. +slug: /api/api-specifications +tags: ['API Specifications'] +--- + +## Overview + +The Identity Security Cloud (ISC) APIs provide developers with a way to interact with the ISC platform and extend it. Developers can leverage these APIs to customize their platform experiences and build new solutions and integrations that meet their needs. + +The API specifications contain detailed information of how to send requests to each API endpoint, as well as example requests and responses. They also include essential information about how to use the APIs and guides you can follow to get started. + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + +## Discuss + +The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions. + +To learn more about the ISC APIs and discuss them with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/tags/c/isc/6/apis). diff --git a/products/idn/api/authentication.md b/docs/api/authentication.md similarity index 90% rename from products/idn/api/authentication.md rename to docs/api/authentication.md index 67f960bdd..2627d04a7 100644 --- a/products/idn/api/authentication.md +++ b/docs/api/authentication.md @@ -6,7 +6,7 @@ sidebar_label: Authentication sidebar_position: 2 sidebar_class_name: authentication keywords: ['authentication'] -description: A guide on how to generate API credentials to authenticate to SailPoint's APIs. +description: Authenticate to the ISC APIs. slug: /api/authentication tags: ['Authentication'] --- @@ -15,9 +15,9 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; ## Overview -With SailPoint's IdentityNow (IDN) APIs, you can extend your IDN platform far beyond its current capabilities. +With SailPoint's Identity Security Cloud (ISC) APIs, you can extend your ISC platform far beyond its current capabilities. -To be able to do so, you must first authenticate to the IDN APIs. +To be able to do so, you must first authenticate to the ISC APIs. Authentication is the act of validating a user's identity, generally by passing some kind of credentials. A fast, simple way to authenticate to the APIs is to generate a [personal access token](#generate-a-personal-access-token) and pass that token. @@ -36,35 +36,35 @@ This diagram shows the flow of this authentication/authorization process: sequenceDiagram autonumber participant H as HTTP Client - participant I as IdentityNow + participant I as Identity Security Cloud H->>I: Access Token Request I->>H: Access Token Response loop Until token expires H->>I: API Request + Access Token - I->>H: IdentityNow API Response + I->>H: Identity Security Cloud API Response end ``` The flow involves these four key steps: -1. **Access Token Request**: The HTTP client (a script, application, Postman, cURL, etc.) makes a request to IDN to get a JWT `access_token`. -2. **Access Token Response**: If the request is valid, IDN responds to the HTTP client with a JWT `access_token`. -3. **API Request**: The HTTP client makes a request to an IDN endpoint with the header, `Authorization: Bearer {access_token}`. -4. **API Response**: If both the request itself and the JWT `access_token` in its header are valid, IDN responds to the client. +1. **Access Token Request**: The HTTP client (a script, application, Postman, cURL, etc.) makes a request to ISC to get a JWT `access_token`. +2. **Access Token Response**: If the request is valid, ISC responds to the HTTP client with a JWT `access_token`. +3. **API Request**: The HTTP client makes a request to an ISC endpoint with the header, `Authorization: Bearer {access_token}`. +4. **API Response**: If both the request itself and the JWT `access_token` in its header are valid, ISC responds to the client. If you encounter unexpected errors, refer to the [Troubleshooting](#troubleshooting) section of this document. -The idea is that once you have authenticated to the IDN APIs and you have received an `access_token`, you can use that `access_token` to provide authorization for your API requests. +The idea is that once you have authenticated to the ISC APIs and you have received an `access_token`, you can use that `access_token` to provide authorization for your API requests. This document includes all the information you need to know to engage in this authentication/authorization process, as well as a guide on how to get started. ## Get started -Read this guide to learn how to authenticate to SailPoint's IDN APIs. +Read this guide to learn how to authenticate to SailPoint's ISC APIs. -To authenticate to the IDN APIs, you must be able to connect to your tenant to send the access token request. +To authenticate to the ISC APIs, you must be able to connect to your tenant to send the access token request. To do so, you need to do the following: 1. [Find your tenant's OAuth details](#find-your-tenant's-oauth-details) 2. [Generate personal access token](#generate-personal-access-token) @@ -76,13 +76,13 @@ To do so, you need to do the following: Your tenant's OAuth details refer to the details you need to know to connect it to the APIs. You need to know your tenant's name, its `authorizeEndpoint` URL, and its `tokenEndpoint` URL. -Your IDN instance is likely using the domain name supplied by SailPoint (`{tenant}.api.identitynow.com`), in which case, the tenant name is in the URL. +Your ISC instance is likely using the domain name supplied by SailPoint (`{tenant}.api.identitynow.com`), in which case, the tenant name is in the URL. This is assumed to be the case in this guide. -However, if your IDN instance is using a vanity URL, you must enter this URL into your browser to get your OAuth info: +However, if your ISC instance is using a vanity URL, you must enter this URL into your browser to get your OAuth info: `https://{tenant}.api.identitynow.com/oauth/info` If you have admin access but don't know your tenant name, you can learn it by following these steps: -1. Log into your IDN instance. +1. Log into your ISC instance. 2. Select the 'Dashboard' dropdown. 3. Select 'Overview'. 4. Find the tenant name ('Org Name') in the dashboard's `Org Details` section. @@ -93,7 +93,7 @@ This is an example of the OAuth details of the tenant, "iga-acme-sb": { "tenantId": "cc31a307-8a8d-49e8-93b9-c7cbe20e2e6b", "tenantName": "iga-acme-sb", - "authorizeEndpoint": "https://iga-sb.acme.com/oauth/authorize", + "authorizeEndpoint": "https://iga-sb.login.sailpoint.com/oauth/authorize", "tokenEndpoint": "https://iga-sb.api.identitynow.com/oauth/token", "cloudDomainUrl": "https://iga-sb.acme.com", "logoutUrl": "https://iga-sb.acme.com/logout", @@ -109,10 +109,10 @@ A personal access token (PAT) is a method of authenticating to an API as a user PATs are primarily used in scripts or programs that lack an easy way to implement an OAuth2 flow but need to call API endpoints that require user context. PATs are also convenient for use in tools like [Postman](https://www.postman.com/) when you are exploring and testing the APIs. -Any IDN user can generate a PAT. +Any ISC user can generate a PAT. To do so, follow these steps: 1. Select **Preferences** from the drop-down menu under your username, then **Personal Access Tokens** on the left. -You can also go directly to the page by using this URL (replace `{tenant}` with your IdentityNow tenant): `https://{tenant}.identitynow.com/ui/d/user-preferences/personal-access-tokens` +You can also go directly to the page by using this URL (replace `{tenant}` with your Identity Security Cloud tenant): `https://{tenant}.identitynow.com/ui/d/user-preferences/personal-access-tokens` 2. Click **New Token** and enter a meaningful description to help differentiate the token from others. @@ -133,7 +133,7 @@ After you create the token, the value of the `Client ID` will be visible in the 4. Copy both values somewhere that will be secure and accessible to you when you need to use the the token. -To generate a personal access token from the API, use the [create personal access token endpoint](/idn/api/beta/create-personal-access-token). +To generate a personal access token from the API, use the [create personal access token endpoint](/docs/api/beta/create-personal-access-token). Once you have created the PAT and you know its `Client ID` and `Client Secret`, you have everything you need to follow the [Client Credentials Grant Flow](#request-access-token-with-client-credentials-grant-flow) and use the PAT to generate an `access_token`. You will need this `access_token` to authenticate your requests to the APIs. @@ -145,11 +145,11 @@ You must choose the one that best serves your purposes. This document covers these three common flows: 1. [**Client Credentials**](https://oauth.net/2/grant-types/client-credentials/) - Clients use this grant type to obtain a JWT `access_token` without user involvement such as scripts, programs or system to system integration. -2. [**Authorization Code**](https://oauth.net/2/grant-types/authorization-code/) - Clients use this grant type to exchange an authorization code for an `access_token`. Authorization codes are mainly used by web applications because there is a login into IDN with a subsequent redirect back to the web application/client. +2. [**Authorization Code**](https://oauth.net/2/grant-types/authorization-code/) - Clients use this grant type to exchange an authorization code for an `access_token`. Authorization codes are mainly used by web applications because there is a login into ISC with a subsequent redirect back to the web application/client. 3. [**Refresh Token**](https://oauth.net/2/grant-types/refresh-token/) - Clients use this grant type to exchange a refresh token for a new `access_token` when the existing `access_token` has expired. This allows clients to continue using the APIs without having to re-authenticate as frequently. This grant type is commonly used together with `Authorization Code` to prevent a user from having to log in several times per day. One way to determine which authorization flow you need to use is to look at the specification for the endpoint you want to use. -The endpoint will have the supported OAuth flows listed under the 'Authorization' dropdown, like the [List Access Profiles endpoint](https://developer.sailpoint.com/idn/api/beta/list-access-profiles): +The endpoint will have the supported OAuth flows listed under the 'Authorization' dropdown, like the [List Access Profiles endpoint](https://developer.sailpoint.com/docs/api/beta/list-access-profiles): ![Authorization Dropdown](./img/authorization/authorization-dropdown.png) @@ -161,9 +161,9 @@ The guide will detail the three different authorization grant flows you can use Clients use the 'Client Credentials' grant type to obtain access tokens without user involvement. This is the simplest authentication flow. -API endpoints that require [user level permissions](https://documentation.sailpoint.com/saas/help/common/users/user_level_matrix.html) require the use of Personal access tokens (PATs). Correspondingly, the endpoints a personal access token (PAT) can call depends on the permissions of the user who generated it and the configuration of IDN. +API endpoints that require [user level permissions](https://documentation.sailpoint.com/saas/help/common/users/user_level_matrix.html) require the use of Personal access tokens (PATs). Correspondingly, the endpoints a personal access token (PAT) can call depends on the permissions of the user who generated it and the configuration of ISC. -Note: If an API Key is used then IDN API calls are made outside of the context of a user and some API calls will not work. +Note: If an API Key is used then ISC API calls are made outside of the context of a user and some API calls will not work. An OAuth 2.0 client using the client credentials grant flow must have `CLIENT_CREDENTIALS` as one of its grantTypes (PATs are implicitly granted the `CLIENT_CREDENTIALS` grant type): @@ -184,7 +184,7 @@ An OAuth 2.0 client using the client credentials grant flow must have `CLIENT_CR This is the overall authorization flow: -1. The client first submits an OAuth 2.0 token request to IDN in this form: +1. The client first submits an OAuth 2.0 token request to ISC in this form: ```text POST https://{tenant}.api.identitynow.com/oauth/token @@ -221,7 +221,7 @@ curl --location 'https://{tenant}.api.identitynow.com/oauth/token' \ --form 'client_secret="{clientSecret}"' ``` -2. IDN validates the token request and responds. +2. ISC validates the token request and responds. If the request is successful, the response contains a JWT access token. For more information about the JWT access token in the response, refer to [#OAuth-token-response](#oauth-token-response). @@ -234,7 +234,7 @@ To learn more about the OAuth client credentials grant flow, refer [here](https: Further Reading: [https://oauth.net/2/grant-types/authorization-code/](https://oauth.net/2/grant-types/authorization-code/) Clients use this grant type to exchange an authorization code for an `access_token`. -This is mainly used for web apps because there is a login into IDN with a subsequent redirect back to the web app/client. +This is mainly used for web apps because there is a login into ISC with a subsequent redirect back to the web app/client. The OAuth 2.0 client you are using must have `AUTHORIZATION_CODE` as one of its grant types. The redirect URLs must also match the list in the client as well: @@ -270,10 +270,10 @@ sequenceDiagram autonumber participant U as User participant W as Web App - participant I as IdentityNow + participant I as Identity Security Cloud U->>W: Click login link - W->>I: Authorization request to https://{tenant}.identitynow.com/oauth/authorize + W->>I: Authorization request to https://{tenant}.login.sailpoint.com/oauth/authorize I->>U: Redirect to login prompt U->>I: Authentication I->>W: Authorization code granted @@ -287,19 +287,19 @@ This is the overall authorization flow: 1. The user clicks the login link on a web app. -2. The web app sends an authorization request to IDN in this form: +2. The web app sends an authorization request to ISC in this form: ```Text -GET https://{tenant}.identitynow.com/oauth/authorize?client_id={client-id}&client_secret={client-secret}&response_type=code&redirect_uri={redirect-url} +GET https://{tenant}.login.sailpoint.com/oauth/authorize?client_id={client-id}&client_secret={client-secret}&response_type=code&redirect_uri={redirect-url} ``` -3. IDN redirects the user to a login prompt to authenticate to IdentityNow. +3. ISC redirects the user to a login prompt to authenticate to Identity Security Cloud. -4. The user authenticates to IDN. +4. The user authenticates to ISC. -5. Once authentication is successful, IDN issues an authorization code back to the web app. +5. Once authentication is successful, ISC issues an authorization code back to the web app. -6. The web app submits an OAuth 2.0 token request to IDN in this form: +6. The web app submits an OAuth 2.0 token request to ISC in this form: ```text POST https://{tenant}.api.identitynow.com/oauth/token?grant_type=authorization_code&client_id={client-id}&client_secret={client-secret}&code={code}&redirect_uri={redirect-url} @@ -311,7 +311,7 @@ The token endpoint URL is `{tenant}.api.identitynow.com`, and the authorize URL ::: -7. IDN validates the token request and submits a response. If the request is successful, the response contains a JWT `access_token`. +7. ISC validates the token request and submits a response. If the request is successful, the response contains a JWT `access_token`. For more information about the JWT access token in the response, refer to [#OAuth-token-response](#oauth-token-response). These are the query parameters in the OAuth 2.0 token request for the authorization code grant: @@ -363,13 +363,13 @@ This is the overall authorization flow: 1. The client application receives an `access_token` and a `refresh_token` from one of the other OAuth grant flows, like `AUTHORIZATION_CODE`. 2. The client application detects that the `access_token` is about to expire, based on the `expires_in` attribute contained within the JWT token. -3. The client submits an OAuth 2.0 token request to IDN in this form: +3. The client submits an OAuth 2.0 token request to ISC in this form: ```text POST https://{tenant}.api.identitynow.com/oauth/token?grant_type=refresh_token&client_id={client_id}&client_secret={client_secret}&refresh_token={refresh_token} ``` -4. IDN validates the token request and submits a response. If the request is successful, the response contains a new `access_token` and `refresh_token`. +4. ISC validates the token request and submits a response. If the request is successful, the response contains a new `access_token` and `refresh_token`. These are the query parameters in the OAuth 2.0 token request for the refresh token grant flow: @@ -417,7 +417,7 @@ A successful request using any of the grant flows to `https://{tenant}.api.ident } ``` -You can use the JWT `access_token` to authorize REST API calls through the IDN API gateway. +You can use the JWT `access_token` to authorize REST API calls through the ISC API gateway. To use the `access_token`, simply include it in the `Authorization` header as a `Bearer` token. This is an example V3 API request that has the access token in the header: @@ -440,7 +440,7 @@ However, the `refresh_token` will only be present if the API client has the `REF - The `user_id` and `identity_id` define the identity context of the person who authenticated. However, these values aren't set for the client credentials grant type because it doesn't have a user context. -With the JWT `access_token`, you can now successfully send authenticated IDN API requests. To learn more about authorization and the scopes you can apply to further control access to the APIs, refer to [Authorization](/idn/api/authorization). +With the JWT `access_token`, you can now successfully send authenticated ISC API requests. To learn more about authorization and the scopes you can apply to further control access to the APIs, refer to [Authorization](/docs/api/authorization). ## More Information @@ -522,25 +522,25 @@ This section describes some different use cases and which grant flow you would w For daily work or short, quick administrative actions, you can just use a PAT. This makes the process easier because you don't really need to worry about grant types - you can easily generate a PAT in the user interface (UI). Follow these steps to do so: -1. Log in to IDN. +1. Log in to ISC. 2. Go to 'Preferences', then 'Personal Access Tokens', and [generate a PAT](#generate-a-personal-access-token). 3. The PAT's `client_id` and `client_secret` provide the necessary authentication to send API requests, without any grant flow. #### Postman -[Postman](https://www.postman.com/) is a popular HTTP client you can use to design, build, test, and iterate your APIs. Postman users and teams can create public workspaces they can use to make it easy to access their API collections and environments and get started. SailPoint maintains a [public workspace for the IdentityNow API collections](https://www.postman.com/sailpoint/workspace/identitynow). You can use this workspace to access all the IDN API collections and stay up to date. +[Postman](https://www.postman.com/) is a popular HTTP client you can use to design, build, test, and iterate your APIs. Postman users and teams can create public workspaces they can use to make it easy to access their API collections and environments and get started. SailPoint maintains a [public workspace for the Identity Security Cloud API collections](https://www.postman.com/sailpoint/workspace/identitynow). You can use this workspace to access all the ISC API collections and stay up to date. If you're using Postman, you have some different ways to set up your authorization. You can just leverage the accessToken as mentioned above, or you can configure Postman to use OAuth 2.0 directly. For more information about how to do so, refer [here](https://learning.postman.com/docs/sending-requests/authorization/). #### Web applications -If you are making a web application, the best grant flow to use is the [Authorization Code grant flow](#request-access-token-with-authorization-grant-flow). This will allow users to be directed to IDN to login and then redirected back to the web application through a URL redirect. This also works well with Single Sign-on (SSO), strong authentication, and pass-through authentication mechanisms. +If you are making a web application, the best grant flow to use is the [Authorization Code grant flow](#request-access-token-with-authorization-grant-flow). This will allow users to be directed to ISC to login and then redirected back to the web application through a URL redirect. This also works well with Single Sign-on (SSO), strong authentication, and pass-through authentication mechanisms. -SailPoint doesn't recommend using a password grant flow for web applications because doing so would involve entering IDN credentials in the web application. +SailPoint doesn't recommend using a password grant flow for web applications because doing so would involve entering ISC credentials in the web application. This flow also doesn't allow you to work with SSO, strong authentication, or pass-through authentication. #### Scripts, programs or system to system integration -If you are writing scripts, programs or system integrations that leverage the IDN APIs, the OAuth 2.0 grant you should use typically depends on what you're doing and the user context you need to operate under. +If you are writing scripts, programs or system integrations that leverage the ISC APIs, the OAuth 2.0 grant you should use typically depends on what you're doing and the user context you need to operate under. Because scripts, code, and programs lack an interactive web-interface, it is difficult, but not impossible, to implement a working authorization code grant flow. System to system integrations may require an elevated level of access and utilize a service account to make API calls beyond the privileges of the authenticated user. @@ -614,7 +614,7 @@ You can also view all of the active clients in the UI by going to `https://{tena ``` 4. If you're using an [Authorization Code](#authorization-code-grant-flow) grant flow, verify that the redirect URL(s) for your application match the `redirectUris` value in the client. -You can check this by calling the [List OAuth Clients endpoint](/idn/api/beta/list-oauth-clients). +You can check this by calling the [List OAuth Clients endpoint](/docs/api/beta/list-oauth-clients). ### Verify OAuth calls Verify that the OAuth call flow is going to the right URLs, with the correct query parameters and data values. diff --git a/products/idn/api/authorization.md b/docs/api/authorization.md similarity index 93% rename from products/idn/api/authorization.md rename to docs/api/authorization.md index 4dc1e43d1..cac5b3eb2 100644 --- a/products/idn/api/authorization.md +++ b/docs/api/authorization.md @@ -6,7 +6,7 @@ sidebar_label: Authorization sidebar_position: 3 sidebar_class_name: authorization keywords: ['authorization','scope','permission'] -description: A guide on how to restrict an API token's level of access. +description: Authorize your ISC API requests. slug: /api/authorization tags: ['Authorization','Scopes','Permissions'] --- @@ -23,7 +23,7 @@ Authorization and authentication are two related concepts that help secure APIs. sequenceDiagram autonumber participant H as HTTP Client - participant I as IdentityNow + participant I as Identity Security Cloud H->>I: Request to delete a source I->>I: Authenticate access token @@ -61,7 +61,7 @@ Scopes contain one or more rights, which are low level permissions that grant ac By default, each PAT has the scope, `sp:scopes:all`, which grants access to all the rights appropriate for the [user level](https://documentation.sailpoint.com/saas/help/common/users/user_level_matrix.html). For example, a user with the **Admin** user level has access to all APIs, so `sp:scopes:all` grants **Admin** users access to all APIs. A user with the **Cert Admin** user level, however, has access to only a subset of APIs necessary to perform their role, most notably the certification APIs, so `sp:scopes:all` grants **Cert Admin** users access to only that subset of APIs. -Alternatively, `sp:scopes:default` is the least privileged scope that only grants access to endpoints that require no authorization at all, such as [list public identities](https://developer.sailpoint.com/idn/api/v3/get-public-identities). +Alternatively, `sp:scopes:default` is the least privileged scope that only grants access to endpoints that require no authorization at all, such as [list public identities](https://developer.sailpoint.com/docs/api/v3/get-public-identities). Scopes are additive, which means the final right set is the intersection of all the rights granted by the scopes assigned to a PAT, excluding any rights that fall outside of the user level. Each scope added to an PAT builds up the credential's permission set, incrementally increasing access to the API. If a PAT has `sp:scopes:all` granted, then any additional scope is ignored because `sp:scopes:all` already contains the complete set of rights available to the user level. @@ -76,7 +76,7 @@ If the API requirements for the personal access token exceed the scopes allowed ## Identifying Necessary Authorization for an Endpoint -Each endpoint document specifies how to authorize with the endpoint in the **Authorization** dropdown, which is located on the right side column below the endpoint path. Selecting **Authorization** expands the dropdown menu showing the details of how to authorize with the endpoint. The following image shows the authorization details of the [List Access Profiles](https://developer.sailpoint.com/idn/api/beta/list-access-profiles) endpoint. +Each endpoint document specifies how to authorize with the endpoint in the **Authorization** dropdown, which is located on the right side column below the endpoint path. Selecting **Authorization** expands the dropdown menu showing the details of how to authorize with the endpoint. The following image shows the authorization details of the [List Access Profiles](https://developer.sailpoint.com/docs/api/beta/list-access-profiles) endpoint. ![Authorization Dropdown](./img/authorization/authorization-dropdown.png) @@ -98,7 +98,7 @@ When you create a PAT in the UI, you can apply scopes to the token. More informa ## Assigning Scopes with the API -You can [create PATs](https://developer.sailpoint.com/idn/api/v3/create-personal-access-token) programmatically with the API. The request body for the endpoint allows the caller to specify a list of scopes to be applied to the PAT. If the `scope` property is omitted from the request body, then `sp:scopes:all` is granted to the credentials. The following example shows how to generate a PAT with the `idn:access-request:manage` and `idn:nelm:manage` scopes. +You can [create PATs](https://developer.sailpoint.com/docs/api/v3/create-personal-access-token) programmatically with the API. The request body for the endpoint allows the caller to specify a list of scopes to be applied to the PAT. If the `scope` property is omitted from the request body, then `sp:scopes:all` is granted to the credentials. The following example shows how to generate a PAT with the `idn:access-request:manage` and `idn:nelm:manage` scopes. POST diff --git a/docs/api/beta/add-access-request-recommendations-ignored-item.api.mdx b/docs/api/beta/add-access-request-recommendations-ignored-item.api.mdx index c134bc677..46d1d5e74 100644 --- a/docs/api/beta/add-access-request-recommendations-ignored-item.api.mdx +++ b/docs/api/beta/add-access-request-recommendations-ignored-item.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

Notification of Ignored Access Request Recommendations

@@ -36,7 +34,7 @@ This API ignores a recommended access request item. Once an item is ignored, it The recommended access item to ignore for an identity. -
+
    access objectrequired
Recommendation successfully stored as ignored. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/add-access-request-recommendations-requested-item.api.mdx b/docs/api/beta/add-access-request-recommendations-requested-item.api.mdx index 1cf79c23a..1e77a0581 100644 --- a/docs/api/beta/add-access-request-recommendations-requested-item.api.mdx +++ b/docs/api/beta/add-access-request-recommendations-requested-item.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Notification of Requested Access Request Recommendations

    @@ -36,7 +34,7 @@ This API consumes a notification that a recommended access request item was requ The recommended access item that was requested for an identity. -
    +
      access objectrequired
    Notification successfully acknowledged. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/add-access-request-recommendations-viewed-item.api.mdx b/docs/api/beta/add-access-request-recommendations-viewed-item.api.mdx index f7f12cb2a..b38251515 100644 --- a/docs/api/beta/add-access-request-recommendations-viewed-item.api.mdx +++ b/docs/api/beta/add-access-request-recommendations-viewed-item.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Notification of Viewed Access Request Recommendations

    @@ -36,7 +34,7 @@ This API consumes a notification that a recommended access request item was view The recommended access that was viewed for an identity. -
    +
      access objectrequired
    Recommendation successfully stored as viewed. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/add-access-request-recommendations-viewed-items.api.mdx b/docs/api/beta/add-access-request-recommendations-viewed-items.api.mdx index 8d93c1ab2..3da8ca0b1 100644 --- a/docs/api/beta/add-access-request-recommendations-viewed-items.api.mdx +++ b/docs/api/beta/add-access-request-recommendations-viewed-items.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Notification of Viewed Access Request Recommendations in Bulk

    @@ -36,7 +34,7 @@ This API consumes a notification that a set of recommended access request item w The recommended access items that were viewed for an identity. -
    +
    • Array [
      • access objectrequired
    • ]
    Recommendations successfully stored as viewed. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/approve-access-request.api.mdx b/docs/api/beta/approve-access-request.api.mdx index 3f3bdc465..4bb82093a 100644 --- a/docs/api/beta/approve-access-request.api.mdx +++ b/docs/api/beta/approve-access-request.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Approves an access request approval.

    @@ -36,7 +34,7 @@ This endpoint approves an access request approval. Only the owner of the approva Reviewer's comment. -
    +
      author object
    Accepted - Returned if the request was successfully accepted into the system. @@ -60,7 +58,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -88,4 +86,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/approve-approval-item.api.mdx b/docs/api/beta/approve-approval-item.api.mdx index 48c2ebd08..3723af17e 100644 --- a/docs/api/beta/approve-approval-item.api.mdx +++ b/docs/api/beta/approve-approval-item.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Approve an Approval Item

    @@ -32,7 +30,7 @@ This API approves an Approval Item. Either an admin, or the owning/current user ## Request -

    Path Parameters

    +

    Path Parameters

    A work items details object. @@ -60,7 +58,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -72,4 +70,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 404 response object

     \ No newline at end of file diff --git a/docs/api/beta/approve-approval-items-in-bulk.api.mdx b/docs/api/beta/approve-approval-items-in-bulk.api.mdx index 990a40fd6..fae1bb472 100644 --- a/docs/api/beta/approve-approval-items-in-bulk.api.mdx +++ b/docs/api/beta/approve-approval-items-in-bulk.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Bulk approve Approval Items

    @@ -32,7 +30,7 @@ This API bulk approves Approval Items. Either an admin, or the owning/current us ## Request -

    Path Parameters

    +

    Path Parameters

    A work items details object. @@ -60,7 +58,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -72,4 +70,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 404 response object

     \ No newline at end of file diff --git a/docs/api/beta/approve-non-employee-request.api.mdx b/docs/api/beta/approve-non-employee-request.api.mdx index 22dec4d17..a41b736a3 100644 --- a/docs/api/beta/approve-non-employee-request.api.mdx +++ b/docs/api/beta/approve-non-employee-request.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Approve a Non-Employee Request

    @@ -32,7 +30,7 @@ Approves a non-employee approval request and notifies the next approver. ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    Non-Employee approval item object. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/bulk-delete-roles.api.mdx b/docs/api/beta/bulk-delete-roles.api.mdx index be876eac9..2fcf7ddfe 100644 --- a/docs/api/beta/bulk-delete-roles.api.mdx +++ b/docs/api/beta/bulk-delete-roles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Role(s)

    @@ -34,7 +32,7 @@ A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required ## Request -

    Body

    required
    +

    Body

    required
    Returns an object with the id of the task performing the delete operation. @@ -66,7 +64,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -82,4 +80,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/cancel-access-request.api.mdx b/docs/api/beta/cancel-access-request.api.mdx index 80aa0fcb0..1b8b43e21 100644 --- a/docs/api/beta/cancel-access-request.api.mdx +++ b/docs/api/beta/cancel-access-request.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Cancel Access Request

    @@ -33,7 +31,7 @@ Any token with ORG_ADMIN authority or token of the user who originally requested ## Request -

    Body

    required
    +

    Body

    required
    Accepted - Returned if the request was successfully accepted into the system. @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -81,7 +79,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -97,4 +95,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/cancel-workflow-execution.api.mdx b/docs/api/beta/cancel-workflow-execution.api.mdx index bc6e07730..b1bee3e5c 100644 --- a/docs/api/beta/cancel-workflow-execution.api.mdx +++ b/docs/api/beta/cancel-workflow-execution.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Cancel Workflow Execution by ID

    @@ -32,7 +30,7 @@ Use this API to cancel a running workflow execution. ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/close-access-request.api.mdx b/docs/api/beta/close-access-request.api.mdx index 975de62e2..ecf6cc557 100644 --- a/docs/api/beta/close-access-request.api.mdx +++ b/docs/api/beta/close-access-request.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Close Access Request

    @@ -43,7 +41,7 @@ This API triggers the [Provisioning Completed event trigger](https://developer.s ## Request -

    Body

    required
    +

    Body

    required
    Accepted - Returned if the request was successfully accepted into the system. @@ -79,7 +77,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -95,4 +93,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/compare-identity-snapshots-access-type.api.mdx b/docs/api/beta/compare-identity-snapshots-access-type.api.mdx index ad7963cc8..2581cf43e 100644 --- a/docs/api/beta/compare-identity-snapshots-access-type.api.mdx +++ b/docs/api/beta/compare-identity-snapshots-access-type.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Gets a list of differences of specific accessType for the given identity between 2 snapshots

    @@ -32,7 +30,7 @@ This method gets a list of differences of specific accessType for the given iden ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    A list of events for the identity @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -88,4 +86,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/compare-identity-snapshots.api.mdx b/docs/api/beta/compare-identity-snapshots.api.mdx index 604304633..5d755fdfb 100644 --- a/docs/api/beta/compare-identity-snapshots.api.mdx +++ b/docs/api/beta/compare-identity-snapshots.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Gets a difference of count for each access item types for the given identity between 2 snapshots

    @@ -32,7 +30,7 @@ This method gets a difference of count for each access item types for the given ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    A IdentityCompare object with difference details for each access item type @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/complete-campaign.api.mdx b/docs/api/beta/complete-campaign.api.mdx index 58a45ad9d..a801046c6 100644 --- a/docs/api/beta/complete-campaign.api.mdx +++ b/docs/api/beta/complete-campaign.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Complete a Campaign

    @@ -52,7 +50,7 @@ Requires roles of CERT_ADMIN and ORG_ADMIN Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE -
    +
    Accepted - Returned if the request was successfully accepted into the system. @@ -88,7 +86,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -100,7 +98,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -116,4 +114,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/complete-trigger-invocation.api.mdx b/docs/api/beta/complete-trigger-invocation.api.mdx index 416dc5b81..57e2c5bc9 100644 --- a/docs/api/beta/complete-trigger-invocation.api.mdx +++ b/docs/api/beta/complete-trigger-invocation.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Complete Trigger Invocation

    @@ -32,7 +30,7 @@ Completes an invocation to a REQUEST_RESPONSE type trigger. ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    No content - indicates the request was successful but there is no content to be returned in the response. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/complete-work-item.api.mdx b/docs/api/beta/complete-work-item.api.mdx index 574552035..cb9c60fdf 100644 --- a/docs/api/beta/complete-work-item.api.mdx +++ b/docs/api/beta/complete-work-item.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Complete a Work Item

    @@ -32,7 +30,7 @@ This API completes a work item. Either an admin, or the owning/current user must ## Request -

    Path Parameters

    +

    Path Parameters

    A WorkItems object @@ -60,7 +58,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -72,4 +70,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 404 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-access-profile.api.mdx b/docs/api/beta/create-access-profile.api.mdx index 8cdb87794..d74891966 100644 --- a/docs/api/beta/create-access-profile.api.mdx +++ b/docs/api/beta/create-access-profile.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create an Access Profile

    @@ -70,7 +68,7 @@ Array of child criteria. Required if the operation is AND or OR, otherwise it mu Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. -
  • Array [
  • ]
  • ]
    • +
  • Array [
  • ]
  • ]
    • Access Profile created @@ -138,7 +136,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -154,4 +152,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-access-request.api.mdx b/docs/api/beta/create-access-request.api.mdx index a1638ee47..a659369cc 100644 --- a/docs/api/beta/create-access-request.api.mdx +++ b/docs/api/beta/create-access-request.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Submit an Access Request

    @@ -76,7 +74,7 @@ Arbitrary key-value pairs. They will never be processed by the IdentityNow syste Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. -
    +
    Accepted - Returned if the request was successfully accepted into the system. @@ -112,7 +110,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -128,4 +126,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-account.api.mdx b/docs/api/beta/create-account.api.mdx index c4fdaa5bb..a416502d2 100644 --- a/docs/api/beta/create-account.api.mdx +++ b/docs/api/beta/create-account.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create Account

    @@ -39,7 +37,7 @@ A token with ORG_ADMIN authority is required to call this API. The schema attribute values for the account -
    +
    Async task details @@ -71,7 +69,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -87,4 +85,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-campaign-template.api.mdx b/docs/api/beta/create-campaign-template.api.mdx index f6f1295f0..3d8060a07 100644 --- a/docs/api/beta/create-campaign-template.api.mdx +++ b/docs/api/beta/create-campaign-template.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a Campaign Template

    @@ -84,7 +82,7 @@ This determines who remediation tasks will be assigned to. Remediation tasks are A list of sources in the campaign that contain \"orphan entitlements\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Created successfully. @@ -164,7 +162,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -180,4 +178,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-campaign.api.mdx b/docs/api/beta/create-campaign.api.mdx index e11aa5148..f121e6fea 100644 --- a/docs/api/beta/create-campaign.api.mdx +++ b/docs/api/beta/create-campaign.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a campaign

    @@ -80,7 +78,7 @@ This determines who remediation tasks will be assigned to. Remediation tasks are A list of sources in the campaign that contain \"orphan entitlements\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Indicates that the campaign requested was successfully created and returns its representation. @@ -156,7 +154,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -172,4 +170,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-common-access.api.mdx b/docs/api/beta/create-common-access.api.mdx index 41eddb29a..01a22fbdc 100644 --- a/docs/api/beta/create-common-access.api.mdx +++ b/docs/api/beta/create-common-access.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create common access items

    @@ -32,7 +30,7 @@ This API is used to add roles/access profiles to the list of common access for a ## Request -

    Body

    required
      access object
    +

    Body

    required
      access object
    Returns details of the common access classification request. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-connector-rule.api.mdx b/docs/api/beta/create-connector-rule.api.mdx index 2f4db8e8c..616a84992 100644 --- a/docs/api/beta/create-connector-rule.api.mdx +++ b/docs/api/beta/create-connector-rule.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create Connector Rule

    @@ -45,7 +43,7 @@ The rule's function signature. Describes the rule's input arguments and output ( SourceCode -
    +
    The created connector rule @@ -85,7 +83,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -101,4 +99,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-custom-password-instructions.api.mdx b/docs/api/beta/create-custom-password-instructions.api.mdx index c1c367420..e65fc8426 100644 --- a/docs/api/beta/create-custom-password-instructions.api.mdx +++ b/docs/api/beta/create-custom-password-instructions.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create Custom Password Instructions

    @@ -32,7 +30,7 @@ This API creates the custom password instructions for the specified page ID. A t ## Request -

    Body

    required
      ... clicking on this will open the link on the current browser page. If you want your link to be redirected to a different page, please redirect it to \"_blank\" like this: link. This will open a new tab when the link is clicked. Notice we're only supporting _blank as the redirection target."}}>
    +

    Body

    required
      ... clicking on this will open the link on the current browser page. If you want your link to be redirected to a different page, please redirect it to \"_blank\" like this: link. This will open a new tab when the link is clicked. Notice we're only supporting _blank as the redirection target."}}>
    Reference to the custom password instructions. @@ -60,7 +58,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -72,4 +70,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-domain-dkim.api.mdx b/docs/api/beta/create-domain-dkim.api.mdx index 0bc53091c..68443480a 100644 --- a/docs/api/beta/create-domain-dkim.api.mdx +++ b/docs/api/beta/create-domain-dkim.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Verify domain address via DKIM

    @@ -32,7 +30,7 @@ Create a domain to be verified via DKIM (DomainKeys Identified Mail) ## Request -

    Body

    required
    +

    Body

    required
    List of DKIM tokens required for the verification process. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Method Not Allowed - indicates that the server knows the request method, but the target resource doesn't support this method. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-form-definition-dynamic-schema.api.mdx b/docs/api/beta/create-form-definition-dynamic-schema.api.mdx index 15ac20e5a..2b7b1100f 100644 --- a/docs/api/beta/create-form-definition-dynamic-schema.api.mdx +++ b/docs/api/beta/create-form-definition-dynamic-schema.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Generate JSON Schema dynamically.

    @@ -36,7 +34,7 @@ Generate JSON Schema dynamically. Body is the request payload to create a form definition dynamic schema -
    +
      attributes object
    Returns a form elements dynamic schema diff --git a/docs/api/beta/create-form-definition-file-request.api.mdx b/docs/api/beta/create-form-definition-file-request.api.mdx index b9e0e6184..5d9ff665c 100644 --- a/docs/api/beta/create-form-definition-file-request.api.mdx +++ b/docs/api/beta/create-form-definition-file-request.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Upload new form definition file.

    @@ -32,7 +30,7 @@ Parameter `{formDefinitionID}` should match a form definition ID. ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    Returns a new form definition file diff --git a/docs/api/beta/create-form-definition.api.mdx b/docs/api/beta/create-form-definition.api.mdx index 726581bac..5ff700b62 100644 --- a/docs/api/beta/create-form-definition.api.mdx +++ b/docs/api/beta/create-form-definition.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Creates a form definition.

    @@ -68,7 +66,7 @@ FormInput is a list of form inputs that are required when creating a form-instan UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Returns a new form definition diff --git a/docs/api/beta/create-form-instance.api.mdx b/docs/api/beta/create-form-instance.api.mdx index 97512cad8..d35b65a56 100644 --- a/docs/api/beta/create-form-instance.api.mdx +++ b/docs/api/beta/create-form-instance.api.mdx @@ -3,7 +3,7 @@ id: create-form-instance sidebar_label: Creates a form instance. hide_title: true hide_table_of_contents: true -api: eJztPWtz2za2fwWj+2GbGVN+JHFSf9gdRWZS3cqSK8n13rUzKURCEhuK1PIRR5vxf7/nAfAtS0mdTbqrdNpSJHBwcHDeOEA+tRI5j1tnN61uGifhUrwOo2XcenvQClcqkokXBj23ddZyIiUThR97QZzIwFGtg1ak/pmqOHkVuuvW2aeWq2In8lbYB3rgW+HFIlkooRuKlVz7oXRFEgoGKKSYAUzh5UCdMEhUkCBAuVr5nkNIHP4eI9RPrdhZqKXEp1WEKCaeivEXw3NfreufPLeOXe8ccZMiDTxATXguDOnNPBUBBuqjXK58Ba2O9B+r4T/mD3RI1itsHSeRF8zh90drHlqBXCoaqHVvWlSRmMBbRqNEBE0bV0zXAjsKFaRL8UH6qboNroejn1/3h9fv7L/b3atJbzgQxVXpGjIg7Oswej/zwzv7o3JSHPM2GA+vRl17c5dxmEa0DDgmskV9PPjIUJBLclo1NmykDIK2kBKNvb7OdIpLgh9a99mqtMLp78pJTKOVdN7LOb6fe8kinbadcHkYS89fhV6QHMYrCxcrPnTDpfQCnKOXEAEakcDFVx9XXtSw/Da9RwZA+YBHt8R8J0cnT62jl9bxyeTk6Oz42dnzF+0Xz569PP3HFpZjuDgyYnquZl7gGUGu4vC63OLcSKzninBGT8SabtYE3skk49BkAe2xxWOLTRUvM5tesEpZN7gufZL+ZVHYoVl9gtSJBC0QvNg4OS1z+MmXU+XHqJZIyoqTAfWBTY4B1Fj6MMYmvikgzkjeo4J0vJUHqiWuU36UfatwgJeoZfyn1GJFCcimR5+18uqd24NJb/J/zS17hH6yLmgf06GsarK3OyiYnYf8N2uIDIUCQ8koklVUcjbBhtjX7fhhQKaY12ImUx9EYib9WFW5f1xqz6s0DUNfgSTMfDlHlvcCF40srOEsl2cRL8LUBxMEJvoDTE1OfVIFIo1VRJICk4bVgG4fPEmKgnCTOBZDuOoJaK/hEOAw8NdliAAHfhtQZPEkialaTpXrwpuqctHT1BTTc6nQrDxrTbekgXXHCc07F78DJEIQgqcSqRiILkgBSV/EpmVxDal7J469eaDc26AzHvfeDOzzh9r0Bu8uR8M3I3s8rjfrBaDL5jByDJbt6tVFbzJpgjZOp0svSRBcd3hx2bcbW3UNUaFVZ9C1+/3GVvjk+2x6tNCZecCrArpo9g1O8JyNjM8GfllMC3C2iumfnXYV9kvI/CaJ36AuJ31i8FXoLETiLcEvBoIBo4lYge/rxsCDiViG4C6DaOSvUZjcNQwRulNx5/m+ALKE6D8kMGPbPhOLJFnFZ4egd5y4Le/g36X8VxiQeuJH0//QBwzj5NBVH5SPRmaegu04RGysJLR87wP8P/GtqQLxU9Y6TC3AMkrai2TpF6Xx+PmL45cnL56fHrF5lqCIwGAmp8/yRYefak4mqaRiJ33SsJnhA8bTjlLJbh4UPPsGh+btY+vobi3QGXHwwp5c5hUYp067aafWydHk+Dn4aGfPn7efPj15+fLkH00I72yOi77DzSczy4LpQ4egJQPL0zYMHlr3bw/KkZDu1uicMwDrTrvVljJ+NUG6L68O6V16E6/CIGaf5OTouMmxSdIoQEsTqLtHDu/qo2lP2/itLqrpzG3NIqo7tCpakTQ42S+aneyMoxGqhdKxxU3SyCCr7OPRfTz6p41HUYCW8qO3hHUGg5EGFDChAHD4pxnEATvGNmqlbW9bdGaJitjdo/bkXEmQavQBVZDLJpkw6L0MPyjKCEnBthZMLXtbMk1gTgmoCN9ft8UEeqL3yT2DUICDB3aFHErtS2Y+KfmjaOpB5sECimscusrWgBqTgjxOmUJACTDnGWZzFWAKjJ1Qnjgo5TD6KmF6F6wz2YiGUPF16btZIMe8AfcU0PYcRhHsuzdbF0J3tPlMw9o3adJz2tQgaDTXkXQSQFiEEBubxsXItKrwjbds+CLHrA3dytovSn01pNxiGDWoc9N1BM36OCvpm9Z5JNkGZ3twLrY17gTgwA1HW9sNo6L3O0CHdTiq+LKD3dzYx8aqFAoWKYemOPVVw3L0vZjElT63NycUYtJFk0ZLQC6LYu4glQ/wdOZkqpAzYuXDD+W2RS/JBEaBggKBlMBQMxUplDGS60Km5QewIfyEk3qCTq3+DgCXyEPYIlHOIkB6iPdq/aSNrv/l1aRMsXGGPqVbbgPQHBfgHG1qZTP8YnIBgcJv3bG84OblLimGx0SuFEjkK4QxLNuOehBL74XF8TvovawXivNDaB0U2vMya9WC45fyf7xkuJiOo1ZJW/wU3kHsEB181qB6lge3QWHcypCyvPj0KsiYAzCIFCwEjA1xT6y1QUkfu2oFkYqm5kP6V9vie7PVsVUdYVQoIw881UaNZP8idmhu/zMFT1qANYOJO1kTYXDQ77TsaRrJACykjOYqIVOkEAZ4/DDowN5l0EGYPMa4oBLykbvDXUaGJgm4JQ8NHCsZgX9QGhjWOVbgti8UaRQwzI4BhK0MyQfDybvd8AAKGFRQm+zSpRc4fgrs8Jmog0AAuorJLYO1kSPCOdZI74YBIG2QAPa62Im9lqtkzWPs1gFZg/uMr3dpP8Y8QHwNml6I7kI57+NslaRgOROUK4D32EgGIX0Eb0x/1fSIUeD5VZspnJEVqS1jZYFPEQM6H8xS74YhzChHEui2Uyc7cLdMSmEO5tGntBt2uEgawYL9sn+BHwObknH4RMJASTv9ix7sC/2LHsbX+hc92OYXPJSt3y+7GL69xttrvL3G22u8r67xim5bMQIiDmuOYEpj/GrakZcLiIwno97gjWhuNOYp8nxoCE6KYVYComw9XQPkXb83njwIiQKyKrRA0G4fElKTNBOXhngig8hb2TXUNgZc7Q2hRwZQ++S7gXwwRnuADkiB2+DVcNi3O4MNbV5lW3nGvjF90WjlhCbzVg7bDlr6g4ZftmQZkK3W7BvwxJ4pdmaKogrIPmc6oKH8DHSPK0JOOGYdyqGiHczBwKuG2JA6fIWcbGmW23b+U11uomYzGPuBTI9uUMr1VFK71ALTtG7q6H32PE1XT9IxxGbNOtH5IG6DjAAdOaVrErwZZOCZSAmFa1RIpAIrccJy6ofOe+CSn3rnBa/Ozgb/yXOVEOdejAleYkTPpf0ilIjxT8Prpk7jRXgnhB009TnvjTuv+o1j6VE2DmcPNvXkoTYNObJ/ueqNGjuOeHftNhhe4k5Dp9/UaLjiTKrZ1n53YY/HnTeNAHl3+0LFMXBn1gGsbu91r9uh3YyNvcDiejO9HYcbypN35/brzlV/8u7XTv+qeTiVnHP5CclLVV3w/jQJ4SqNVmHM4qe1O6456nZYRfifXhhU6wP9oAmHyVhNnqwEwdAgf1GcI76tol82CnrsrSZhz5f/PXxZ2prJ1d89bVnPvHldEXaiqZdEMlqLpVyZcA2NNqlW6JJyAbWYFm1RDrvdqpuXshp2C7PoY41iYUs/49pGTY+N/hJzYWPZ6HUcB9YB1fZI4d4bWRidft4OnRsC5HyHugT+5fHx0enpyY+nT58en748fYEmtLRDzrT8ipaVCbDFttrapH6dXdcMly1YlPf1soJdmcjPrXDFPoUSCImW/oPn6j17k8UHDqRN0YQ3U13dycOtUcy1W3/VQgL8XK6BLSTVy27TDtWwNJ//yGJkLQ0bdmzN18J+bUEnFCZ0wJjfZQWX4GavYEpZG0/5EInPonCZ9bG0UvqscuHXRXd9gwA/Xo2JHqjZiSwQqLCJIm6Dif33iah8naiPEClMhm/e9O3at3A+9xX364zsTlPfDjAIOZnn9qD6HUw5EOI2uPxpOKgBv1yEgcJEVKfXr36zQfDR+EEk1a1hPKbtUbDrnUkNKMgD2kDoZapLSh0dNnTdYf/qYjCufu+GfroM4oIfhROHn0wdfNCEgEeeMTzQ5CgXDBMh9wiRRrcL8KPfXe046WHL7pIe4sFihsJil0zmrlqMDYPeZG6XtY/Ppq91nmuhLXqna6Sj5tLt+WsX/iLLBSahIforRvhfuPP6s1rryN34ow272or0XwG9X7PmgnReafCbTwVwrHJMAHFOVZGPb+VraMWA81fyKEx9wHZ/IrNJxkZFURhtslD0rZp5IhubE1MobpWZH1/GiakFa6qzBJeYMr7A2lTXha3yimwq7WqL3qyh90K6DQNT2ZiX5PYxqxhDCL2ByIrCuWzsbqEixs3xqagJy9SyqgF4HysNerP1bGR9YFtjy0t5rj8kBEsOihpWSIdLvD7C17meOzVt07rpzywLxZkYvim3igtnNCJXdC57TARhCnqFxoRT5FtDEz+E2TcY9j69z3yeNIpwCfhtiVAqsK7GW2ikuwGZeLhh5IHruWlQ/ioWIXpLENbFHoa/nEFF0mH8TQzMKCKvmjKmEmY6vtwJN40RyiUYgiZ1+TExxJBOkgLHYEPj2vESaMqXkKCQlSWTGm3BBsdpZcHWFl0jE5BhaMcPh8BSWxSLYcUH8q2/mug62/nDguvQ8cg1510k8XNFWP79CdhM7e2iSllJ/ClPHm5y/01BcKXeHM9/mIhgjSmM/CBYoXb/0YOqHBtShVid6jUV+V/oL4a/yAQ9UOqfQfp6pf4Gpc845pltnsTGeOWFt1T5hkhwaJ5DpAR6sghjNGwh/dIa2zNH8mae75tqXb0ng2UMuhgav3jJ5wWK39lphP250v250u/2XGnhzVXUcN6v3Olq1DdKDB+Nr2qos5TrGuKU01N4dolMaUE1pDGr6iYalSTVnAxcrq0wmrfNibEgvCMeS71D95B56xFkujbhrQdw9QySas0xc/T+YO3+YG3pYO1X1p8cDukDkM+A3esbP9onZ7e2eMFN6FDEg4jvfNBx2xZQAjPohq5q2p0pUuc8b1mJKytmYB8p7iPFPxQpbgoNUYencYVX8+PfmY9tDohXZVv3RRJFgBfgzrtED07HtDwniWWZbTiVXJdZmYJbHXn/0vsxe8ndS+5ecr+15D7dRXLpFDDwqT7eG++Fdy+8e+H95sJ78mMDecMQgtpgbTzk+LNEtCgou0jIbpJRlu3qwWfzLd/qybmBKQ3huYsuP15zUuHMHh6exwP5YxV9ACVl78AZewWyVyDfVoGUxb4yvUzQq5e5ml5bssQ/Ou7RUzV7eaRO5bOT52p6Oj0+nrrT6dHzF447fbZt2kVF8+WTJw31fEMw7xmpjVlqec32TsVeJ/z36oTvwqlAPBRwE+6kYInPFQgoHmrFmiuI3jGnGq/OKKt3Bl4GTv4tFvt8tNBEz4HZtLKypqG7NsPQfdW1+jMqIq3dfcVFRgmeYaQypRtdG/LgENkmOQ+FGC1VsgjxvjXgUBIriei3KOtumcHQOWIVxCOluJ+QJe8/ARYySO7bcuXVUvhTUBi1ORluQp7DBiT/PECbkIw8OhlA60LASzs/rYx3HoRsbu5Yh2kkGMwBqhN95xC9pqPEwfovMbVu4/Ie1OYH87qK/Ps/PhcGtGEuTeR7cDRoLwDTyhRxCm9z9hyjCeDRa0yamwVMOZ3UBhtisxPxSskIr84K36tA/PC/15MnhRuoeKsnu2DnEliELn7KqvmxEx2uisJ0zmFyp5TgIp8WryvDKtuxUuLGbFIOQEOO7PGESIqd8DWbuLc/ZJdKmqsi2zklkfE8NzgECh3KUr8ntKe3pOspA9YVeM7sNrDEuRdxDSJteZkp8rGJm5WZlyzM60uR+B8DzWJoFkGLn1SwYNLemGIxsPgIAs+yI7W+eHCGZxXgWfMIGMdCqFUceAeU8CinJR2zal+MRwkeKa0yHrfB9cJzFqLcTbDCMtusPeEswjBWfxMCWQfF4IbuDP1itO5wUIskwjo5KqBk8ZCWZ6WxIvz6IBgBM5OcYpEDmfRQzLzAZZH8jVYWZP43qnz4rTRnen0DLgK2xLtRvxhnHBAvQ40s1gGxxp/9OmQstIwwB76ykhigm68/aQKNaEHvMaxGrU7gD6kPmgYHUOWru1Zn/OMsV3D6SdAHbJ21ATWMHmN27gd+Cw0LLWyJWMbgVylYxxdPcAYVujG+pi+V0Hxv88UZd3Iffhj468fW0hs0yfejd7+Rxttrmv9ETaP9dIyFR/nfB2PnVYylm3C9z7gBWctjw0WuhUtMH75/s37mbNfBSyWf9ULMyu3MXzCtrNiM3MhK/ZWuRtJVM6WCD7xTPL92G0s9QdCLGYCienmlPeWaNruKTSk8fI25XIvv/cy3WYqAVr5MKDCiOwAXVErPp9TQ6z4wd7WCDlxFISpepa+OmdPqR8As0pdTj65SwhJHM7IkVcUuPUoU/o5TLpXFarCFDOaqLa7x1mEHBAJzFSAY+O13kCI+XQAycYkiJc6NmIG7u1ymsOxr1Ih4jW0itsmi68VOGusitCBQhhZ8903Wy+hPFHKcAmVNFISgwxlmfT28o7G141ggcSYjDqTHVcwSQGYiI+XrMzIHlYBpG2yQc2uh/BVlUgAtrGrJR7joTWoQAVjAlzq1w2h+qDvFh9gWS79h8sw+T9vH7SOLAjV4jzEthN8F4A9E0yU+zIwuRkuHwGScVUk5euMg+aZVCZJBXhYYRcOXT5/wbDVGjff4GtRPhJmCt3lAiL8A4kJJV0WF+L3LKT2LSjLzgL2W3sM4lXt06OrLB9sWA/3LIV1KM9V/OdaSHKtWJO/gJf73rHUL/7Tw9snsCBS9x/NuwTzlTA7DNW5ak5eiH3Ca9/f/DxS1nk0= +api: eJztPWtz2za2fwWj+2GbGVN+JHFSf9gdRWZS3cqSK8n13rUzKURCEhuK1PIRR5vxf7/nAfAtS0mdTbqrdNpSJHBwcHDeOEA+tRI5j1tnN61uGifhUrwOo2XcenvQClcqkokXBj23ddZyIiUThR97QZzIwFGtg1ak/pmqOHkVuuvW2aeWq2In8lbYB3rgW+HFIlkooRuKlVz7oXRFEgoGKKSYAUzh5UCdMEhUkCBAuVr5nkNIHP4eI9RPrdhZqKXEp1WEKCaeivEXw3NfreufPLeOXe8ccZMiDTxATXguDOnNPBUBBuqjXK58Ba2O9B+r4T/mD3RI1itsHSeRF8zh90drHlqBXCoaqHVvWlSRmMBbRqNEBE0bV0zXAjsKFaRL8UH6qboNroejn1/3h9fv7L/b3atJbzgQxVXpGjIg7Oswej/zwzv7o3JSHPM2GA+vRl17c5dxmEa0DDgmskV9PPjIUJBLclo1NmykDIK2kBKNvb7OdIpLgh9a99mqtMLp78pJTKOVdN7LOb6fe8kinbadcHkYS89fhV6QHMYrCxcrPnTDpfQCnKOXEAEakcDFVx9XXtSw/Da9RwZA+YBHt8R8J0cnT62jl9bxyeTk6Oz42dnzF+0Xz569PP3HFpZjuDgyYnquZl7gGUGu4vC63OLcSKzninBGT8SabtYE3skk49BkAe2xxWOLTRUvM5tesEpZN7gufZL+ZUHYkyhVBw1TpG4kaoHg5cbpaanDT76cKj9GxURyVpwOKBBscgygxtKHUTZxTgF1RvMeVaTjrTxQLnGd9qPsW4UHvEQt4z+lHivKQDY9+qzVV+/cHkx6k/9rbtkj9JN1Qf+YDmVlk73dQcXsPOS/WUdkKBQYSkaRrKKSswk2xL5uxw8DMsa8FjOZ+iAUM+nHNe4fl9rzKk3D0FcgCTNfzpHlvcBFMwtrOMslWsSLMPXBCIGR/gBTk1OflIFIYxWRpMCkYTWg2wdPkqog3CSOxRCuegLaazgEOAz8dRkiwIHfBhTZPEliqpZT5brwpqpe9DQ1xfRcKjQrz1rTLWlg3XFC887F7wCJEITgq0QqBqILUkHSF7FpWVxD6t6JY28eKPc26IzHvTcD+/yhNr3Bu8vR8M3IHo/rzXoBaLM5jByDbbt6ddGbTJqgjdPp0ksSBNcdXlz27cZWXUNUaNUZdO1+v7EVPvk+Gx8tdGYe8KqALhp+gxM8ZyPjs4FfFtMCnK1i+menXYX9EjLASeI3qMtJnxh8FToLkXhL8IyBYMBoIlbg/box8GAiliE4zCAa+WsUJncNQ4TuVNx5vi+ALCF6EAnM2LbPxCJJVvHZIegdJ27LO/h3Kf8VBqSe+NH0P/QBwzg5dNUH5aORmadgOw4RGysJLd/7AP9PfGuqQPyUtQ5TC7CMkvYiWfpFaTx+/uL45cmL56dHbKAlKCIwmMnps3zR4aeak0kqqdhJnzRsZviA8bSrVLKbBwXfvsGlefvYOrpbC3VGHL6wL5d5Bcat047aqXVyNDl+Dl7a2fPn7adPT16+PPlHE8I7m+Oi73DzycyyYPrQIWjJwPK0DYOH1v3bg3IspLs1uucMwLrTjrWljGdNkO7Lq0N6l97EqzCI2Sc5OTpucmySNArQ0gTq7pEDvPpo2tc2nquLajpzXLOY6g6tilYkDW72i2Y3O+NohGqhdGxxkzQyyCr7iHQfkf5pI1IUoKX86C1hncFgpAEFTCgAHABqBnHAjrGNWmnb2xadWaIidveoPTlXEqQafUAV5LJJJgx6L8MPinJCUrCtBVPL3pZME5hTAirC99dtMYGe6H1yzyAU4OCBXSGHUvuSmU9K/iiaepB5sIDiGoeusjWgxqQgj1OmEFICzHmG2VwFmARjJ5QnDko5jL5KoN4F60w2oiFUfF36bhbIMW/APQW0PYdRBPvuzdaF4B1tPtOw9k2aBJ02NQgazXUknQQQFiHExqZxMTKtKnzjLRu+yDFrQ7ey9otSXw0puxhGDercdB1Bsz7OSvqmdR5JtsHZHpyLbY07AThww9HWdsOo6P0O0GEdjiq+7GA3N/axsSqFgkXKoSlOfdWwHH0vJnGlz+3NCYWYdNGk0RKQy6KYO0jlAzydOZkq5IxY+fBDuW3RSzKBUaCgQCAlMNRMRQpljOS6kGn5AWwIP+GknqBTq78DwCXyELZIlLMIkB7ivVo/aaPrf3k1KVNsnKFP6ZbbADTHBThHm1rZDL+YXECg8Ft3LC+4eblLiuExkSsFEvkKYQzLtqMexNJ7YXH8Dnov64Xi/BBaB4X2vMxateD4pQwgLxkupuOoVdIWP4V3EDtEB581qJ7lwW1QGLcypCwvPr0KMuYADCIFCwFjQ9wTa21Q0seuWkGkoqn5kP7VtvjebHZsVUcYFcrIA0+1USPZv4gdmtv/TMGTFmDNYOJO1kQYHPQ7LXuaRjIACymjuUrIFCmEAR4/DDqwdxl0ECaPMS6ohHzk7nCXkaFJAm7JQwPHSkbgH5QGhnWOFbjtC0UaBQyzYwBhK0PywXDybjc8gAIGFdQmu3TpBY6fAjt8JuogEICuYnLLYG3kiHCONdK7YQBIGySAvS52Yq/lKlnzGLt1QNbgPuPrXdqPMQ8QX4OmF6K7UM77OFslKVjOBOUK4D02kkFIH8Eb0181PWIUeH7VZgpnZEVqy1hZ4FPEgM4Hs9S7YQgzypEEuu3UyQ7cLZNSmIN59Cnthh0ukkawYL/sX+DHwKZkHD6RMFDSTv+iB/tC/6KH8bX+RQ+2+QUPZev3yy6Gb6/x9hpvr/H2Gu+ra7yi21aMgIjDmiOY0hi/mnbk5QIi48moN3gjmhuNeYo8HxqCk2KYlYAoW0/XAHnX740nD0KigKwKLRC024eE1CTNxKUhnsgg8lZ2DbWNAVd7Q+iRAdQ++W4gH4zRHqADUuA2eDUc9u3OYEObV9lWnrFvTF80WjmhybyVw7aDlv6g4ZctWQZkqzX7BjyxZ4qdmaKoArLPmQ5oKEAD3eOKkBOOWYdyqGgHczDwqiE2pA5fISdbmuW2nf9Ul5uo2QzGfiDToxuUcj2V1C61wDStmzp6nz1P09WTdAyxWbNOdD6I2yAjQEdO6ZoEbwYZeCZSQuEaFRKpwEqcsJz6ofMeuOSn3nnBq7OzwX/yXCXEuRdjgpcY0XNpvwglYvzT8Lqp03gR3glhB019znvjzqt+41h6lI3D2YNNPXmoTUOO7F+ueqPGjiPeXbsNhpe409DpNzUarjiTara1313Y43HnTSNA3t2+UHEM3Jl1AKvbe93rdmg3Y2MvsLjeTG/H4Yby5N25/bpz1Z+8+7XTv2oeTiXnXH5C8lJVF7w/TUK4SqNVGLP4ae2Oa466HVYR/qcXBtX6QD9owmEyVpMnK0EwNMhfFOeIb6vol42CHnurSdjz5X8PX5a2ZnL1d09b1jNvXleEnWjqJZGM1mIpVyZcQ6NNqhW6pFxCLaZFW5TDbrfq5qWsht3CLPpYo1jY0s+4tlHTY6O/xFzYWDZ6HceBdUC1PVK490YWRqeft0PnhgA536EugX95fHx0enry4+nTp8enL09foAkt7ZAzLb+iZWUCbLGttjapX2fXNcNlCxblfb2sZFcmcnON66f7pgpX7FMogZBo6T94rt6zN1l84EDaFE14M9XVnTzcGsVcu/VXLSTAz+Ua2EJSvew27VANS/P5jyxH1tKwYcfWfC3s1xZ0QmFCB4z5XVZwCW72CqaUtfGUD5H4LAqXWR9LK6XPKhd+XXTXNwjw49WY6IGancgCgQqbKOI2mNh/n4jK14n6CJHCZPjmTd+ufQvnc19xv87I7jT17QCDkJN5bg+q38GUAyFug8ufhoMa8MtFGChMRHV6/eo3GwQfjR9EUt0axmPaHgW73pnUgII8oA2EXqa6pNTRYUPXHfavLgbj6vdu6KfLIC74UThx+MnUwQdNCHjkGcMDTY5ywTARco8QaXS7AD/63dWOkx627C7pIR4sZigsdslk7qrF2DDoTeZ2Wfv4bPpa57kW2qJ3ukY6ai7dnr924S+yXGASGqK/YoT/hTuvP6u1jtyNP9qwq61I/xXQ+zVrLkjnlQa/+VQAxyrHBBDnVBX5+Fa+hlYMOH8lj8LUB2z3JzKbZGxUFIXRJgtF36qZJ7KxOTGF4laZ+fFlnJhasKY6S3CJKeMLrE11Xdgqr8im0q626M0aei+k2zAwlY15SW4fs4oxhNAbiKwonMvG7hYqYtwcn4qasEwtqxqA97HSoDdbz0bWB7Y1tryU5/pDQrDkoKhhhXS4xOsjfJ3ruVPTNq2b/syyUJyJ4Ztyq7hwRiNyReeyx0QQpqBXaEw4Rb41NPFDmH2DYe/T+8znSaMIl4DflgilAutqvIVGuhuQiYcbRh64npsG5a9iEaK3BGFd7GH4yxlUJB3G38TAjCLyqiljKmGm48udcNMYoVyCIWhSlx8TQwzpJClwDDY0rh0vgaZ8CQkKWVkyqdEWbHCcVhZsbdE1MgEZhnb8cAgstUWxGFZ8IN/6q4mus50/LLgOHY9cc95FEj9XhOXfn4DN1N4uqpSVxG5nD5vjsm928nCT+28Kgiv15nj+w0QEa0xh5AfBCrX7jx5U5diQKsTqVK+pyP9CfzH8RSbogVL/DNLXK/U3KH3GMc9s8yQ2xisvvKXKN0SCQ/McIiXQk0UYo2EL6ZfW2J45kjfzfN9U6+o9GSxj0MXQ+MVLPi9Q/M5OI+zPle7PlX6350oLb66ihvN+5U5Xo75RYvhofFVDnaVc1xCnnJ7Cs0tkSguqIY1ZVTfRqCSp5mTgcm2F0bxtTowF4R3xWOoduofMW48g07UJbz2Aq2eQVGuOmaP3B2v3B2tLB2u/sv7kcEgfgHwG7F7f+NE+Obu1xStuQociHkR854OO27aAEphBN3RV0+5MkTrnectKXFkxA/tIcR8p/qFIcVNoiDo8jSu8mh//znxsc0C8Ktu6L5IoArwAd94lenA6puU5SSzLbMOp5LrMyhTc6sj7l96P2UvuXnL3kvutJffpLpJLp4CBT/Xx3ngvvHvh3QvvNxfekx8byBuGENQGa+Mhx58lokVB2UVCdpOMsmxXDz6bb/lWT84NTGkIz110+fGakwpn9vDwPB7IH6voAygpewfO2CuQvQL5tgqkLPaV6WWCXr3O1fTakiX+0XGPnqrZyyN1Kp+dPFfT0+nx8dSdTo+ev3Dc6bNt0y4qmi+fPGmo5xuCec9IbcxSy2u2dyr2OuG/Vyd8F04F4qGAm3AnBUt8rkBA8VAr1lxB9I451Xh1Rlm9M/AycPJvsdjno4Umeg7MppWVNQ3dtRmGbqyu1Z9REWnt7isuMkrwDCOVKd3o2pAHh8g2yXkoxGipkkWI960Bh5JYSUS/RVl3ywyGzhGrIB4pxf2ELHn/CbCQQXLfliuvlsKfgsKozclwE/IcNiD55wHahGTk0ckAWhcCXtr5aWW88yBkc3PHOkwjwWAOUJ3oO4foNR0lDtZ/ial1G5f3oDY/mNdV5N//8bkwoA1zaSLfg6NBewGYVqaIU3ibs+cYTQCPXmPS3CxgyumkNtgQm52IV0pGeHVW+F4F4of/vZ48KdxAxVs92QU7l8AidPFTVs2PnehwVRSmcw6TO6UEF/m0eF0ZVtmOlRI3ZpNyABpyZI8nRFLshK/ZxL39IbtU0lwV2c4piYznucEhUOhQlvo9oT29JV1PGbCuwHNmt4Elzr2IaxBpy8tMkY9N3KzMvGRhXl+KxP8YaBZDswha/KSCBZP2xhSLgcVHEHiWHan1xYMzPKsAz5pHwDgWQq3iwDughEc5LemYVftiPErwSGmV8bgNrheesxDlboIVltlm7QlnEYax+psQyDooBjd0Z+gXo3WHg1okEdbJUQEli4e0PCuNFeHXB8EImJnkFIscyKSHYuYFLovkb7SyIPO/UeXDb6U50+sbcBGwJd6N+sU444B4GWpksQ6INf7s1yFjoWWEOfCVlcQA3Xz9SRNoRAt6j2E1anUCf0h90DQ4gCpf3bU64x9nuYLTT4I+YOusDahh9Bizcz/wW2hYaGFLxDIGv0rBOr54gjOo0I3xNX2phOZ7my/OuJP78MPAXz+2lt6gSb4fvfuNNN5e0/wnahrtp2MsPMr/Rhg7r2Is3YTrfcYNyFoeGy5yLVxi+vD9m/UzZ7sOXir5rBdiVm5n/oJpZcVm5EZW6q90NZKumikVfOCd4vm121jqCYJezAAU1csr7SnXtNlVbErh4WvM5Vp872e+zVIEtPJlQoER3QG4oFJ6PqWGXveBuasVdOAqClHxKn11zJxWPwJmkb6cenSVEpY4mpElqSp26VGi8HeccqksVoMtZDBXbXGNtw47IBCYqwDBwG+/gxTx6QKQiUsUKXFuxAzc3eUyhWVfo0bEa2wTsU0WXS920lgXoQWBMrTgu2+yXkZ/opDjFChroiAEHc4w6+vhHY2tHccCiTMZcSA9rmKWADITGSlfn5E5qARM22CDnFsL5a8okwJoYVVLPsJFb1KDCMACvtSpHUbzQ90pPsS2WPoNk2f2edo+bh9ZFKjBe4xpIfwuAH8gmi7xYWZ0MVo6BCbjrErK0RsHyTetSpAM8rLAKBq+fPqEZ6sxarzH16B+IswUvM0DQvwFEBdKuioqxO9dTulZVJKZB+y19B7GqdyjQ1dfPti2GOhfDulSmqn+67GW5Fi1InkHL/G/Z61b+KeFt09mR6DoPZ53C+YpZ3IYrnHTmrwU/YDTvL//f89MnxU= sidebar_class_name: "post api-method" info_path: docs/api/beta/identitynow-beta-api custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Creates a form instance.' (create-form-instance)" @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Creates a form instance.

    @@ -40,11 +38,11 @@ Body is the request payload to create a form instance FormInput is an object of form input labels to value -
    recipients object[]required
    +
    recipients object[]required
    Recipients is required -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Returns a new form instance diff --git a/docs/api/beta/create-identity-attribute.api.mdx b/docs/api/beta/create-identity-attribute.api.mdx index 9fdc7dcdc..b094268f9 100644 --- a/docs/api/beta/create-identity-attribute.api.mdx +++ b/docs/api/beta/create-identity-attribute.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create Identity Attribute

    @@ -36,7 +34,7 @@ This creates a new identity attribute. List of sources for an attribute, this specifies how the value of the rule is derived -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • The identity attribute was created successfully @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -84,7 +82,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -100,4 +98,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/beta/create-identity-profile.api.mdx b/docs/api/beta/create-identity-profile.api.mdx index 317b15f71..66cc15bff 100644 --- a/docs/api/beta/create-identity-profile.api.mdx +++ b/docs/api/beta/create-identity-profile.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create an Identity Profile

    @@ -49,7 +47,7 @@ The seaspray transformation definition Arbitrary key-value pairs to store any metadata for the object -
  • ]
    • identityExceptionReportReference objectnullable
    +
  • ]
    • identityExceptionReportReference objectnullable
    The created Identity Profile @@ -97,7 +95,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -113,4 +111,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-non-employee-record.api.mdx b/docs/api/beta/create-non-employee-record.api.mdx index 57ab556dc..3338f4370 100644 --- a/docs/api/beta/create-non-employee-record.api.mdx +++ b/docs/api/beta/create-non-employee-record.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create Non-Employee Record

    @@ -42,7 +40,7 @@ Non-Employee record creation request body. Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported. -
    +
    Created non-employee record. @@ -78,7 +76,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -94,4 +92,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-non-employee-request.api.mdx b/docs/api/beta/create-non-employee-request.api.mdx index ac4f069c2..e78fe77e1 100644 --- a/docs/api/beta/create-non-employee-request.api.mdx +++ b/docs/api/beta/create-non-employee-request.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create Non-Employee Request

    @@ -40,7 +38,7 @@ Non-Employee creation request body Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported. -
    +
    Non-Employee request creation object @@ -84,7 +82,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -100,4 +98,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-non-employee-source-schema-attributes.api.mdx b/docs/api/beta/create-non-employee-source-schema-attributes.api.mdx index a1e88e7fc..cd35d50f4 100644 --- a/docs/api/beta/create-non-employee-source-schema-attributes.api.mdx +++ b/docs/api/beta/create-non-employee-source-schema-attributes.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create Non-Employee Source Schema Attribute

    @@ -32,7 +30,7 @@ This API creates a new schema attribute for Non-Employee Source. The schema tech ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    Schema Attribute created. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-non-employee-source.api.mdx b/docs/api/beta/create-non-employee-source.api.mdx index 929f8c423..2dd5753df 100644 --- a/docs/api/beta/create-non-employee-source.api.mdx +++ b/docs/api/beta/create-non-employee-source.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create Non-Employee Source

    @@ -58,7 +56,7 @@ List of approvers. List of account managers. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Created non-employee source. @@ -98,7 +96,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -114,4 +112,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-notification-template.api.mdx b/docs/api/beta/create-notification-template.api.mdx index 1877a78bf..df8b9eebb 100644 --- a/docs/api/beta/create-notification-template.api.mdx +++ b/docs/api/beta/create-notification-template.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create Notification Template

    @@ -34,7 +32,7 @@ You can also use this endpoint to update a template. First, copy the response b ## Request -

    Body

    required
      0","description":"The description in the template"}}>
    +

    Body

    required
      0","description":"The description in the template"}}>
    A template object for your site @@ -66,7 +64,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -82,4 +80,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-oauth-client.api.mdx b/docs/api/beta/create-oauth-client.api.mdx index d8bb8fdf7..76ab0dbd5 100644 --- a/docs/api/beta/create-oauth-client.api.mdx +++ b/docs/api/beta/create-oauth-client.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create OAuth Client

    @@ -32,7 +30,7 @@ This creates an OAuth client. ## Request -

    Body

    required
    +

    Body

    required
    Request succeeded. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-password-org-config.api.mdx b/docs/api/beta/create-password-org-config.api.mdx index 52018afc0..d45392fce 100644 --- a/docs/api/beta/create-password-org-config.api.mdx +++ b/docs/api/beta/create-password-org-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create Password Org Config

    @@ -34,7 +32,7 @@ Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config: ## Request -

    Body

    required
      = 1` and `<= 60`"} schema={{"type":"integer","format":"int32","description":"The duration of \"digit token\" in minutes. The default value is 5.","minimum":1,"maximum":60,"default":5,"example":10}}>= 6` and `<= 18`"} schema={{"type":"integer","format":"int32","description":"The length of \"digit token\". The default value is 6.","minimum":6,"maximum":18,"default":6,"example":9}}>
    +

    Body

    required
      = 1` and `<= 60`"} schema={{"type":"integer","format":"int32","description":"The duration of \"digit token\" in minutes. The default value is 5.","minimum":1,"maximum":60,"default":5,"example":10}}>= 6` and `<= 18`"} schema={{"type":"integer","format":"int32","description":"The length of \"digit token\". The default value is 6.","minimum":6,"maximum":18,"default":6,"example":9}}>
    Reference to the password org config. @@ -66,7 +64,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -82,4 +80,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-password-sync-group.api.mdx b/docs/api/beta/create-password-sync-group.api.mdx index 70ebb275f..31efd579f 100644 --- a/docs/api/beta/create-password-sync-group.api.mdx +++ b/docs/api/beta/create-password-sync-group.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create Password Sync Group

    @@ -32,7 +30,7 @@ This API creates a password sync group based on the specifications provided. A t ## Request -

    Body

    required
    +

    Body

    required
    Reference to the password sync group. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-personal-access-token.api.mdx b/docs/api/beta/create-personal-access-token.api.mdx index 8cc6ed0a3..0c5c8c8d3 100644 --- a/docs/api/beta/create-personal-access-token.api.mdx +++ b/docs/api/beta/create-personal-access-token.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create Personal Access Token

    @@ -36,7 +34,7 @@ This creates a personal access token. Name and scope of personal access token. -
    +
    Created. Note - this is the only time Personal Access Tokens' secret attribute will be displayed. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -88,4 +86,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-potential-role-provision-request.api.mdx b/docs/api/beta/create-potential-role-provision-request.api.mdx index dd573a043..3ff096f8d 100644 --- a/docs/api/beta/create-potential-role-provision-request.api.mdx +++ b/docs/api/beta/create-potential-role-provision-request.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create request to provision a potential role into an actual role.

    @@ -36,7 +34,7 @@ This method starts a job to provision a potential role Required information to create a new role -
    +
    Accepted. Returns a potential role summary including the status of the provison request @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -92,7 +90,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -104,4 +102,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-provisioning-policy.api.mdx b/docs/api/beta/create-provisioning-policy.api.mdx index 8df804088..68cf14fcd 100644 --- a/docs/api/beta/create-provisioning-policy.api.mdx +++ b/docs/api/beta/create-provisioning-policy.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create Provisioning Policy

    @@ -35,7 +33,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    Body

    required
      fields object[]
    • Array [
    • ]
    +

    Path Parameters

    Body

    required
      fields object[]
    • Array [
    • ]
    Created ProvisioningPolicyDto object @@ -67,7 +65,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -79,7 +77,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -95,4 +93,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-reassignment-configuration.api.mdx b/docs/api/beta/create-reassignment-configuration.api.mdx index 68c687183..06e2aaa7f 100644 --- a/docs/api/beta/create-reassignment-configuration.api.mdx +++ b/docs/api/beta/create-reassignment-configuration.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a Reassignment Configuration

    @@ -32,7 +30,7 @@ Creates a new Reassignment Configuration for the specified identity. ## Request -

    Body

    required
    +

    Body

    required
    The newly created Reassignment Configuration object @@ -88,7 +86,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -104,4 +102,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-role-insight-requests.api.mdx b/docs/api/beta/create-role-insight-requests.api.mdx index 363994812..7a08a9cb4 100644 --- a/docs/api/beta/create-role-insight-requests.api.mdx +++ b/docs/api/beta/create-role-insight-requests.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Generate insights for roles

    @@ -36,7 +34,7 @@ Submits a create role insights request to the role insights application. At this ## Request -
    +
    Submitted a role insights generation request @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-role-mining-sessions.api.mdx b/docs/api/beta/create-role-mining-sessions.api.mdx index 14271abce..e0e1fc6bf 100644 --- a/docs/api/beta/create-role-mining-sessions.api.mdx +++ b/docs/api/beta/create-role-mining-sessions.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a role mining session

    @@ -52,7 +50,7 @@ The session created by details string -
    +
    Submitted a role mining session request @@ -92,7 +90,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -108,4 +106,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-role.api.mdx b/docs/api/beta/create-role.api.mdx index 3d0eceb50..0c359afd8 100644 --- a/docs/api/beta/create-role.api.mdx +++ b/docs/api/beta/create-role.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a Role

    @@ -91,7 +89,7 @@ Revocation request configuration for this object. List describing the steps in approving the revocation request -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Role created @@ -179,7 +177,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -195,4 +193,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-search-attribute-config.api.mdx b/docs/api/beta/create-search-attribute-config.api.mdx index 9176807f8..8f8ea7607 100644 --- a/docs/api/beta/create-search-attribute-config.api.mdx +++ b/docs/api/beta/create-search-attribute-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Configure/create extended search attributes in IdentityNow.

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Body

    required
    +

    Body

    required
    Accepted - Returned if the request was successfully accepted into the system. @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -81,7 +79,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -97,4 +95,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-segment.api.mdx b/docs/api/beta/create-segment.api.mdx index 2bad516b7..955c795cb 100644 --- a/docs/api/beta/create-segment.api.mdx +++ b/docs/api/beta/create-segment.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create Segment

    @@ -42,7 +40,7 @@ The owner of this object. List of expressions -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Segment created @@ -82,7 +80,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -98,4 +96,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-send-token.api.mdx b/docs/api/beta/create-send-token.api.mdx index 682d552f9..135717164 100644 --- a/docs/api/beta/create-send-token.api.mdx +++ b/docs/api/beta/create-send-token.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create and send user token

    @@ -32,7 +30,7 @@ This API send token request. ## Request -

    Body

    required
    +

    Body

    required
    Token send status. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-service-desk-integration.api.mdx b/docs/api/beta/create-service-desk-integration.api.mdx index ada8fa729..224750342 100644 --- a/docs/api/beta/create-service-desk-integration.api.mdx +++ b/docs/api/beta/create-service-desk-integration.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create new Service Desk integration

    @@ -64,7 +62,7 @@ Service Desk integration's attributes. Validation constraints enforced by the im Before Provisioning Rule. -
    +
    details of the created integration @@ -124,7 +122,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -136,7 +134,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -152,4 +150,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-sod-policy.api.mdx b/docs/api/beta/create-sod-policy.api.mdx index 9c14739b7..6f7d6d825 100644 --- a/docs/api/beta/create-sod-policy.api.mdx +++ b/docs/api/beta/create-sod-policy.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create SOD policy

    @@ -53,7 +51,7 @@ List of criteria. There is a min of 1 and max of 50 items in the list. List of criteria. There is a min of 1 and max of 50 items in the list. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • SOD policy created @@ -101,7 +99,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -117,4 +115,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-source-schema.api.mdx b/docs/api/beta/create-source-schema.api.mdx index 4ac472e62..9ff1e22af 100644 --- a/docs/api/beta/create-source-schema.api.mdx +++ b/docs/api/beta/create-source-schema.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Creates a new Schema on the specified Source in IdentityNow.

    @@ -40,7 +38,7 @@ The attribute definitions which form the schema. A reference to the schema on the source to the attribute values map to. -
  • ]
    • +
  • ]
    • The Schema was successfully created on the specified Source. @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-source.api.mdx b/docs/api/beta/create-source.api.mdx index 56146c811..656eec168 100644 --- a/docs/api/beta/create-source.api.mdx +++ b/docs/api/beta/create-source.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Creates a source in IdentityNow.

    @@ -73,7 +71,7 @@ List of references to the associated PasswordPolicy objects. Reference to Management Workgroup for this Source -
    +
    Created Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design. @@ -145,7 +143,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -161,4 +159,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-subscription.api.mdx b/docs/api/beta/create-subscription.api.mdx index 4acd5f1fa..522673c92 100644 --- a/docs/api/beta/create-subscription.api.mdx +++ b/docs/api/beta/create-subscription.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a Subscription

    @@ -50,7 +48,7 @@ Config required if BEARER_TOKEN authentication is used. On response, this field Config required if EVENTBRIDGE subscription type is used. -
    +
    New subscription to a trigger. The trigger can now be invoked by the method defined in the subscription. @@ -98,7 +96,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -114,4 +112,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-transform.api.mdx b/docs/api/beta/create-transform.api.mdx index b92f416f4..e612276b6 100644 --- a/docs/api/beta/create-transform.api.mdx +++ b/docs/api/beta/create-transform.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create transform

    @@ -268,7 +266,7 @@ This is an optional attribute that can explicitly define the input data which wi This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. -
    +
    Indicates the transform was successfully created and returns its representation. @@ -532,7 +530,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -544,7 +542,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -560,4 +558,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-verified-from-address.api.mdx b/docs/api/beta/create-verified-from-address.api.mdx index 20ff7def0..7e8be7ca0 100644 --- a/docs/api/beta/create-verified-from-address.api.mdx +++ b/docs/api/beta/create-verified-from-address.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create Verified From Address

    @@ -32,7 +30,7 @@ Create a new sender email address and initiate verification process. ## Request -

    Body

    required
    +

    Body

    required
    New Verified Email Status @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-workflow.api.mdx b/docs/api/beta/create-workflow.api.mdx index c416c270c..d2cf16815 100644 --- a/docs/api/beta/create-workflow.api.mdx +++ b/docs/api/beta/create-workflow.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create Workflow

    @@ -52,7 +50,7 @@ The trigger that starts the workflow Workflow Trigger Attributes. -
    oneOf
    +
    oneOf
    The Workflow object @@ -108,7 +106,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -124,4 +122,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/create-workgroup.api.mdx b/docs/api/beta/create-workgroup.api.mdx index 25210665d..1d705c703 100644 --- a/docs/api/beta/create-workgroup.api.mdx +++ b/docs/api/beta/create-workgroup.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a new Governance Group.

    @@ -36,7 +34,7 @@ This API creates a new Governance Group. Owner's identity. -
    +
    Governance Group object created. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -88,4 +86,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-access-profile.api.mdx b/docs/api/beta/delete-access-profile.api.mdx index e338a18c9..1d4bed10b 100644 --- a/docs/api/beta/delete-access-profile.api.mdx +++ b/docs/api/beta/delete-access-profile.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete the specified Access Profile

    @@ -36,7 +34,7 @@ A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is requi ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-access-profiles-in-bulk.api.mdx b/docs/api/beta/delete-access-profiles-in-bulk.api.mdx index 34d910719..1a23be187 100644 --- a/docs/api/beta/delete-access-profiles-in-bulk.api.mdx +++ b/docs/api/beta/delete-access-profiles-in-bulk.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Access Profile(s)

    @@ -36,7 +34,7 @@ A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is requi ## Request -

    Body

    required
    +

    Body

    required
    Returned only if **bestEffortOnly** is **false**, and one or more Access Profiles are in use. @@ -88,7 +86,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -104,4 +102,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-account.api.mdx b/docs/api/beta/delete-account.api.mdx index 700c1dacf..4257f6d52 100644 --- a/docs/api/beta/delete-account.api.mdx +++ b/docs/api/beta/delete-account.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Account

    @@ -36,7 +34,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    Async task details. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-campaign-template-schedule.api.mdx b/docs/api/beta/delete-campaign-template-schedule.api.mdx index 07015d4bc..4876a244f 100644 --- a/docs/api/beta/delete-campaign-template-schedule.api.mdx +++ b/docs/api/beta/delete-campaign-template-schedule.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Deletes a Campaign Template's Schedule

    @@ -36,7 +34,7 @@ Deletes the schedule for a campaign template. Returns a 404 if there is no sched ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-campaign-template.api.mdx b/docs/api/beta/delete-campaign-template.api.mdx index 17c4b65ef..343c4bd02 100644 --- a/docs/api/beta/delete-campaign-template.api.mdx +++ b/docs/api/beta/delete-campaign-template.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete a Campaign Template

    @@ -36,7 +34,7 @@ Deletes a campaign template by ID. ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-campaigns.api.mdx b/docs/api/beta/delete-campaigns.api.mdx index b26309551..5aec2add7 100644 --- a/docs/api/beta/delete-campaigns.api.mdx +++ b/docs/api/beta/delete-campaigns.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Deletes Campaigns

    @@ -40,7 +38,7 @@ Deletes campaigns whose Ids are specified in the provided list of campaign Ids. The ids of the campaigns to delete. -
    +
    Accepted - Returned if the request was successfully accepted into the system. @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -88,7 +86,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -104,4 +102,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-connector-rule.api.mdx b/docs/api/beta/delete-connector-rule.api.mdx index dce4805cb..84b0f4f7e 100644 --- a/docs/api/beta/delete-connector-rule.api.mdx +++ b/docs/api/beta/delete-connector-rule.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete a Connector-Rule

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-custom-password-instructions.api.mdx b/docs/api/beta/delete-custom-password-instructions.api.mdx index e3e05eff2..da75b5a46 100644 --- a/docs/api/beta/delete-custom-password-instructions.api.mdx +++ b/docs/api/beta/delete-custom-password-instructions.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Custom Password Instructions by page ID

    @@ -32,7 +30,7 @@ This API delete the custom password instructions for the specified page ID. A to ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -60,7 +58,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-form-definition.api.mdx b/docs/api/beta/delete-form-definition.api.mdx index be5ada62d..d21934915 100644 --- a/docs/api/beta/delete-form-definition.api.mdx +++ b/docs/api/beta/delete-form-definition.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Deletes a form definition.

    @@ -32,7 +30,7 @@ Parameter `{formDefinitionID}` should match a form definition ID. ## Request -

    Path Parameters

    +

    Path Parameters

    Returns an empty body diff --git a/docs/api/beta/delete-identity-attribute.api.mdx b/docs/api/beta/delete-identity-attribute.api.mdx index 3e8ced900..38f378476 100644 --- a/docs/api/beta/delete-identity-attribute.api.mdx +++ b/docs/api/beta/delete-identity-attribute.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Identity Attribute

    @@ -32,7 +30,7 @@ This deletes an identity attribute with the given name. The `system` and `stand ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-identity-attributes-in-bulk.api.mdx b/docs/api/beta/delete-identity-attributes-in-bulk.api.mdx index a66470bf8..74b714491 100644 --- a/docs/api/beta/delete-identity-attributes-in-bulk.api.mdx +++ b/docs/api/beta/delete-identity-attributes-in-bulk.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Bulk delete Identity Attributes

    @@ -32,7 +30,7 @@ This deletes identity attributes for a given set of names. Attributes that are c ## Request -

    Body

    required
    +

    Body

    required
    No content - indicates the request was successful but there is no content to be returned in the response. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-identity-profile.api.mdx b/docs/api/beta/delete-identity-profile.api.mdx index b1fb0d38f..d92a45c81 100644 --- a/docs/api/beta/delete-identity-profile.api.mdx +++ b/docs/api/beta/delete-identity-profile.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete an Identity Profile

    @@ -38,7 +36,7 @@ The following rights are required to access this endpoint: idn:identity-profile: ## Request -

    Path Parameters

    +

    Path Parameters

    Accepted - Returns a TaskResult object referencing the bulk delete job created. @@ -70,7 +68,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -82,7 +80,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -98,4 +96,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-identity-profiles.api.mdx b/docs/api/beta/delete-identity-profiles.api.mdx index aaad92aa9..24211acca 100644 --- a/docs/api/beta/delete-identity-profiles.api.mdx +++ b/docs/api/beta/delete-identity-profiles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Identity Profiles

    @@ -46,7 +44,7 @@ Identity Profile bulk delete request body. string -
  • ]
    • +
  • ]
    • Accepted - Returns a TaskResult object referencing the bulk delete job created. @@ -78,7 +76,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -94,4 +92,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-identity.api.mdx b/docs/api/beta/delete-identity.api.mdx index d15af8778..b7c91212e 100644 --- a/docs/api/beta/delete-identity.api.mdx +++ b/docs/api/beta/delete-identity.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Deletes an identity.

    @@ -32,7 +30,7 @@ The API returns successful response if the requested identity was deleted. ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-mfa-config.api.mdx b/docs/api/beta/delete-mfa-config.api.mdx index eb09b7a23..e5ff5d6c0 100644 --- a/docs/api/beta/delete-mfa-config.api.mdx +++ b/docs/api/beta/delete-mfa-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete MFA method configuration

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    MFA configuration of an MFA method. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -81,4 +79,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-native-change-detection-config.api.mdx b/docs/api/beta/delete-native-change-detection-config.api.mdx index 948299fa8..b92c60a73 100644 --- a/docs/api/beta/delete-native-change-detection-config.api.mdx +++ b/docs/api/beta/delete-native-change-detection-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Native Change Detection Configuration

    @@ -33,7 +31,7 @@ A token with API, or ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-non-employee-record-in-bulk.api.mdx b/docs/api/beta/delete-non-employee-record-in-bulk.api.mdx index 7d374645c..0bf7ef55e 100644 --- a/docs/api/beta/delete-non-employee-record-in-bulk.api.mdx +++ b/docs/api/beta/delete-non-employee-record-in-bulk.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Multiple Non-Employee Records

    @@ -38,7 +36,7 @@ Request will require the following scope: Non-Employee bulk delete request body. -
    +
    No content - indicates the request was successful but there is no content to be returned in the response. @@ -70,7 +68,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -86,4 +84,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-non-employee-record.api.mdx b/docs/api/beta/delete-non-employee-record.api.mdx index bddd5dc27..4c6d52789 100644 --- a/docs/api/beta/delete-non-employee-record.api.mdx +++ b/docs/api/beta/delete-non-employee-record.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Non-Employee Record

    @@ -32,7 +30,7 @@ This request will delete a non-employee record. ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-non-employee-request.api.mdx b/docs/api/beta/delete-non-employee-request.api.mdx index f948f7c34..bcd6a1bd7 100644 --- a/docs/api/beta/delete-non-employee-request.api.mdx +++ b/docs/api/beta/delete-non-employee-request.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Non-Employee Request

    @@ -32,7 +30,7 @@ This request will delete a non-employee request. ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-non-employee-schema-attribute.api.mdx b/docs/api/beta/delete-non-employee-schema-attribute.api.mdx index 8afcb536b..8a01f5bf6 100644 --- a/docs/api/beta/delete-non-employee-schema-attribute.api.mdx +++ b/docs/api/beta/delete-non-employee-schema-attribute.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Non-Employee Source's Schema Attribute

    @@ -33,7 +31,7 @@ This end-point deletes a specific schema attribute for a non-employee source. ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -81,4 +79,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-non-employee-source-schema-attributes.api.mdx b/docs/api/beta/delete-non-employee-source-schema-attributes.api.mdx index 53f9b3d26..b9973e0b2 100644 --- a/docs/api/beta/delete-non-employee-source-schema-attributes.api.mdx +++ b/docs/api/beta/delete-non-employee-source-schema-attributes.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete all custom schema attributes

    @@ -32,7 +30,7 @@ This end-point deletes all custom schema attributes for a non-employee source. ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-non-employee-source.api.mdx b/docs/api/beta/delete-non-employee-source.api.mdx index 1cbd4e484..ecf8c6f19 100644 --- a/docs/api/beta/delete-non-employee-source.api.mdx +++ b/docs/api/beta/delete-non-employee-source.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Non-Employee Source

    @@ -32,7 +30,7 @@ This request will delete a non-employee source. ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-notification-templates-in-bulk.api.mdx b/docs/api/beta/delete-notification-templates-in-bulk.api.mdx index eeb243707..a3153b836 100644 --- a/docs/api/beta/delete-notification-templates-in-bulk.api.mdx +++ b/docs/api/beta/delete-notification-templates-in-bulk.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Bulk Delete Notification Templates

    @@ -32,7 +30,7 @@ This lets you bulk delete templates that you previously created for your site. S ## Request -

    Body

    arrayrequired
    • Array [
    • ]
    +

    Body

    arrayrequired
    • Array [
    • ]
    No content - indicates the request was successful but there is no content to be returned in the response. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-oauth-client.api.mdx b/docs/api/beta/delete-oauth-client.api.mdx index f6b8f9a41..c4041ee5d 100644 --- a/docs/api/beta/delete-oauth-client.api.mdx +++ b/docs/api/beta/delete-oauth-client.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete OAuth Client

    @@ -32,7 +30,7 @@ This deletes an OAuth client. ## Request -

    Path Parameters

    +

    Path Parameters

    No content. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-password-sync-group.api.mdx b/docs/api/beta/delete-password-sync-group.api.mdx index 39a762a07..7d60a7802 100644 --- a/docs/api/beta/delete-password-sync-group.api.mdx +++ b/docs/api/beta/delete-password-sync-group.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Password Sync Group by ID

    @@ -32,7 +30,7 @@ This API deletes the specified password sync group. A token with ORG_ADMIN autho ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-personal-access-token.api.mdx b/docs/api/beta/delete-personal-access-token.api.mdx index 34154684c..054058268 100644 --- a/docs/api/beta/delete-personal-access-token.api.mdx +++ b/docs/api/beta/delete-personal-access-token.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Personal Access Token

    @@ -32,7 +30,7 @@ This deletes a personal access token. ## Request -

    Path Parameters

    +

    Path Parameters

    No content. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-provisioning-policy.api.mdx b/docs/api/beta/delete-provisioning-policy.api.mdx index 476bec442..d948168c7 100644 --- a/docs/api/beta/delete-provisioning-policy.api.mdx +++ b/docs/api/beta/delete-provisioning-policy.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Provisioning Policy by UsageType

    @@ -33,7 +31,7 @@ A token with API, or ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-reassignment-configuration.api.mdx b/docs/api/beta/delete-reassignment-configuration.api.mdx index 16cef533d..e1018664c 100644 --- a/docs/api/beta/delete-reassignment-configuration.api.mdx +++ b/docs/api/beta/delete-reassignment-configuration.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Reassignment Configuration

    @@ -32,7 +30,7 @@ Deletes all Reassignment Configuration for the specified identity ## Request -

    Path Parameters

    +

    Path Parameters

    Reassignment Configuration deleted @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-role.api.mdx b/docs/api/beta/delete-role.api.mdx index f1c49c16f..c75709cdb 100644 --- a/docs/api/beta/delete-role.api.mdx +++ b/docs/api/beta/delete-role.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete a Role

    @@ -33,7 +31,7 @@ A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -81,4 +79,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-search-attribute-config.api.mdx b/docs/api/beta/delete-search-attribute-config.api.mdx index 10851e9b7..389067b8f 100644 --- a/docs/api/beta/delete-search-attribute-config.api.mdx +++ b/docs/api/beta/delete-search-attribute-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete an extended search attribute in IdentityNow.

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -53,7 +51,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -81,4 +79,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-segment.api.mdx b/docs/api/beta/delete-segment.api.mdx index e194289c2..cf55b6ecf 100644 --- a/docs/api/beta/delete-segment.api.mdx +++ b/docs/api/beta/delete-segment.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Segment by ID

    @@ -34,7 +32,7 @@ A token with ORG_ADMIN or API authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    No content. @@ -66,7 +64,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -78,7 +76,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -94,4 +92,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-service-desk-integration.api.mdx b/docs/api/beta/delete-service-desk-integration.api.mdx index a0a987bdd..0a6f437f4 100644 --- a/docs/api/beta/delete-service-desk-integration.api.mdx +++ b/docs/api/beta/delete-service-desk-integration.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete a Service Desk integration

    @@ -32,7 +30,7 @@ Delete an existing Service Desk integration by ID. A token with Org Admin or Se ## Request -

    Path Parameters

    +

    Path Parameters

    Service Desk integration with the given ID successfully deleted @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-sod-policy-schedule.api.mdx b/docs/api/beta/delete-sod-policy-schedule.api.mdx index 872cc4828..0b8709603 100644 --- a/docs/api/beta/delete-sod-policy-schedule.api.mdx +++ b/docs/api/beta/delete-sod-policy-schedule.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete SOD policy schedule

    @@ -37,7 +35,7 @@ Requires role of ORG_ADMIN. ## Request -

    Path Parameters

    +

    Path Parameters

    No content. @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -81,7 +79,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -97,4 +95,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-sod-policy.api.mdx b/docs/api/beta/delete-sod-policy.api.mdx index 125b40f5a..703ef3236 100644 --- a/docs/api/beta/delete-sod-policy.api.mdx +++ b/docs/api/beta/delete-sod-policy.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete SOD policy by ID

    @@ -37,7 +35,7 @@ Requires role of ORG_ADMIN. ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    No content. @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -81,7 +79,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -97,4 +95,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-source-schema.api.mdx b/docs/api/beta/delete-source-schema.api.mdx index f35c41350..d62820d17 100644 --- a/docs/api/beta/delete-source-schema.api.mdx +++ b/docs/api/beta/delete-source-schema.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Source Schema by ID

    @@ -32,7 +30,7 @@ Delete Source Schema by ID ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-subscription.api.mdx b/docs/api/beta/delete-subscription.api.mdx index 9e15568c8..40fcb1dbd 100644 --- a/docs/api/beta/delete-subscription.api.mdx +++ b/docs/api/beta/delete-subscription.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete a Subscription

    @@ -32,7 +30,7 @@ Deletes an existing subscription to a trigger. ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-tagged-object.api.mdx b/docs/api/beta/delete-tagged-object.api.mdx index 723bea788..f0987f609 100644 --- a/docs/api/beta/delete-tagged-object.api.mdx +++ b/docs/api/beta/delete-tagged-object.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Tagged Object

    @@ -32,7 +30,7 @@ This deletes a tagged object for the specified type. ## Request -

    Path Parameters

    +

    Path Parameters

    No content. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-tags-to-many-object.api.mdx b/docs/api/beta/delete-tags-to-many-object.api.mdx index 58a1fcb07..e94dd7459 100644 --- a/docs/api/beta/delete-tags-to-many-object.api.mdx +++ b/docs/api/beta/delete-tags-to-many-object.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Remove Tags from Multiple Objects

    @@ -38,7 +36,7 @@ A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. -
    +
      objectRefs object[]
    • Array [
    • ]
    No content - indicates the request was successful but there is no content to be returned in the response. @@ -70,7 +68,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -86,4 +84,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-transform.api.mdx b/docs/api/beta/delete-transform.api.mdx index 84a4b6f27..f7c821e84 100644 --- a/docs/api/beta/delete-transform.api.mdx +++ b/docs/api/beta/delete-transform.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete a transform

    @@ -33,7 +31,7 @@ A token with transform delete authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-verified-from-address.api.mdx b/docs/api/beta/delete-verified-from-address.api.mdx index 226e7abf7..33089823e 100644 --- a/docs/api/beta/delete-verified-from-address.api.mdx +++ b/docs/api/beta/delete-verified-from-address.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Verified From Address

    @@ -32,7 +30,7 @@ Delete a verified sender email address ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-workflow.api.mdx b/docs/api/beta/delete-workflow.api.mdx index 3eccdf1ca..906bf24ee 100644 --- a/docs/api/beta/delete-workflow.api.mdx +++ b/docs/api/beta/delete-workflow.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Workflow By Id

    @@ -32,7 +30,7 @@ Delete a workflow. **Enabled workflows cannot be deleted**. They must first be ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-workgroup-members.api.mdx b/docs/api/beta/delete-workgroup-members.api.mdx index 338d2c1ec..61780aa27 100644 --- a/docs/api/beta/delete-workgroup-members.api.mdx +++ b/docs/api/beta/delete-workgroup-members.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Remove members from Governance Group

    @@ -40,7 +38,7 @@ This API removes one or more members from a Governance Group. A token with API List of identities to be removed from a Governance Group members list. -
    +
    • Array [
    • ]
    List of deleted and not deleted identities from Governance Group members list. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -88,4 +86,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-workgroup.api.mdx b/docs/api/beta/delete-workgroup.api.mdx index 30c95f6ef..d3f3ed94a 100644 --- a/docs/api/beta/delete-workgroup.api.mdx +++ b/docs/api/beta/delete-workgroup.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete a Governance Group

    @@ -32,7 +30,7 @@ This API deletes a Governance Group by its ID. ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete-workgroups-in-bulk.api.mdx b/docs/api/beta/delete-workgroups-in-bulk.api.mdx index f68e161c4..fc9bdf7a2 100644 --- a/docs/api/beta/delete-workgroups-in-bulk.api.mdx +++ b/docs/api/beta/delete-workgroups-in-bulk.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Governance Group(s)

    @@ -43,7 +41,7 @@ This API initiates a bulk deletion of one or more Governance Groups. ## Request -

    Body

    required
    +

    Body

    required
    Governance Group bulk delete response. @@ -75,7 +73,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -91,4 +89,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/delete.api.mdx b/docs/api/beta/delete.api.mdx index 133920f92..72da8b84a 100644 --- a/docs/api/beta/delete.api.mdx +++ b/docs/api/beta/delete.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Source by ID

    @@ -34,11 +32,11 @@ All of accounts on the source will be removed first, then the source will be del ## Request -

    Path Parameters

    +

    Path Parameters

    Accepted - Returned if the request was successfully accepted into the system. -
    Schema
     Response returned when deleting a source
    +
    Schema

    Response returned when deleting a source

    Client Error - Returned if the request body is invalid. @@ -66,7 +64,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -78,7 +76,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -94,4 +92,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/disable-account-for-identity.api.mdx b/docs/api/beta/disable-account-for-identity.api.mdx index 9d466bb8a..7c41c85f0 100644 --- a/docs/api/beta/disable-account-for-identity.api.mdx +++ b/docs/api/beta/disable-account-for-identity.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Disable IDN Account for Identity

    @@ -32,7 +30,7 @@ This API submits a task to disable IDN account for a single identity. ## Request -

    Path Parameters

    +

    Path Parameters

    Accepted - Returned if the request was successfully accepted into the system. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/disable-account.api.mdx b/docs/api/beta/disable-account.api.mdx index ee6f69c49..b5f6e21a0 100644 --- a/docs/api/beta/disable-account.api.mdx +++ b/docs/api/beta/disable-account.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Disable Account

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    Async task details @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/disable-accounts-for-identities.api.mdx b/docs/api/beta/disable-accounts-for-identities.api.mdx index fcbd1a379..3f9356670 100644 --- a/docs/api/beta/disable-accounts-for-identities.api.mdx +++ b/docs/api/beta/disable-accounts-for-identities.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Disable IDN Accounts for Identities

    @@ -32,7 +30,7 @@ This API submits tasks to disable IDN account for each identity provided in the ## Request -

    Body

    required
    +

    Body

    required
    Bulk response details. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/download-role-insights-entitlements-changes.api.mdx b/docs/api/beta/download-role-insights-entitlements-changes.api.mdx index 4d81a4897..46c023a82 100644 --- a/docs/api/beta/download-role-insights-entitlements-changes.api.mdx +++ b/docs/api/beta/download-role-insights-entitlements-changes.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Download entitlement insights for a role

    @@ -32,7 +30,7 @@ This endpoint returns the entitlement insights for a role. ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Succeeded. Returns a csv file containing a list of entitlements to be added for a role. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/download-role-mining-potential-role-zip.api.mdx b/docs/api/beta/download-role-mining-potential-role-zip.api.mdx index be0f162f9..2c7c7681f 100644 --- a/docs/api/beta/download-role-mining-potential-role-zip.api.mdx +++ b/docs/api/beta/download-role-mining-potential-role-zip.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Export (download) details for a potential role in a role mining session

    @@ -32,7 +30,7 @@ This endpoint downloads a completed export of information for a potential role i ## Request -

    Path Parameters

    +

    Path Parameters

    Succeeded. Returns a zip file containing csv files for identities and entitlements for the potential role. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/enable-account-for-identity.api.mdx b/docs/api/beta/enable-account-for-identity.api.mdx index 181308e8a..b17803458 100644 --- a/docs/api/beta/enable-account-for-identity.api.mdx +++ b/docs/api/beta/enable-account-for-identity.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Enable IDN Account for Identity

    @@ -32,7 +30,7 @@ This API submits a task to enable IDN account for a single identity. ## Request -

    Path Parameters

    +

    Path Parameters

    Accepted - Returned if the request was successfully accepted into the system. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/enable-account.api.mdx b/docs/api/beta/enable-account.api.mdx index d00141a0d..21ca9daa7 100644 --- a/docs/api/beta/enable-account.api.mdx +++ b/docs/api/beta/enable-account.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Enable Account

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    Async task details @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/enable-accounts-for-identities.api.mdx b/docs/api/beta/enable-accounts-for-identities.api.mdx index a78d151b1..e9a9de91e 100644 --- a/docs/api/beta/enable-accounts-for-identities.api.mdx +++ b/docs/api/beta/enable-accounts-for-identities.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Enable IDN Accounts for Identities

    @@ -32,7 +30,7 @@ This API submits tasks to enable IDN account for each identity provided in the r ## Request -

    Body

    required
    +

    Body

    required
    Bulk response details. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/export-form-definitions-by-tenant.api.mdx b/docs/api/beta/export-form-definitions-by-tenant.api.mdx index 02e8ac19f..ab2e7a632 100644 --- a/docs/api/beta/export-form-definitions-by-tenant.api.mdx +++ b/docs/api/beta/export-form-definitions-by-tenant.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List form definitions by tenant.

    @@ -32,7 +30,7 @@ No parameters required. ## Request -

    Query Parameters

    +

    Query Parameters

    Returns a list of form definition objects by tenant used by SP-Config diff --git a/docs/api/beta/export-identity-profiles.api.mdx b/docs/api/beta/export-identity-profiles.api.mdx index dab707b88..08bb29fa2 100644 --- a/docs/api/beta/export-identity-profiles.api.mdx +++ b/docs/api/beta/export-identity-profiles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Export Identity Profiles

    @@ -32,7 +30,7 @@ This exports existing identity profiles in the format specified by the sp-config ## Request -

    Query Parameters

    +

    Query Parameters

    List of export objects with identity profiles. @@ -84,7 +82,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -96,7 +94,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -112,4 +110,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/export-non-employee-records.api.mdx b/docs/api/beta/export-non-employee-records.api.mdx index 6c3bb50ff..069e81332 100644 --- a/docs/api/beta/export-non-employee-records.api.mdx +++ b/docs/api/beta/export-non-employee-records.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Exports Non-Employee Records to CSV

    @@ -32,7 +30,7 @@ This requests a CSV download for all non-employees from a provided source. ## Request -

    Path Parameters

    +

    Path Parameters

    Exported CSV @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/export-non-employee-source-schema-template.api.mdx b/docs/api/beta/export-non-employee-source-schema-template.api.mdx index b474a8d02..d6f92423f 100644 --- a/docs/api/beta/export-non-employee-source-schema-template.api.mdx +++ b/docs/api/beta/export-non-employee-source-schema-template.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Exports Source Schema Template

    @@ -34,7 +32,7 @@ idn:nesr:read' ## Request -

    Path Parameters

    +

    Path Parameters

    Exported Source Schema Template @@ -66,7 +64,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -78,7 +76,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -94,4 +92,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/export-outliers-zip.api.mdx b/docs/api/beta/export-outliers-zip.api.mdx index a13a2213a..e5a2d17ef 100644 --- a/docs/api/beta/export-outliers-zip.api.mdx +++ b/docs/api/beta/export-outliers-zip.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    IAI Identity Outliers Export

    @@ -33,7 +31,7 @@ Requires authorization scope of 'iai:outliers-management:read' ## Request -

    Query Parameters

    +

    Query Parameters

    Succeeded. Returns zip of 2 CSVs to download. 1 CSV for ignored outliers and 1 for non-ignored outliers @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -85,4 +83,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/export-role-mining-potential-role-async.api.mdx b/docs/api/beta/export-role-mining-potential-role-async.api.mdx index a6189e113..3a65adf87 100644 --- a/docs/api/beta/export-role-mining-potential-role-async.api.mdx +++ b/docs/api/beta/export-role-mining-potential-role-async.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Asynchronously export details for a potential role in a role mining session and upload to S3

    @@ -32,7 +30,7 @@ This endpoint uploads all the information for a potential role in a role mining ## Request -

    Path Parameters

    Body

    +

    Path Parameters

    Body

    Job Submitted. Returns a reportId that can be used to download the zip once complete @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -76,4 +74,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/export-role-mining-potential-role-status.api.mdx b/docs/api/beta/export-role-mining-potential-role-status.api.mdx index 499d3a48c..79c3c72ad 100644 --- a/docs/api/beta/export-role-mining-potential-role-status.api.mdx +++ b/docs/api/beta/export-role-mining-potential-role-status.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Retrieve status of a potential role export job

    @@ -32,7 +30,7 @@ This endpoint retrieves information about the current status of a potential role ## Request -

    Path Parameters

    +

    Path Parameters

    Success. Returns the current status of this export @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -76,4 +74,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/export-role-mining-potential-role.api.mdx b/docs/api/beta/export-role-mining-potential-role.api.mdx index 9ef32ad1c..39da4ce69 100644 --- a/docs/api/beta/export-role-mining-potential-role.api.mdx +++ b/docs/api/beta/export-role-mining-potential-role.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Export (download) details for a potential role in a role mining session

    @@ -32,7 +30,7 @@ This endpoint downloads all the information for a potential role in a role minin ## Request -

    Path Parameters

    +

    Path Parameters

    Succeeded. Returns a zip file containing csv files for identities and entitlements for the potential role. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/export-sp-config.api.mdx b/docs/api/beta/export-sp-config.api.mdx index 0bc61fa20..9b402b65b 100644 --- a/docs/api/beta/export-sp-config.api.mdx +++ b/docs/api/beta/export-sp-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Initiates configuration objects export job

    @@ -41,7 +39,7 @@ Export options control what will be included in the export. Additional options targeting specific objects related to each item in the includeTypes field -
    property name* ObjectExportImportOptions
    +
    property name* ObjectExportImportOptions
    Export job accepted and queued for processing. @@ -74,7 +72,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -86,7 +84,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -102,4 +100,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/forward-access-request.api.mdx b/docs/api/beta/forward-access-request.api.mdx index a2a6c278e..22dc7a033 100644 --- a/docs/api/beta/forward-access-request.api.mdx +++ b/docs/api/beta/forward-access-request.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Forwards an access request approval to a new owner.

    @@ -36,7 +34,7 @@ This endpoint forwards an access request approval. Only the owner of the approva Information about the forwarded approval. -
    +
    Accepted - Returned if the request was successfully accepted into the system. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -84,7 +82,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -100,4 +98,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/forward-work-item.api.mdx b/docs/api/beta/forward-work-item.api.mdx index 4325da99b..99c766f73 100644 --- a/docs/api/beta/forward-work-item.api.mdx +++ b/docs/api/beta/forward-work-item.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Forward a Work Item

    @@ -32,7 +30,7 @@ This API forwards a work item to a new owner. Either an admin, or the owning/cur ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    Success, but no data is returned. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/generate-digit-token.api.mdx b/docs/api/beta/generate-digit-token.api.mdx index 4a6b20fef..ce272e728 100644 --- a/docs/api/beta/generate-digit-token.api.mdx +++ b/docs/api/beta/generate-digit-token.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Generate a digit token

    @@ -32,7 +30,7 @@ This API is used to generate a digit token for password management. Requires aut ## Request -

    Body

    required
    +

    Body

    required
    The digit token for password management. @@ -60,7 +58,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -72,4 +70,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/generate-identity-preview.api.mdx b/docs/api/beta/generate-identity-preview.api.mdx index 38dcb4ad8..46f2c0b83 100644 --- a/docs/api/beta/generate-identity-preview.api.mdx +++ b/docs/api/beta/generate-identity-preview.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Generate Identity Profile Preview

    @@ -45,7 +43,7 @@ The seaspray transformation definition Arbitrary key-value pairs to store any metadata for the object -
  • ]
    • +
  • ]
    • Object representing the preview object with all of the identity attributes using the current mappings. @@ -85,7 +83,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -101,4 +99,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-access-profile-entitlements.api.mdx b/docs/api/beta/get-access-profile-entitlements.api.mdx index fe9b62873..4a5635d40 100644 --- a/docs/api/beta/get-access-profile-entitlements.api.mdx +++ b/docs/api/beta/get-access-profile-entitlements.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Access Profile's Entitlements

    @@ -34,7 +32,7 @@ A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is requi ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    List of Entitlements @@ -78,7 +76,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -94,4 +92,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-access-profile.api.mdx b/docs/api/beta/get-access-profile.api.mdx index c43b14ea3..999e2ced6 100644 --- a/docs/api/beta/get-access-profile.api.mdx +++ b/docs/api/beta/get-access-profile.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get an Access Profile

    @@ -34,7 +32,7 @@ A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_ ## Request -

    Path Parameters

    +

    Path Parameters

    An AccessProfile @@ -102,7 +100,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -118,4 +116,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-access-request-approval-summary.api.mdx b/docs/api/beta/get-access-request-approval-summary.api.mdx index 3a9b69b0a..ee2f57382 100644 --- a/docs/api/beta/get-access-request-approval-summary.api.mdx +++ b/docs/api/beta/get-access-request-approval-summary.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get the number of pending, approved and rejected access requests approvals

    @@ -32,7 +30,7 @@ This endpoint returns the number of pending, approved and rejected access reques ## Request -

    Query Parameters

    +

    Query Parameters

    Number of pending, approved, rejected access request approvals. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-access-request-config.api.mdx b/docs/api/beta/get-access-request-config.api.mdx index 69f2c3d91..2ab26da84 100644 --- a/docs/api/beta/get-access-request-config.api.mdx +++ b/docs/api/beta/get-access-request-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Access Request Configuration

    @@ -32,7 +30,7 @@ This endpoint returns the current access-request configuration. ## Request -
    +
    Access Request Configuration Details. @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-access-request-identity-metrics.api.mdx b/docs/api/beta/get-access-request-identity-metrics.api.mdx index cdaf1c214..650699564 100644 --- a/docs/api/beta/get-access-request-identity-metrics.api.mdx +++ b/docs/api/beta/get-access-request-identity-metrics.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Return access request identity metrics

    @@ -32,7 +30,7 @@ Use this API to return information access metrics. ## Request -

    Path Parameters

    +

    Path Parameters

    Summary of the resource access and source activity for the direct reports of the provided manager. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-access-request-recommendations-ignored-items.api.mdx b/docs/api/beta/get-access-request-recommendations-ignored-items.api.mdx index a3cdd3501..ba1c89c13 100644 --- a/docs/api/beta/get-access-request-recommendations-ignored-items.api.mdx +++ b/docs/api/beta/get-access-request-recommendations-ignored-items.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List of Ignored Access Request Recommendations

    @@ -32,7 +30,7 @@ This API returns the list of ignored access request recommendations. ## Request -

    Query Parameters

    +

    Query Parameters

    Returns list of ignored access request recommendations. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-access-request-recommendations-requested-items.api.mdx b/docs/api/beta/get-access-request-recommendations-requested-items.api.mdx index cb13e0a21..c1dde2997 100644 --- a/docs/api/beta/get-access-request-recommendations-requested-items.api.mdx +++ b/docs/api/beta/get-access-request-recommendations-requested-items.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List of Requested Access Request Recommendations

    @@ -32,7 +30,7 @@ This API returns a list of requested access request recommendations. ## Request -

    Query Parameters

    +

    Query Parameters

    Returns the list of requested access request recommendations. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-access-request-recommendations-viewed-items.api.mdx b/docs/api/beta/get-access-request-recommendations-viewed-items.api.mdx index 23c152100..cb74d9adb 100644 --- a/docs/api/beta/get-access-request-recommendations-viewed-items.api.mdx +++ b/docs/api/beta/get-access-request-recommendations-viewed-items.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List of Viewed Access Request Recommendations

    @@ -32,7 +30,7 @@ This API returns the list of viewed access request recommendations. ## Request -

    Query Parameters

    +

    Query Parameters

    Returns list of viewed access request recommendations. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-access-request-recommendations.api.mdx b/docs/api/beta/get-access-request-recommendations.api.mdx index d92a3a310..04329ae2c 100644 --- a/docs/api/beta/get-access-request-recommendations.api.mdx +++ b/docs/api/beta/get-access-request-recommendations.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Identity Access Request Recommendations

    @@ -32,7 +30,7 @@ This API returns the access request recommendations for the specified identity. ## Request -

    Query Parameters

    +

    Query Parameters

    List of access request recommendations for the identityId @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-account-activity.api.mdx b/docs/api/beta/get-account-activity.api.mdx index 50cf93767..535dceb58 100644 --- a/docs/api/beta/get-account-activity.api.mdx +++ b/docs/api/beta/get-account-activity.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Account Activity

    @@ -32,7 +30,7 @@ This gets a single account activity by its id. ## Request -

    Path Parameters

    +

    Path Parameters

    An account activity object @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -88,7 +86,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -104,4 +102,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-account-aggregation-status.api.mdx b/docs/api/beta/get-account-aggregation-status.api.mdx index bdc688eba..935df5554 100644 --- a/docs/api/beta/get-account-aggregation-status.api.mdx +++ b/docs/api/beta/get-account-aggregation-status.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    In-progress Account Aggregation status

    @@ -40,7 +38,7 @@ A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN or DASHBOARD authority is ## Request -

    Path Parameters

    +

    Path Parameters

    An account aggregation status object @@ -60,7 +58,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -88,4 +86,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-account-entitlements.api.mdx b/docs/api/beta/get-account-entitlements.api.mdx index 9a0c255f5..71555341d 100644 --- a/docs/api/beta/get-account-entitlements.api.mdx +++ b/docs/api/beta/get-account-entitlements.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Account Entitlements

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    An array of account entitlements @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -89,7 +87,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -105,4 +103,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-account.api.mdx b/docs/api/beta/get-account.api.mdx index 29e9ac939..c995eca8c 100644 --- a/docs/api/beta/get-account.api.mdx +++ b/docs/api/beta/get-account.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Account Details

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    Account object. @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -89,7 +87,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -105,4 +103,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-active-campaigns.api.mdx b/docs/api/beta/get-active-campaigns.api.mdx index 00d0109f7..b25f96d63 100644 --- a/docs/api/beta/get-active-campaigns.api.mdx +++ b/docs/api/beta/get-active-campaigns.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Campaigns

    @@ -36,7 +34,7 @@ Gets campaigns and returns them in a list. Can provide increased level of detail ## Request -

    Query Parameters

    +

    Query Parameters

    A list of campaign objects. By default list of SLIM campaigns is returned. @@ -116,7 +114,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -132,4 +130,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-all-potential-role-summaries.api.mdx b/docs/api/beta/get-all-potential-role-summaries.api.mdx index 05efe16cc..36deb79c8 100644 --- a/docs/api/beta/get-all-potential-role-summaries.api.mdx +++ b/docs/api/beta/get-all-potential-role-summaries.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Retrieves all potential role summaries

    @@ -32,7 +30,7 @@ Returns all potential role summaries that match the query parameters ## Request -

    Query Parameters

    +

    Query Parameters

    Succeeded. Returns all potential role summaries that match the query parameters. @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-campaign-reports-config.api.mdx b/docs/api/beta/get-campaign-reports-config.api.mdx index eab99d8c9..63c2aadd4 100644 --- a/docs/api/beta/get-campaign-reports-config.api.mdx +++ b/docs/api/beta/get-campaign-reports-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Campaign Reports Configuration

    @@ -37,7 +35,7 @@ Requires roles of CERT_ADMIN and ORG_ADMIN. ## Request -
    +
    Campaign Report Configuration @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -85,4 +83,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-campaign-reports.api.mdx b/docs/api/beta/get-campaign-reports.api.mdx index 9d25ac6fd..c2efecb92 100644 --- a/docs/api/beta/get-campaign-reports.api.mdx +++ b/docs/api/beta/get-campaign-reports.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Campaign Reports

    @@ -37,7 +35,7 @@ Requires roles of CERT_ADMIN, DASHBOARD, ORG_ADMIN and REPORT_ADMIN ## Request -

    Path Parameters

    +

    Path Parameters

    Array of campaign report objects. @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -81,7 +79,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -97,4 +95,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-campaign-template-schedule.api.mdx b/docs/api/beta/get-campaign-template-schedule.api.mdx index fb2013f8c..6ee1f32ea 100644 --- a/docs/api/beta/get-campaign-template-schedule.api.mdx +++ b/docs/api/beta/get-campaign-template-schedule.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Gets a Campaign Template's Schedule

    @@ -36,7 +34,7 @@ Gets the schedule for a campaign template. Returns a 404 if there is no schedule ## Request -

    Path Parameters

    +

    Path Parameters

    The current schedule for the campaign template. See the PUT endpoint documentation for more examples. @@ -140,7 +138,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -152,7 +150,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -168,4 +166,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-campaign-template.api.mdx b/docs/api/beta/get-campaign-template.api.mdx index 866505446..8fcb40294 100644 --- a/docs/api/beta/get-campaign-template.api.mdx +++ b/docs/api/beta/get-campaign-template.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get a Campaign Template

    @@ -36,7 +34,7 @@ Fetches a campaign template by ID. ## Request -

    Path Parameters

    +

    Path Parameters

    The data for the campaign matching the given ID. @@ -116,7 +114,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -128,7 +126,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -144,4 +142,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-campaign.api.mdx b/docs/api/beta/get-campaign.api.mdx index 8dbd1a242..39e093d7a 100644 --- a/docs/api/beta/get-campaign.api.mdx +++ b/docs/api/beta/get-campaign.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get a campaign

    @@ -36,7 +34,7 @@ Retrieves information for an existing campaign using the campaign's ID. Authoriz ## Request -

    Path Parameters

    +

    Path Parameters

    A campaign object @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -84,7 +82,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -100,4 +98,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-client-log-configuration.api.mdx b/docs/api/beta/get-client-log-configuration.api.mdx index 4df25ac67..a3225bb3d 100644 --- a/docs/api/beta/get-client-log-configuration.api.mdx +++ b/docs/api/beta/get-client-log-configuration.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get managed cluster's log configuration

    @@ -32,7 +30,7 @@ Get managed cluster's log configuration. ## Request -

    Path Parameters

    +

    Path Parameters

    Log configuration of ManagedCluster matching given cluster ID @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-common-access.api.mdx b/docs/api/beta/get-common-access.api.mdx index 89832ed42..829eed304 100644 --- a/docs/api/beta/get-common-access.api.mdx +++ b/docs/api/beta/get-common-access.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get a paginated list of common access

    @@ -32,7 +30,7 @@ This endpoint returns the current common access for a customer. The returned ite ## Request -

    Query Parameters

    +

    Query Parameters

    Succeeded. Returns a list of common access for a customer. @@ -40,7 +38,7 @@ Succeeded. Returns a list of common access for a customer. common access item -
  • ]
    • +
  • ]
    • Client Error - Returned if the request body is invalid. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-completed-work-items.api.mdx b/docs/api/beta/get-completed-work-items.api.mdx index 287a8379c..da071c94b 100644 --- a/docs/api/beta/get-completed-work-items.api.mdx +++ b/docs/api/beta/get-completed-work-items.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Completed Work Items

    @@ -32,7 +30,7 @@ This gets a collection of completed work items belonging to either the specified ## Request -

    Query Parameters

    +

    Query Parameters

    List of completed work items. @@ -60,7 +58,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -72,4 +70,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 404 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-connector-list.api.mdx b/docs/api/beta/get-connector-list.api.mdx index 72e66f9db..db5dfc6c6 100644 --- a/docs/api/beta/get-connector-list.api.mdx +++ b/docs/api/beta/get-connector-list.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Gets connector list

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Query Parameters

    +

    Query Parameters

    A Connector Dto object @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-connector-rule-list.api.mdx b/docs/api/beta/get-connector-rule-list.api.mdx index bfa3ac1ee..96ef1ca8f 100644 --- a/docs/api/beta/get-connector-rule-list.api.mdx +++ b/docs/api/beta/get-connector-rule-list.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Connector Rules

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -
    +
    A list of connector rules @@ -73,7 +71,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -89,4 +87,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-connector-rule.api.mdx b/docs/api/beta/get-connector-rule.api.mdx index 0d62ea60a..9d568bf62 100644 --- a/docs/api/beta/get-connector-rule.api.mdx +++ b/docs/api/beta/get-connector-rule.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Connector-Rule by ID

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    Connector rule with the given ID @@ -73,7 +71,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -85,7 +83,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -101,4 +99,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-count-completed-work-items.api.mdx b/docs/api/beta/get-count-completed-work-items.api.mdx index 68a74c1ef..f4c82a982 100644 --- a/docs/api/beta/get-count-completed-work-items.api.mdx +++ b/docs/api/beta/get-count-completed-work-items.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Count Completed Work Items

    @@ -32,7 +30,7 @@ This gets a count of completed work items belonging to either the specified user ## Request -

    Query Parameters

    +

    Query Parameters

    List of work items @@ -60,7 +58,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -72,4 +70,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 404 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-count-work-items.api.mdx b/docs/api/beta/get-count-work-items.api.mdx index 4111b7aac..7847c6c4a 100644 --- a/docs/api/beta/get-count-work-items.api.mdx +++ b/docs/api/beta/get-count-work-items.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Count Work Items

    @@ -32,7 +30,7 @@ This gets a count of work items belonging to either the specified user(admin req ## Request -

    Query Parameters

    +

    Query Parameters

    List of work items @@ -60,7 +58,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -72,4 +70,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 404 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-custom-password-instructions.api.mdx b/docs/api/beta/get-custom-password-instructions.api.mdx index b3b8bbec9..19ae51ba1 100644 --- a/docs/api/beta/get-custom-password-instructions.api.mdx +++ b/docs/api/beta/get-custom-password-instructions.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Custom Password Instructions by Page ID

    @@ -32,7 +30,7 @@ This API returns the custom password instructions for the specified page ID. A t ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Reference to the custom password instructions. @@ -60,7 +58,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-custom-violation-report.api.mdx b/docs/api/beta/get-custom-violation-report.api.mdx index f2a58aad2..4bc1fdd7d 100644 --- a/docs/api/beta/get-custom-violation-report.api.mdx +++ b/docs/api/beta/get-custom-violation-report.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Download custom violation report

    @@ -37,7 +35,7 @@ Requires role of ORG_ADMIN. ## Request -

    Path Parameters

    +

    Path Parameters

    Returns the zip file with given custom name that contains the violation report file. @@ -73,7 +71,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -85,7 +83,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -101,4 +99,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-default-identity-attribute-config.api.mdx b/docs/api/beta/get-default-identity-attribute-config.api.mdx index c86c127f3..5e87bc91b 100644 --- a/docs/api/beta/get-default-identity-attribute-config.api.mdx +++ b/docs/api/beta/get-default-identity-attribute-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Default identity attribute config

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API to get the default ## Request -

    Path Parameters

    +

    Path Parameters

    An Identity Attribute Config object @@ -73,7 +71,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -85,7 +83,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -101,4 +99,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-default-violation-report.api.mdx b/docs/api/beta/get-default-violation-report.api.mdx index de3c94dd1..1ddf1e8a7 100644 --- a/docs/api/beta/get-default-violation-report.api.mdx +++ b/docs/api/beta/get-default-violation-report.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Download violation report

    @@ -37,7 +35,7 @@ Requires role of ORG_ADMIN. ## Request -

    Path Parameters

    +

    Path Parameters

    Returns the PolicyReport.zip that contains the violation report file. @@ -73,7 +71,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -85,7 +83,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -101,4 +99,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-dkim-attributes.api.mdx b/docs/api/beta/get-dkim-attributes.api.mdx index ce43d869c..7d0656085 100644 --- a/docs/api/beta/get-dkim-attributes.api.mdx +++ b/docs/api/beta/get-dkim-attributes.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get DKIM Attributes

    @@ -32,7 +30,7 @@ Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants' AWS ## Request -
    +
    List of DKIM Attributes @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-entitlement-changes-identities.api.mdx b/docs/api/beta/get-entitlement-changes-identities.api.mdx index 31272ba5e..d21b27e5d 100644 --- a/docs/api/beta/get-entitlement-changes-identities.api.mdx +++ b/docs/api/beta/get-entitlement-changes-identities.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get identities for a suggested entitlement (for a role)

    @@ -32,7 +30,7 @@ Role insights suggests entitlements to be added for a role. This endpoint return ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Succeeded. Returns a list of identities with or without the entitlement. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -76,4 +74,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-entitlement-distribution-potential-role.api.mdx b/docs/api/beta/get-entitlement-distribution-potential-role.api.mdx index 550026311..8ec16adf3 100644 --- a/docs/api/beta/get-entitlement-distribution-potential-role.api.mdx +++ b/docs/api/beta/get-entitlement-distribution-potential-role.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Retrieves entitlement popularity distribution for a potential role in a role mining session

    @@ -32,7 +30,7 @@ This method returns entitlement popularity distribution for a potential role in ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Succeeded. Returns a map containing entitlement popularity distribution for a potential role. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -76,4 +74,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-entitlement-request-config.api.mdx b/docs/api/beta/get-entitlement-request-config.api.mdx index 22463db2a..00bd5642e 100644 --- a/docs/api/beta/get-entitlement-request-config.api.mdx +++ b/docs/api/beta/get-entitlement-request-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Entitlement Request Config

    @@ -32,7 +30,7 @@ This API returns the entitlement request config for a specified entitlement. ## Request -

    Path Parameters

    +

    Path Parameters

    An Entitlement Request Config @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-entitlement.api.mdx b/docs/api/beta/get-entitlement.api.mdx index 926e706c9..eeb4d4da5 100644 --- a/docs/api/beta/get-entitlement.api.mdx +++ b/docs/api/beta/get-entitlement.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get an entitlement

    @@ -32,7 +30,7 @@ This API returns an entitlement by its ID. ## Request -

    Path Parameters

    +

    Path Parameters

    An entitlement @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -88,7 +86,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -104,4 +102,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-entitlements-potential-role.api.mdx b/docs/api/beta/get-entitlements-potential-role.api.mdx index 97540043c..ee5eb1807 100644 --- a/docs/api/beta/get-entitlements-potential-role.api.mdx +++ b/docs/api/beta/get-entitlements-potential-role.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Retrieves entitlements for a potential role in a role mining session

    @@ -32,7 +30,7 @@ This method returns entitlements for a potential role in a role mining session. ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Succeeded. Returns a list of entitlements for a potential role. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-evaluate-reassignment-configuration.api.mdx b/docs/api/beta/get-evaluate-reassignment-configuration.api.mdx index 573c91397..4e0ae9b9e 100644 --- a/docs/api/beta/get-evaluate-reassignment-configuration.api.mdx +++ b/docs/api/beta/get-evaluate-reassignment-configuration.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Evaluate Reassignment Configuration

    @@ -32,7 +30,7 @@ Evaluates the Reassignment Configuration for an `Identity` to determine if work ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Evaluated Reassignment Configuration @@ -40,7 +38,7 @@ Evaluated Reassignment Configuration List of Reassignments found by looking up the next `TargetIdentity` in a ReassignmentConfiguration -
  • Array [
  • ]
  • ]
    • Evaluate response when no Reassignment Configuration is found Evaluate response when a long Reassignment trail is found Evaluate response when a self-review is found and manager or org admin escalation is applied
    +
  • Array [
  • ]
  • ]

    • Evaluate response when no Reassignment Configuration is found

    Evaluate response when a long Reassignment trail is found

    Evaluate response when a self-review is found and manager or org admin escalation is applied

    Client Error - Returned if the request body is invalid. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-excluded-entitlements-potential-role.api.mdx b/docs/api/beta/get-excluded-entitlements-potential-role.api.mdx index 4d8a6b56d..8a0c9f639 100644 --- a/docs/api/beta/get-excluded-entitlements-potential-role.api.mdx +++ b/docs/api/beta/get-excluded-entitlements-potential-role.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Retrieves excluded entitlements for a potential role in a role mining session

    @@ -32,7 +30,7 @@ This method returns excluded entitlements for a potential role in a role mining ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Succeeded. Returns a list of excluded entitlements for a potential roles. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-file-from-s-3.api.mdx b/docs/api/beta/get-file-from-s-3.api.mdx index b6dd6d5de..93a01aafc 100644 --- a/docs/api/beta/get-file-from-s-3.api.mdx +++ b/docs/api/beta/get-file-from-s-3.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Download definition file by fileId.

    @@ -32,7 +30,7 @@ Download definition file by fileId. ## Request -

    Path Parameters

    +

    Path Parameters

    Returns a file that is referred to by fileID and associated with the formDefinitionID diff --git a/docs/api/beta/get-form-definition-by-key.api.mdx b/docs/api/beta/get-form-definition-by-key.api.mdx index c1ddfbb6a..5d4f2d1f3 100644 --- a/docs/api/beta/get-form-definition-by-key.api.mdx +++ b/docs/api/beta/get-form-definition-by-key.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Return a form definition.

    @@ -32,7 +30,7 @@ Parameter `{formDefinitionID}` should match a form definition ID. ## Request -

    Path Parameters

    +

    Path Parameters

    Returns a form definition diff --git a/docs/api/beta/get-form-instance-by-key.api.mdx b/docs/api/beta/get-form-instance-by-key.api.mdx index c6940afbc..b752fd2aa 100644 --- a/docs/api/beta/get-form-instance-by-key.api.mdx +++ b/docs/api/beta/get-form-instance-by-key.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns a form instance.

    @@ -32,7 +30,7 @@ Parameter `{formInstanceID}` should match a form instance ID. ## Request -

    Path Parameters

    +

    Path Parameters

    Returns a form instance by its key diff --git a/docs/api/beta/get-form-instance-file.api.mdx b/docs/api/beta/get-form-instance-file.api.mdx index 6138bcdcb..35a894351 100644 --- a/docs/api/beta/get-form-instance-file.api.mdx +++ b/docs/api/beta/get-form-instance-file.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Download instance file by fileId.

    @@ -32,7 +30,7 @@ Download instance file by fileId. ## Request -

    Path Parameters

    +

    Path Parameters

    Returns a file that is referred to by fileID and associated with the formInstanceID diff --git a/docs/api/beta/get-historical-identity-events.api.mdx b/docs/api/beta/get-historical-identity-events.api.mdx index 795cd30fb..1e4dc9e2e 100644 --- a/docs/api/beta/get-historical-identity-events.api.mdx +++ b/docs/api/beta/get-historical-identity-events.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Lists all events for the given identity

    @@ -32,7 +30,7 @@ This method retrieves all access events for the identity Requires authorization ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    The list of events for the identity @@ -104,7 +102,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -116,7 +114,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -132,4 +130,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/beta/get-historical-identity.api.mdx b/docs/api/beta/get-historical-identity.api.mdx index dc5f213a6..c78ca1713 100644 --- a/docs/api/beta/get-historical-identity.api.mdx +++ b/docs/api/beta/get-historical-identity.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get latest snapshot of identity

    @@ -32,7 +30,7 @@ This method retrieves a specified identity Requires authorization scope of 'idn: ## Request -

    Path Parameters

    +

    Path Parameters

    The identity object. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -88,4 +86,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/beta/get-identities-potential-role.api.mdx b/docs/api/beta/get-identities-potential-role.api.mdx index 02fae86ef..9ee3d0ff9 100644 --- a/docs/api/beta/get-identities-potential-role.api.mdx +++ b/docs/api/beta/get-identities-potential-role.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Retrieves identities for a potential role in a role mining session

    @@ -32,7 +30,7 @@ This method returns identities for a potential role in a role mining session. ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Succeeded. Returns a list of identities for a potential role. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -76,4 +74,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-identity-attribute.api.mdx b/docs/api/beta/get-identity-attribute.api.mdx index 9b728520a..35f5e06e0 100644 --- a/docs/api/beta/get-identity-attribute.api.mdx +++ b/docs/api/beta/get-identity-attribute.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Identity Attribute

    @@ -32,7 +30,7 @@ This gets an identity attribute for a given technical name. ## Request -

    Path Parameters

    +

    Path Parameters

    The identity attribute with the given name @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-identity-certification-item-permissions.api.mdx b/docs/api/beta/get-identity-certification-item-permissions.api.mdx index 0fc22980a..8d207ee77 100644 --- a/docs/api/beta/get-identity-certification-item-permissions.api.mdx +++ b/docs/api/beta/get-identity-certification-item-permissions.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Permissions for Entitlement Certification Item

    @@ -36,7 +34,7 @@ This API returns the permissions associated with an entitlement certification it ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    A list of permissions associated with the given itemId @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-identity-certification-pending-tasks.api.mdx b/docs/api/beta/get-identity-certification-pending-tasks.api.mdx index 963b2840d..a841401b1 100644 --- a/docs/api/beta/get-identity-certification-pending-tasks.api.mdx +++ b/docs/api/beta/get-identity-certification-pending-tasks.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Pending Certification Tasks

    @@ -32,7 +30,7 @@ This API returns the status of all pending (`QUEUED` or `IN_PROGRESS`) tasks for ## Request -

    Path Parameters

    +

    Path Parameters

    A list of pending (`QUEUED` or `IN_PROGRESS`) certification task objects. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-identity-certification-task-status.api.mdx b/docs/api/beta/get-identity-certification-task-status.api.mdx index 3191d2e4a..c253ff8b4 100644 --- a/docs/api/beta/get-identity-certification-task-status.api.mdx +++ b/docs/api/beta/get-identity-certification-task-status.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Certification Task Status

    @@ -32,7 +30,7 @@ This API returns the status of a certification task. A token with ORG_ADMIN or C ## Request -

    Path Parameters

    +

    Path Parameters

    A certification task object. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-identity-outlier-snapshots.api.mdx b/docs/api/beta/get-identity-outlier-snapshots.api.mdx index 1b28fd00e..f2042f53a 100644 --- a/docs/api/beta/get-identity-outlier-snapshots.api.mdx +++ b/docs/api/beta/get-identity-outlier-snapshots.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    IAI Identity Outliers Summary

    @@ -33,7 +31,7 @@ Requires authorization scope of 'iai:outliers-management:read' ## Request -

    Query Parameters

    +

    Query Parameters

    Succeeded. Returns list of objects. Each object is a summary to give high level statistics/counts of outliers @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-identity-outliers.api.mdx b/docs/api/beta/get-identity-outliers.api.mdx index 07737b78f..221a882cf 100644 --- a/docs/api/beta/get-identity-outliers.api.mdx +++ b/docs/api/beta/get-identity-outliers.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    IAI Get Identity Outliers

    @@ -33,7 +31,7 @@ Requires authorization scope of 'iai:outliers-management:read' ## Request -

    Query Parameters

    +

    Query Parameters

    Succeeded. Returns list of objects. Each object contains information about outliers @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -85,4 +83,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-identity-ownership-details.api.mdx b/docs/api/beta/get-identity-ownership-details.api.mdx index fd35a76f0..f3c6a6ac8 100644 --- a/docs/api/beta/get-identity-ownership-details.api.mdx +++ b/docs/api/beta/get-identity-ownership-details.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get ownership details

    @@ -32,7 +30,7 @@ Get Ownership association details of an Identity ## Request -

    Path Parameters

    +

    Path Parameters

    Ownership association details of an Identity. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -84,7 +82,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -100,4 +98,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-identity-password-change-status.api.mdx b/docs/api/beta/get-identity-password-change-status.api.mdx index 993b27456..3a5e11978 100644 --- a/docs/api/beta/get-identity-password-change-status.api.mdx +++ b/docs/api/beta/get-identity-password-change-status.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Password Change Request Status

    @@ -32,7 +30,7 @@ This API returns the status of a password change request. A token with identity ## Request -

    Path Parameters

    +

    Path Parameters

    Status of the password change request @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -88,4 +86,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-identity-profile.api.mdx b/docs/api/beta/get-identity-profile.api.mdx index 0a36001e3..dde961eaa 100644 --- a/docs/api/beta/get-identity-profile.api.mdx +++ b/docs/api/beta/get-identity-profile.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Gets a single Identity Profile

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN or API authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    An Identity Profile object @@ -81,7 +79,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -93,7 +91,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -109,4 +107,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-identity-snapshot-summary.api.mdx b/docs/api/beta/get-identity-snapshot-summary.api.mdx index 3d3a917c0..b244424ee 100644 --- a/docs/api/beta/get-identity-snapshot-summary.api.mdx +++ b/docs/api/beta/get-identity-snapshot-summary.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Gets the summary for the event count for a specific identity

    @@ -32,7 +30,7 @@ This method gets the summary for the event count for a specific identity by mont ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    A summary list of identity changes in date histogram format. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -88,4 +86,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-identity-snapshot.api.mdx b/docs/api/beta/get-identity-snapshot.api.mdx index c6927d63e..0e5322d81 100644 --- a/docs/api/beta/get-identity-snapshot.api.mdx +++ b/docs/api/beta/get-identity-snapshot.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Gets an identity snapshot at a given date

    @@ -32,7 +30,7 @@ This method retrieves a specified identity snapshot at a given date Requires aut ## Request -

    Path Parameters

    +

    Path Parameters

    The identity object. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -84,7 +82,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-identity-start-date.api.mdx b/docs/api/beta/get-identity-start-date.api.mdx index 1e4b67d8d..c3e71cf39 100644 --- a/docs/api/beta/get-identity-start-date.api.mdx +++ b/docs/api/beta/get-identity-start-date.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Gets the start date of the identity

    @@ -32,7 +30,7 @@ This method retrieves start date of the identity Requires authorization scope of ## Request -

    Path Parameters

    +

    Path Parameters

    The start date of the identity @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-identity.api.mdx b/docs/api/beta/get-identity.api.mdx index f592862a0..74e50fd04 100644 --- a/docs/api/beta/get-identity.api.mdx +++ b/docs/api/beta/get-identity.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Identity Details

    @@ -32,7 +30,7 @@ This API returns a single identity using the Identity ID. ## Request -

    Path Parameters

    +

    Path Parameters

    An identity object @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -84,7 +82,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -100,4 +98,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-latest-identity-outlier-snapshots.api.mdx b/docs/api/beta/get-latest-identity-outlier-snapshots.api.mdx index 55846702d..854d5f02f 100644 --- a/docs/api/beta/get-latest-identity-outlier-snapshots.api.mdx +++ b/docs/api/beta/get-latest-identity-outlier-snapshots.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    IAI Identity Outliers Latest Summary

    @@ -33,7 +31,7 @@ Requires authorization scope of 'iai:outliers-management:read' ## Request -

    Query Parameters

    +

    Query Parameters

    Succeeded. Returns list of objects. Each object is a summary to give high level statistics/counts of outliers @@ -73,7 +71,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -89,4 +87,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-mail-from-attributes.api.mdx b/docs/api/beta/get-mail-from-attributes.api.mdx index 60bd82c86..d14ce599b 100644 --- a/docs/api/beta/get-mail-from-attributes.api.mdx +++ b/docs/api/beta/get-mail-from-attributes.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get MAIL FROM Attributes

    @@ -32,7 +30,7 @@ Retrieve MAIL FROM attributes for a given AWS SES identity. ## Request -

    Query Parameters

    +

    Query Parameters

    MAIL FROM Attributes object @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-managed-client-status.api.mdx b/docs/api/beta/get-managed-client-status.api.mdx index 6488615e6..2c947161e 100644 --- a/docs/api/beta/get-managed-client-status.api.mdx +++ b/docs/api/beta/get-managed-client-status.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Specified Managed Client Status.

    @@ -32,7 +30,7 @@ Retrieve Managed Client Status by ID. ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Responds with Managed Client Status having the given ID and Type. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-managed-cluster.api.mdx b/docs/api/beta/get-managed-cluster.api.mdx index 89dffe55e..37949b849 100644 --- a/docs/api/beta/get-managed-cluster.api.mdx +++ b/docs/api/beta/get-managed-cluster.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get a specified ManagedCluster.

    @@ -32,7 +30,7 @@ Retrieve a ManagedCluster by ID. ## Request -

    Path Parameters

    +

    Path Parameters

    Responds with ManagedCluster having the given ID. @@ -92,7 +90,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -104,7 +102,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -120,4 +118,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-managed-clusters.api.mdx b/docs/api/beta/get-managed-clusters.api.mdx index 1ee6b90cb..7046d00cf 100644 --- a/docs/api/beta/get-managed-clusters.api.mdx +++ b/docs/api/beta/get-managed-clusters.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Retrieve all Managed Clusters.

    @@ -32,7 +30,7 @@ Retrieve all Managed Clusters for the current Org, based on request context. ## Request -

    Query Parameters

    +

    Query Parameters

    Responds with a list of ManagedCluster. @@ -92,7 +90,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -108,4 +106,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-message-catalogs.api.mdx b/docs/api/beta/get-message-catalogs.api.mdx index ab4cef034..e3d63afac 100644 --- a/docs/api/beta/get-message-catalogs.api.mdx +++ b/docs/api/beta/get-message-catalogs.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Message catalogs

    @@ -32,7 +30,7 @@ The getMessageCatalogs API returns message catalog based on the language headers ## Request -

    Path Parameters

    +

    Path Parameters

    The message catalogs based on the request headers @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-mfa-duo-config.api.mdx b/docs/api/beta/get-mfa-duo-config.api.mdx index 6e7ff41dc..892982eac 100644 --- a/docs/api/beta/get-mfa-duo-config.api.mdx +++ b/docs/api/beta/get-mfa-duo-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Configuration of Duo MFA method

    @@ -32,7 +30,7 @@ This API returns the configuration of an Duo MFA method. A token with ORG_ADMIN ## Request -
    +
    The configuration of an Duo MFA method. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-mfa-okta-config.api.mdx b/docs/api/beta/get-mfa-okta-config.api.mdx index a43355d30..0d71804c4 100644 --- a/docs/api/beta/get-mfa-okta-config.api.mdx +++ b/docs/api/beta/get-mfa-okta-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Configuration of Okta MFA method

    @@ -32,7 +30,7 @@ This API returns the configuration of an Okta MFA method. A token with ORG_ADMIN ## Request -
    +
    The configuration of an Okta MFA method. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-native-change-detection-config.api.mdx b/docs/api/beta/get-native-change-detection-config.api.mdx index fdedb2d6c..a30790770 100644 --- a/docs/api/beta/get-native-change-detection-config.api.mdx +++ b/docs/api/beta/get-native-change-detection-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Native Change Detection Configuration

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    Native change detection configuration for a source @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-non-employee-approval-summary.api.mdx b/docs/api/beta/get-non-employee-approval-summary.api.mdx index 709a596ef..e31589898 100644 --- a/docs/api/beta/get-non-employee-approval-summary.api.mdx +++ b/docs/api/beta/get-non-employee-approval-summary.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Summary of Non-Employee Approval Requests

    @@ -32,7 +30,7 @@ This request will retrieve a summary of non-employee approval requests. There ar ## Request -

    Path Parameters

    +

    Path Parameters

    summary of non-employee approval requests @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-non-employee-approval.api.mdx b/docs/api/beta/get-non-employee-approval.api.mdx index cf8c81aa2..80cf69595 100644 --- a/docs/api/beta/get-non-employee-approval.api.mdx +++ b/docs/api/beta/get-non-employee-approval.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get a non-employee approval item detail

    @@ -32,7 +30,7 @@ Approves a non-employee approval request and notifies the next approver. ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Non-Employee approval item object. @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-non-employee-bulk-upload-status.api.mdx b/docs/api/beta/get-non-employee-bulk-upload-status.api.mdx index 474b1aad3..5c2d036eb 100644 --- a/docs/api/beta/get-non-employee-bulk-upload-status.api.mdx +++ b/docs/api/beta/get-non-employee-bulk-upload-status.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Bulk upload status on source

    @@ -33,7 +31,7 @@ The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload ## Request -

    Path Parameters

    +

    Path Parameters

    Status of the newest bulk-upload job, if any. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -81,4 +79,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-non-employee-record.api.mdx b/docs/api/beta/get-non-employee-record.api.mdx index 0de4d9207..7d2137a33 100644 --- a/docs/api/beta/get-non-employee-record.api.mdx +++ b/docs/api/beta/get-non-employee-record.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get a Non-Employee Record

    @@ -32,7 +30,7 @@ This gets a non-employee record. ## Request -

    Path Parameters

    +

    Path Parameters

    Non-Employee record object @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-non-employee-request-summary.api.mdx b/docs/api/beta/get-non-employee-request-summary.api.mdx index e78d700e9..5fd410ead 100644 --- a/docs/api/beta/get-non-employee-request-summary.api.mdx +++ b/docs/api/beta/get-non-employee-request-summary.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Summary of Non-Employee Requests

    @@ -32,7 +30,7 @@ This request will retrieve a summary of non-employee requests. There are two con ## Request -

    Path Parameters

    +

    Path Parameters

    Non-Employee request summary object. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-non-employee-request.api.mdx b/docs/api/beta/get-non-employee-request.api.mdx index 3332993cc..5732fc123 100644 --- a/docs/api/beta/get-non-employee-request.api.mdx +++ b/docs/api/beta/get-non-employee-request.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get a Non-Employee Request

    @@ -32,7 +30,7 @@ This gets a non-employee request. ## Request -

    Path Parameters

    +

    Path Parameters

    Non-Employee request object. @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -88,7 +86,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -104,4 +102,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-non-employee-schema-attribute.api.mdx b/docs/api/beta/get-non-employee-schema-attribute.api.mdx index be672bbf5..f26dfa384 100644 --- a/docs/api/beta/get-non-employee-schema-attribute.api.mdx +++ b/docs/api/beta/get-non-employee-schema-attribute.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Schema Attribute Non-Employee Source

    @@ -32,7 +30,7 @@ This API gets a schema attribute by Id for the specified Non-Employee SourceId. ## Request -

    Path Parameters

    +

    Path Parameters

    The Schema Attribute @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-non-employee-source-schema-attributes.api.mdx b/docs/api/beta/get-non-employee-source-schema-attributes.api.mdx index e352de9f4..c10e3b153 100644 --- a/docs/api/beta/get-non-employee-source-schema-attributes.api.mdx +++ b/docs/api/beta/get-non-employee-source-schema-attributes.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Schema Attributes Non-Employee Source

    @@ -32,7 +30,7 @@ This API gets the list of schema attributes for the specified Non-Employee Sourc ## Request -

    Path Parameters

    +

    Path Parameters

    A list of Schema Attributes @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-non-employee-source.api.mdx b/docs/api/beta/get-non-employee-source.api.mdx index e0e0c2b25..7b6a16775 100644 --- a/docs/api/beta/get-non-employee-source.api.mdx +++ b/docs/api/beta/get-non-employee-source.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get a Non-Employee Source

    @@ -32,7 +30,7 @@ This gets a non-employee source. ## Request -

    Path Parameters

    +

    Path Parameters

    Non-Employee source object. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -88,4 +86,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-notification-preference.api.mdx b/docs/api/beta/get-notification-preference.api.mdx index 7d016d278..60e4645b5 100644 --- a/docs/api/beta/get-notification-preference.api.mdx +++ b/docs/api/beta/get-notification-preference.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Notification Preferences for tenant.

    @@ -32,7 +30,7 @@ Returns the notification preferences for tenant. Note that if the key doesn't e ## Request -

    Path Parameters

    +

    Path Parameters

    Return preference for the given notification key. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-notification-template.api.mdx b/docs/api/beta/get-notification-template.api.mdx index 701f3eb8b..de06b52cd 100644 --- a/docs/api/beta/get-notification-template.api.mdx +++ b/docs/api/beta/get-notification-template.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Notification Template By Id

    @@ -32,7 +30,7 @@ This gets a template that you have modified for your site by Id. ## Request -

    Path Parameters

    +

    Path Parameters

    A template object for your site @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-notifications-template-context.api.mdx b/docs/api/beta/get-notifications-template-context.api.mdx index 409f520f7..1aac11c5b 100644 --- a/docs/api/beta/get-notifications-template-context.api.mdx +++ b/docs/api/beta/get-notifications-template-context.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Notification Template Context

    @@ -33,7 +31,7 @@ The notification service maintains metadata to construct the notification templa ## Request -
    +
    Notification template context attributes for a specific tenant. @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -85,4 +83,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-oauth-client.api.mdx b/docs/api/beta/get-oauth-client.api.mdx index 5373539b0..66adcc604 100644 --- a/docs/api/beta/get-oauth-client.api.mdx +++ b/docs/api/beta/get-oauth-client.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get OAuth Client

    @@ -32,7 +30,7 @@ This gets details of an OAuth client. ## Request -

    Path Parameters

    +

    Path Parameters

    Request succeeded. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-org-config.api.mdx b/docs/api/beta/get-org-config.api.mdx index 427d13c13..c9616b1b4 100644 --- a/docs/api/beta/get-org-config.api.mdx +++ b/docs/api/beta/get-org-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Org configuration settings

    @@ -32,7 +30,7 @@ Get org configuration with only external (org admin) accessible properties for t ## Request -
    +
    Request succeeded. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-outlier-contributing-feature-summary.api.mdx b/docs/api/beta/get-outlier-contributing-feature-summary.api.mdx index 3ab895971..ad25aabec 100644 --- a/docs/api/beta/get-outlier-contributing-feature-summary.api.mdx +++ b/docs/api/beta/get-outlier-contributing-feature-summary.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get identity outlier contibuting feature summary

    @@ -33,7 +31,7 @@ Requires authorization scope of 'iai:outliers-management:read' ## Request -

    Path Parameters

    +

    Path Parameters

    Succeeded. Returns selected contributing feature summary for an outlier @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -81,7 +79,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -97,4 +95,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-password-dictionary.api.mdx b/docs/api/beta/get-password-dictionary.api.mdx index e629129aa..66fb3ff37 100644 --- a/docs/api/beta/get-password-dictionary.api.mdx +++ b/docs/api/beta/get-password-dictionary.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Password Dictionary

    @@ -61,7 +59,7 @@ qazxsws ## Request -
    +
    A password dictionary response @@ -97,7 +95,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -109,7 +107,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -125,4 +123,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-password-org-config.api.mdx b/docs/api/beta/get-password-org-config.api.mdx index 75d455beb..41cc7415c 100644 --- a/docs/api/beta/get-password-org-config.api.mdx +++ b/docs/api/beta/get-password-org-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Password Org Config

    @@ -32,7 +30,7 @@ This API returns the password org config . Requires ORG_ADMIN, API role or autho ## Request -
    +
    Reference to the password org config. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-password-sync-group.api.mdx b/docs/api/beta/get-password-sync-group.api.mdx index 0df143ca4..a1df7b5ff 100644 --- a/docs/api/beta/get-password-sync-group.api.mdx +++ b/docs/api/beta/get-password-sync-group.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Password Sync Group by ID

    @@ -32,7 +30,7 @@ This API returns the sync group for the specified ID. A token with ORG_ADMIN aut ## Request -

    Path Parameters

    +

    Path Parameters

    Reference to the password sync group. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-password-sync-groups.api.mdx b/docs/api/beta/get-password-sync-groups.api.mdx index 29180f657..fa690ac73 100644 --- a/docs/api/beta/get-password-sync-groups.api.mdx +++ b/docs/api/beta/get-password-sync-groups.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Password Sync Group List

    @@ -32,7 +30,7 @@ This API returns a list of password sync groups. A token with ORG_ADMIN authorit ## Request -

    Query Parameters

    +

    Query Parameters

    A list of password sync groups. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-peer-group-outliers-contributing-features.api.mdx b/docs/api/beta/get-peer-group-outliers-contributing-features.api.mdx index 3d8fd4bcf..be87cf839 100644 --- a/docs/api/beta/get-peer-group-outliers-contributing-features.api.mdx +++ b/docs/api/beta/get-peer-group-outliers-contributing-features.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get identity outlier's contibuting features

    @@ -33,7 +31,7 @@ Requires authorization scope of 'iai:outliers-management:read' ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Succeeded. Returns list of objects. Each object contains a feature and metadata about that feature @@ -85,7 +83,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -97,7 +95,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -113,4 +111,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-peer-group-outliers.api.mdx b/docs/api/beta/get-peer-group-outliers.api.mdx index 35d30f985..69080865a 100644 --- a/docs/api/beta/get-peer-group-outliers.api.mdx +++ b/docs/api/beta/get-peer-group-outliers.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Identity Outliers List

    @@ -36,7 +34,7 @@ This endpoint has been deprecated and may be replaced or removed in future versi ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    List of identities that are not included in peer groups. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -88,4 +86,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-pending-task-headers.api.mdx b/docs/api/beta/get-pending-task-headers.api.mdx index da8ba50bd..ae58fb8cb 100644 --- a/docs/api/beta/get-pending-task-headers.api.mdx +++ b/docs/api/beta/get-pending-task-headers.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Retrieve headers only for pending task list.

    @@ -32,7 +30,7 @@ Retrieve headers for a list of TaskStatus for pending tasks. ## Request -

    Query Parameters

    +

    Query Parameters

    Responds with headers for List of TaskStatus for pending tasks. @@ -64,4 +62,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 403 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-pending-tasks.api.mdx b/docs/api/beta/get-pending-tasks.api.mdx index ec6dd28d7..c71a00cf3 100644 --- a/docs/api/beta/get-pending-tasks.api.mdx +++ b/docs/api/beta/get-pending-tasks.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Retrieve a pending task list.

    @@ -32,7 +30,7 @@ Retrieve a list of TaskStatus for pending tasks. ## Request -

    Query Parameters

    +

    Query Parameters

    Responds with a list of TaskStatus for pending tasks. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 403 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-potential-role-applications.api.mdx b/docs/api/beta/get-potential-role-applications.api.mdx index 867de9a8a..60c01af6a 100644 --- a/docs/api/beta/get-potential-role-applications.api.mdx +++ b/docs/api/beta/get-potential-role-applications.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Retrieves the applications of a potential role for a role mining session

    @@ -32,7 +30,7 @@ This method returns the applications of a potential role for a role mining sessi ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Succeeded. Returns a list of potential roles for a role mining session. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -76,4 +74,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-potential-role-source-identity-usage.api.mdx b/docs/api/beta/get-potential-role-source-identity-usage.api.mdx index 04b1ac3ca..1aaa14ce7 100644 --- a/docs/api/beta/get-potential-role-source-identity-usage.api.mdx +++ b/docs/api/beta/get-potential-role-source-identity-usage.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Retrieves potential role source usage

    @@ -32,7 +30,7 @@ This method returns source usageCount (as number of days in the last 90 days) fo ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Succeeded. Returns a list of source usage for the identities in a potential role. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-potential-role-summaries.api.mdx b/docs/api/beta/get-potential-role-summaries.api.mdx index d8c831bfc..c7f85dff0 100644 --- a/docs/api/beta/get-potential-role-summaries.api.mdx +++ b/docs/api/beta/get-potential-role-summaries.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Retrieves all potential role summaries

    @@ -32,7 +30,7 @@ This method returns the potential role summaries for a role mining session. ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Succeeded. Returns a list of potential role summaries for a role mining session. @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-potential-role.api.mdx b/docs/api/beta/get-potential-role.api.mdx index 972352560..f06b944b6 100644 --- a/docs/api/beta/get-potential-role.api.mdx +++ b/docs/api/beta/get-potential-role.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Retrieves a specific potential role

    @@ -32,7 +30,7 @@ This method returns a specific potential role for a role mining session. ## Request -

    Path Parameters

    +

    Path Parameters

    Succeeded. Returns a list of potential roles for a role mining session. @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-provisioning-policy.api.mdx b/docs/api/beta/get-provisioning-policy.api.mdx index 96afe90c4..bf3900048 100644 --- a/docs/api/beta/get-provisioning-policy.api.mdx +++ b/docs/api/beta/get-provisioning-policy.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Provisioning Policy by UsageType

    @@ -33,7 +31,7 @@ A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is requi ## Request -

    Path Parameters

    +

    Path Parameters

    The requested ProvisioningPolicyDto was successfully retrieved. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-public-identity-config.api.mdx b/docs/api/beta/get-public-identity-config.api.mdx index c1d0a54a2..8c707f3fb 100644 --- a/docs/api/beta/get-public-identity-config.api.mdx +++ b/docs/api/beta/get-public-identity-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Public Identity Config

    @@ -32,7 +30,7 @@ This gets details of public identity config. ## Request -
    +
    Request succeeded. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-reassignment-config-types.api.mdx b/docs/api/beta/get-reassignment-config-types.api.mdx index 3f2d5b5e6..d2eb417d4 100644 --- a/docs/api/beta/get-reassignment-config-types.api.mdx +++ b/docs/api/beta/get-reassignment-config-types.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Reassignment Config Types

    @@ -32,7 +30,7 @@ Gets a collection of types which are available in the Reassignment Configuration ## Request -
    +
    List of Reassignment Configuration Types @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-reassignment-configuration.api.mdx b/docs/api/beta/get-reassignment-configuration.api.mdx index e6ede3838..6d0a9cd1e 100644 --- a/docs/api/beta/get-reassignment-configuration.api.mdx +++ b/docs/api/beta/get-reassignment-configuration.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Reassignment Configuration

    @@ -32,7 +30,7 @@ Gets the Reassignment Configuration for an identity. ## Request -

    Path Parameters

    +

    Path Parameters

    Reassignment Configuration for an identity @@ -88,7 +86,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -100,7 +98,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -116,4 +114,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-recommendations-config.api.mdx b/docs/api/beta/get-recommendations-config.api.mdx index 82603785b..af8c89c5b 100644 --- a/docs/api/beta/get-recommendations-config.api.mdx +++ b/docs/api/beta/get-recommendations-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get certification recommendation config values

    @@ -32,7 +30,7 @@ Retrieves configuration attributes used by certification recommendations. ## Request -
    +
    Cert recommendation configuration attributes @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -76,4 +74,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-recommendations.api.mdx b/docs/api/beta/get-recommendations.api.mdx index a1c739cdd..1065c75a5 100644 --- a/docs/api/beta/get-recommendations.api.mdx +++ b/docs/api/beta/get-recommendations.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns a Recommendation Based on Object

    @@ -32,7 +30,7 @@ The getRecommendations API returns recommendations based on the requested object ## Request -

    Body

    required
      requests object[]
    • Array [
      • item object
    • ]
    +

    Body

    required
      requests object[]
    • Array [
      • item object
    • ]
    The recommendations for a customer @@ -84,7 +82,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -100,4 +98,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-role-assigned-identities.api.mdx b/docs/api/beta/get-role-assigned-identities.api.mdx index 28706864b..093e9e7ec 100644 --- a/docs/api/beta/get-role-assigned-identities.api.mdx +++ b/docs/api/beta/get-role-assigned-identities.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Identities assigned a Role

    @@ -32,7 +30,7 @@ Identities assigned a Role ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    List of Identities assigned the Role @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-role-entitlements.api.mdx b/docs/api/beta/get-role-entitlements.api.mdx index e149a1ae1..103066405 100644 --- a/docs/api/beta/get-role-entitlements.api.mdx +++ b/docs/api/beta/get-role-entitlements.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List role's Entitlements

    @@ -34,7 +32,7 @@ A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    List of Entitlements @@ -78,7 +76,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -94,4 +92,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-role-insight.api.mdx b/docs/api/beta/get-role-insight.api.mdx index 892eeab53..49cd98536 100644 --- a/docs/api/beta/get-role-insight.api.mdx +++ b/docs/api/beta/get-role-insight.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get a single role insight

    @@ -32,7 +30,7 @@ This endpoint gets role insights information for a role. ## Request -

    Path Parameters

    +

    Path Parameters

    Succeeded. Returns information about insights for a single role. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-role-insights-current-entitlements.api.mdx b/docs/api/beta/get-role-insights-current-entitlements.api.mdx index 7f3b7daa8..10e04014d 100644 --- a/docs/api/beta/get-role-insights-current-entitlements.api.mdx +++ b/docs/api/beta/get-role-insights-current-entitlements.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get current entitlement for a role

    @@ -32,7 +30,7 @@ This endpoint gets the entitlements for a role. The term "current" is to disting ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Succeeded. Returns a list of current or pre-existing entitlements for a role. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -76,4 +74,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-role-insights-entitlements-changes.api.mdx b/docs/api/beta/get-role-insights-entitlements-changes.api.mdx index 3df884ad1..9d571b5ee 100644 --- a/docs/api/beta/get-role-insights-entitlements-changes.api.mdx +++ b/docs/api/beta/get-role-insights-entitlements-changes.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get entitlement insights for a role

    @@ -32,7 +30,7 @@ This endpoint returns entitlement insights for a role. ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Succeeded. Returns a list of entitlements to be added for a role. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-role-insights-requests.api.mdx b/docs/api/beta/get-role-insights-requests.api.mdx index 4721b4519..9d6e7c6e1 100644 --- a/docs/api/beta/get-role-insights-requests.api.mdx +++ b/docs/api/beta/get-role-insights-requests.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns metadata from prior request.

    @@ -36,7 +34,7 @@ This endpoint returns details of a prior role insights request. ## Request -

    Path Parameters

    +

    Path Parameters

    Succeeded. Returns details of an earlier role insights request. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-role-insights-summary.api.mdx b/docs/api/beta/get-role-insights-summary.api.mdx index b182bf584..6576070c3 100644 --- a/docs/api/beta/get-role-insights-summary.api.mdx +++ b/docs/api/beta/get-role-insights-summary.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get role insights summary information

    @@ -32,7 +30,7 @@ This method returns high level summary information for role insights for a custo ## Request -
    +
    Succeeded. Returns high level counts. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -76,4 +74,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-role-insights.api.mdx b/docs/api/beta/get-role-insights.api.mdx index 6ace0fe21..e3bcb7510 100644 --- a/docs/api/beta/get-role-insights.api.mdx +++ b/docs/api/beta/get-role-insights.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get role insights

    @@ -32,7 +30,7 @@ This method returns detailed role insights for each role. ## Request -

    Query Parameters

    +

    Query Parameters

    Succeeded. Returns a list of roles with information about insights for each role. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-role-mining-potential-role.api.mdx b/docs/api/beta/get-role-mining-potential-role.api.mdx index 947f05e11..84bf029f6 100644 --- a/docs/api/beta/get-role-mining-potential-role.api.mdx +++ b/docs/api/beta/get-role-mining-potential-role.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Retrieves a specific potential role

    @@ -32,7 +30,7 @@ This method returns a specific potential role. ## Request -

    Path Parameters

    +

    Path Parameters

    Succeeded. Returns a list of potential roles for a role mining session. @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-role-mining-session-status.api.mdx b/docs/api/beta/get-role-mining-session-status.api.mdx index f1ebaa9d3..021bdb842 100644 --- a/docs/api/beta/get-role-mining-session-status.api.mdx +++ b/docs/api/beta/get-role-mining-session-status.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get role mining session status state

    @@ -32,7 +30,7 @@ This method returns a role mining session status for a customer. ## Request -

    Path Parameters

    +

    Path Parameters

    Succeeded. Returns session status @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -76,4 +74,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-role-mining-session.api.mdx b/docs/api/beta/get-role-mining-session.api.mdx index 40bcdb8a7..115ca68e0 100644 --- a/docs/api/beta/get-role-mining-session.api.mdx +++ b/docs/api/beta/get-role-mining-session.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get a role mining session

    @@ -32,7 +30,7 @@ The method retrieves a role mining session. ## Request -

    Path Parameters

    +

    Path Parameters

    Returns a role mining session @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -92,7 +90,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -108,4 +106,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-role-mining-sessions.api.mdx b/docs/api/beta/get-role-mining-sessions.api.mdx index 0b5231b64..b80d3dcfb 100644 --- a/docs/api/beta/get-role-mining-sessions.api.mdx +++ b/docs/api/beta/get-role-mining-sessions.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Retrieves all role mining sessions

    @@ -32,7 +30,7 @@ Returns all role mining sessions that match the query parameters ## Request -

    Query Parameters

    +

    Query Parameters

    Succeeded. Returns all role mining sessions that match the query parameters. @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-role.api.mdx b/docs/api/beta/get-role.api.mdx index d7f1f84e7..2c6cca3d3 100644 --- a/docs/api/beta/get-role.api.mdx +++ b/docs/api/beta/get-role.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get a Role

    @@ -34,7 +32,7 @@ A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required ## Request -

    Path Parameters

    +

    Path Parameters

    List of all Roles @@ -122,7 +120,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -138,4 +136,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-saved-potential-roles.api.mdx b/docs/api/beta/get-saved-potential-roles.api.mdx index e5b5833c5..7ed9fea7b 100644 --- a/docs/api/beta/get-saved-potential-roles.api.mdx +++ b/docs/api/beta/get-saved-potential-roles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Retrieves all saved potential roles

    @@ -32,7 +30,7 @@ This method returns all saved potential roles (draft roles). ## Request -

    Query Parameters

    +

    Query Parameters

    Succeeded. Returns a list of draft roles for a role mining session. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-search-attribute-config.api.mdx b/docs/api/beta/get-search-attribute-config.api.mdx index 702538eed..5be6f7d55 100644 --- a/docs/api/beta/get-search-attribute-config.api.mdx +++ b/docs/api/beta/get-search-attribute-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Retrieve a list of extended search attributes in IdentityNow.

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -
    +
    List of attribute configurations in IdentityNow. @@ -53,7 +51,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -69,4 +67,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-segment.api.mdx b/docs/api/beta/get-segment.api.mdx index c2e324345..8a1954e27 100644 --- a/docs/api/beta/get-segment.api.mdx +++ b/docs/api/beta/get-segment.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Segment by ID

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN or API authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    Segment @@ -73,7 +71,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -85,7 +83,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -101,4 +99,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-service-desk-integration-list.api.mdx b/docs/api/beta/get-service-desk-integration-list.api.mdx index d2a27325a..d4f26a75d 100644 --- a/docs/api/beta/get-service-desk-integration-list.api.mdx +++ b/docs/api/beta/get-service-desk-integration-list.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List existing Service Desk Integrations

    @@ -32,7 +30,7 @@ Get a list of ServiceDeskIntegrationDto for existing Service Desk Integrations. ## Request -

    Query Parameters

    +

    Query Parameters

    List of ServiceDeskIntegrationDto @@ -92,7 +90,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -104,7 +102,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -120,4 +118,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-service-desk-integration-template.api.mdx b/docs/api/beta/get-service-desk-integration-template.api.mdx index b9a0bc817..94499d6e0 100644 --- a/docs/api/beta/get-service-desk-integration-template.api.mdx +++ b/docs/api/beta/get-service-desk-integration-template.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Service Desk integration template by scriptName.

    @@ -32,7 +30,7 @@ This API endpoint returns an existing Service Desk integration template by scrip ## Request -

    Path Parameters

    +

    Path Parameters

    Responds with the ServiceDeskIntegrationTemplateDto with the specified scriptName. @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -92,7 +90,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -108,4 +106,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-service-desk-integration-types.api.mdx b/docs/api/beta/get-service-desk-integration-types.api.mdx index c83cd4931..2ff9e23d9 100644 --- a/docs/api/beta/get-service-desk-integration-types.api.mdx +++ b/docs/api/beta/get-service-desk-integration-types.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Service Desk Integration Types List.

    @@ -32,7 +30,7 @@ This API endpoint returns the current list of supported Service Desk integration ## Request -
    +
    Responds with an array of the currently supported Service Desk integration types. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-service-desk-integration.api.mdx b/docs/api/beta/get-service-desk-integration.api.mdx index bb41b8520..b5e02c1d7 100644 --- a/docs/api/beta/get-service-desk-integration.api.mdx +++ b/docs/api/beta/get-service-desk-integration.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get a Service Desk integration

    @@ -32,7 +30,7 @@ Get an existing Service Desk integration by ID. A token with Org Admin or Servi ## Request -

    Path Parameters

    +

    Path Parameters

    ServiceDeskIntegrationDto with the given ID @@ -92,7 +90,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -104,7 +102,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -120,4 +118,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-single-search-attribute-config.api.mdx b/docs/api/beta/get-single-search-attribute-config.api.mdx index 263e14c0a..1e06f0592 100644 --- a/docs/api/beta/get-single-search-attribute-config.api.mdx +++ b/docs/api/beta/get-single-search-attribute-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get the details of a specific extended search attribute in IdentityNow.

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    Specific attribute configuration in IdentityNow. @@ -57,7 +55,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -85,4 +83,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-sod-all-report-run-status.api.mdx b/docs/api/beta/get-sod-all-report-run-status.api.mdx index 541bada66..ae748b1dd 100644 --- a/docs/api/beta/get-sod-all-report-run-status.api.mdx +++ b/docs/api/beta/get-sod-all-report-run-status.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get multi-report run task status

    @@ -37,7 +35,7 @@ Requires role of ORG_ADMIN. ## Request -
    +
    Status of the violation report run task for all policy run. @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -85,4 +83,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-sod-policy-schedule.api.mdx b/docs/api/beta/get-sod-policy-schedule.api.mdx index b66c97fa3..748ccd7a6 100644 --- a/docs/api/beta/get-sod-policy-schedule.api.mdx +++ b/docs/api/beta/get-sod-policy-schedule.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get SOD policy schedule

    @@ -37,7 +35,7 @@ Requires the role of ORG_ADMIN. ## Request -

    Path Parameters

    +

    Path Parameters

    SOD policy ID. @@ -91,7 +89,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -107,4 +105,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-sod-policy.api.mdx b/docs/api/beta/get-sod-policy.api.mdx index cc21a8f33..10caf7913 100644 --- a/docs/api/beta/get-sod-policy.api.mdx +++ b/docs/api/beta/get-sod-policy.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get SOD policy by ID

    @@ -37,7 +35,7 @@ Requires role of ORG_ADMIN. ## Request -

    Path Parameters

    +

    Path Parameters

    SOD policy ID. @@ -85,7 +83,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -97,7 +95,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -113,4 +111,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-sod-violation-report-run-status.api.mdx b/docs/api/beta/get-sod-violation-report-run-status.api.mdx index 142f9a8f5..a9e2dd1a3 100644 --- a/docs/api/beta/get-sod-violation-report-run-status.api.mdx +++ b/docs/api/beta/get-sod-violation-report-run-status.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get violation report run status

    @@ -37,7 +35,7 @@ Requires role of ORG_ADMIN. ## Request -

    Path Parameters

    +

    Path Parameters

    Status of the violation report run task. @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -81,7 +79,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -97,4 +95,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-sod-violation-report-status.api.mdx b/docs/api/beta/get-sod-violation-report-status.api.mdx index 2552b7ee0..834c740ec 100644 --- a/docs/api/beta/get-sod-violation-report-status.api.mdx +++ b/docs/api/beta/get-sod-violation-report-status.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get SOD violation report status

    @@ -37,7 +35,7 @@ Requires role of ORG_ADMIN. ## Request -

    Path Parameters

    +

    Path Parameters

    Status of the violation report run task. @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -81,7 +79,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -97,4 +95,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-source-accounts-schema.api.mdx b/docs/api/beta/get-source-accounts-schema.api.mdx index ae188a9d9..245424068 100644 --- a/docs/api/beta/get-source-accounts-schema.api.mdx +++ b/docs/api/beta/get-source-accounts-schema.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Downloads source accounts schema template

    @@ -32,7 +30,7 @@ Downloads source accounts schema template ## Request -

    Path Parameters

    +

    Path Parameters

    Successfully downloaded the file @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-source-attr-sync-config.api.mdx b/docs/api/beta/get-source-attr-sync-config.api.mdx index ae5a3621c..cd9c4dfd0 100644 --- a/docs/api/beta/get-source-attr-sync-config.api.mdx +++ b/docs/api/beta/get-source-attr-sync-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Attribute Sync Config

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN or HELPDESK authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    Attribute synchronization configuration for a source @@ -73,7 +71,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -85,7 +83,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -101,4 +99,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-source-config.api.mdx b/docs/api/beta/get-source-config.api.mdx index 6d4268b44..6e3985082 100644 --- a/docs/api/beta/get-source-config.api.mdx +++ b/docs/api/beta/get-source-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Gets source config with language translations

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    A Connector Detail object @@ -53,7 +51,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -81,4 +79,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-source-entitlement-request-config.api.mdx b/docs/api/beta/get-source-entitlement-request-config.api.mdx index 86f62dead..5421649dc 100644 --- a/docs/api/beta/get-source-entitlement-request-config.api.mdx +++ b/docs/api/beta/get-source-entitlement-request-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Source Entitlement Request Configuration

    @@ -38,7 +36,7 @@ A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required t ## Request -
    +
    Source Entitlement Request Configuration Details. @@ -78,7 +76,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -94,4 +92,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-source-entitlements-schema.api.mdx b/docs/api/beta/get-source-entitlements-schema.api.mdx index c6b1ce29e..2cec250b6 100644 --- a/docs/api/beta/get-source-entitlements-schema.api.mdx +++ b/docs/api/beta/get-source-entitlements-schema.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Downloads source entitlements schema template

    @@ -32,7 +30,7 @@ Downloads source entitlements schema template ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Successfully downloaded the file @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-source-schema.api.mdx b/docs/api/beta/get-source-schema.api.mdx index ef5b6f1d9..85b1aceda 100644 --- a/docs/api/beta/get-source-schema.api.mdx +++ b/docs/api/beta/get-source-schema.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Source Schema by ID

    @@ -33,7 +31,7 @@ Get the Source Schema by ID in IdentityNow. ## Request -

    Path Parameters

    +

    Path Parameters

    The requested Schema was successfully retrieved. @@ -73,7 +71,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -85,7 +83,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -101,4 +99,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-source.api.mdx b/docs/api/beta/get-source.api.mdx index 4c0326b7a..67ce75ff8 100644 --- a/docs/api/beta/get-source.api.mdx +++ b/docs/api/beta/get-source.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Source by ID

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required t ## Request -

    Path Parameters

    +

    Path Parameters

    A Source object @@ -105,7 +103,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -117,7 +115,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -133,4 +131,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-sp-config-export-status.api.mdx b/docs/api/beta/get-sp-config-export-status.api.mdx index dfa248222..221254cb2 100644 --- a/docs/api/beta/get-sp-config-export-status.api.mdx +++ b/docs/api/beta/get-sp-config-export-status.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get export job status

    @@ -34,7 +32,7 @@ The request will need one of the following security scopes: ## Request -

    Path Parameters

    +

    Path Parameters

    Export job status successfully returned. @@ -66,7 +64,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -78,7 +76,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -94,4 +92,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-sp-config-export.api.mdx b/docs/api/beta/get-sp-config-export.api.mdx index 86965e4fb..fa83180a6 100644 --- a/docs/api/beta/get-sp-config-export.api.mdx +++ b/docs/api/beta/get-sp-config-export.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Download export job result.

    @@ -34,7 +32,7 @@ The request will need one of the following security scopes: ## Request -

    Path Parameters

    +

    Path Parameters

    Exported JSON objects. @@ -82,7 +80,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -94,7 +92,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -110,4 +108,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-sp-config-import-status.api.mdx b/docs/api/beta/get-sp-config-import-status.api.mdx index 22cc489e2..17799867d 100644 --- a/docs/api/beta/get-sp-config-import-status.api.mdx +++ b/docs/api/beta/get-sp-config-import-status.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get import job status

    @@ -35,7 +33,7 @@ The request will need the following security scope: ## Request -

    Path Parameters

    +

    Path Parameters

    Import job status successfully returned. @@ -67,7 +65,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -79,7 +77,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -95,4 +93,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-sp-config-import.api.mdx b/docs/api/beta/get-sp-config-import.api.mdx index fde2803eb..90401a8c1 100644 --- a/docs/api/beta/get-sp-config-import.api.mdx +++ b/docs/api/beta/get-sp-config-import.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Download import job result

    @@ -34,7 +32,7 @@ The request will need the following security scope: ## Request -

    Path Parameters

    +

    Path Parameters

    Import results JSON object, containing detailed results of the import operation. @@ -102,7 +100,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -114,7 +112,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -130,4 +128,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-status-by-source-id.api.mdx b/docs/api/beta/get-status-by-source-id.api.mdx index 1c25baecb..0129e77fe 100644 --- a/docs/api/beta/get-status-by-source-id.api.mdx +++ b/docs/api/beta/get-status-by-source-id.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Finds status of source usage

    @@ -32,7 +30,7 @@ This API returns the status of the source usage insights setup by IDN source ID. ## Request -

    Path Parameters

    +

    Path Parameters

    Status of the source usage insights setup by IDN source ID. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-status-check-details.api.mdx b/docs/api/beta/get-status-check-details.api.mdx index 22e4bccfa..3ba945ba8 100644 --- a/docs/api/beta/get-status-check-details.api.mdx +++ b/docs/api/beta/get-status-check-details.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get the time check configuration

    @@ -32,7 +30,7 @@ Get the time check configuration of queued SDIM tickets. A token with Org Admin ## Request -
    +
    QueuedCheckConfigDetails containing the configured values @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-tagged-object.api.mdx b/docs/api/beta/get-tagged-object.api.mdx index fa64caa4c..bbc7418d5 100644 --- a/docs/api/beta/get-tagged-object.api.mdx +++ b/docs/api/beta/get-tagged-object.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Tagged Object

    @@ -32,7 +30,7 @@ This gets a tagged object for the specified type. ## Request -

    Path Parameters

    +

    Path Parameters

    Tagged object by type and ID. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-task-status-list.api.mdx b/docs/api/beta/get-task-status-list.api.mdx index 24f1af5e6..ba2093649 100644 --- a/docs/api/beta/get-task-status-list.api.mdx +++ b/docs/api/beta/get-task-status-list.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Retrieve a task status list.

    @@ -32,7 +30,7 @@ Get a TaskStatus list. ## Request -

    Query Parameters

    +

    Query Parameters

    Responds with a TaskStatus for the task with the given task ID. @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -92,7 +90,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -108,4 +106,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-task-status.api.mdx b/docs/api/beta/get-task-status.api.mdx index c4a995505..3ffaa71ed 100644 --- a/docs/api/beta/get-task-status.api.mdx +++ b/docs/api/beta/get-task-status.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get task status by ID.

    @@ -32,7 +30,7 @@ Get a TaskStatus for a task by task ID. ## Request -

    Path Parameters

    +

    Path Parameters

    Responds with a TaskStatus for the task with the given task ID. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-tenant-config-configuration.api.mdx b/docs/api/beta/get-tenant-config-configuration.api.mdx index 0bd1b5c7a..f6b7dbaf2 100644 --- a/docs/api/beta/get-tenant-config-configuration.api.mdx +++ b/docs/api/beta/get-tenant-config-configuration.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Tenant-wide Reassignment Configuration settings

    @@ -32,7 +30,7 @@ Gets the global Reassignment Configuration settings for the requestor's tenant. ## Request -
    +
    Tenant-wide Reassignment Configuration settings @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -92,7 +90,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -108,4 +106,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-transform.api.mdx b/docs/api/beta/get-transform.api.mdx index 4d5be820f..4fde8c014 100644 --- a/docs/api/beta/get-transform.api.mdx +++ b/docs/api/beta/get-transform.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Transform by ID

    @@ -33,7 +31,7 @@ A token with transform read authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    Transform with the given ID @@ -297,7 +295,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -309,7 +307,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -325,4 +323,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-usages-by-account-id.api.mdx b/docs/api/beta/get-usages-by-account-id.api.mdx index fed1f3407..2de853a55 100644 --- a/docs/api/beta/get-usages-by-account-id.api.mdx +++ b/docs/api/beta/get-usages-by-account-id.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns account usage insights

    @@ -32,7 +30,7 @@ This API returns a summary of account usage insights for past 12 months. ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Summary of account usage insights for past 12 months. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-usages-by-source-id.api.mdx b/docs/api/beta/get-usages-by-source-id.api.mdx index d2a4e59ea..5118e4f3d 100644 --- a/docs/api/beta/get-usages-by-source-id.api.mdx +++ b/docs/api/beta/get-usages-by-source-id.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns source usage insights

    @@ -32,7 +30,7 @@ This API returns a summary of source usage insights for past 12 months. ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Summary of source usage insights for past 12 months. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-valid-time-zones.api.mdx b/docs/api/beta/get-valid-time-zones.api.mdx index 6b6264a76..437804b55 100644 --- a/docs/api/beta/get-valid-time-zones.api.mdx +++ b/docs/api/beta/get-valid-time-zones.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get list of time zones

    @@ -32,7 +30,7 @@ Get a list of valid time zones that can be set in org configurations. ## Request -
    +
    Request successful @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-work-item.api.mdx b/docs/api/beta/get-work-item.api.mdx index 9276cb497..e639ed603 100644 --- a/docs/api/beta/get-work-item.api.mdx +++ b/docs/api/beta/get-work-item.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get a Work Item

    @@ -32,7 +30,7 @@ This gets the details of a Work Item belonging to either the specified user(admi ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    The work item with the given ID. @@ -60,7 +58,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -72,4 +70,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 404 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-work-items-summary.api.mdx b/docs/api/beta/get-work-items-summary.api.mdx index 8a5aa51c8..30b22bc3f 100644 --- a/docs/api/beta/get-work-items-summary.api.mdx +++ b/docs/api/beta/get-work-items-summary.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Work Items Summary

    @@ -32,7 +30,7 @@ This gets a summary of work items belonging to either the specified user(admin r ## Request -

    Query Parameters

    +

    Query Parameters

    List of work items @@ -60,7 +58,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -72,4 +70,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 404 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-workflow-execution-history.api.mdx b/docs/api/beta/get-workflow-execution-history.api.mdx index 71f1a5c58..ed76fc70f 100644 --- a/docs/api/beta/get-workflow-execution-history.api.mdx +++ b/docs/api/beta/get-workflow-execution-history.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Workflow Execution History

    @@ -32,7 +30,7 @@ Get a detailed history of a single workflow execution. Workflow executions are ## Request -

    Path Parameters

    +

    Path Parameters

    List of workflow execution events for the given workflow execution @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-workflow-execution.api.mdx b/docs/api/beta/get-workflow-execution.api.mdx index 9852cfc70..92ec98b41 100644 --- a/docs/api/beta/get-workflow-execution.api.mdx +++ b/docs/api/beta/get-workflow-execution.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get a Workflow Execution

    @@ -32,7 +30,7 @@ Get a single workflow execution. Workflow executions are available for up to 90 ## Request -

    Path Parameters

    +

    Path Parameters

    The workflow execution @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-workflow.api.mdx b/docs/api/beta/get-workflow.api.mdx index de4c974d7..ea25a2ee2 100644 --- a/docs/api/beta/get-workflow.api.mdx +++ b/docs/api/beta/get-workflow.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Workflow By Id

    @@ -32,7 +30,7 @@ Get a single workflow by id. ## Request -

    Path Parameters

    +

    Path Parameters

    The workflow object @@ -88,7 +86,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -104,4 +102,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/get-workgroup.api.mdx b/docs/api/beta/get-workgroup.api.mdx index 4df76cb85..d6e65c8a1 100644 --- a/docs/api/beta/get-workgroup.api.mdx +++ b/docs/api/beta/get-workgroup.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Governance Group by Id

    @@ -32,7 +30,7 @@ This API returns a Governance Groups by its ID. ## Request -

    Path Parameters

    +

    Path Parameters

    A Governance Group @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/ignore-identity-outliers.api.mdx b/docs/api/beta/ignore-identity-outliers.api.mdx index 57b88e893..cb9009c08 100644 --- a/docs/api/beta/ignore-identity-outliers.api.mdx +++ b/docs/api/beta/ignore-identity-outliers.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    IAI Identity Outliers Ignore

    @@ -37,7 +35,7 @@ Requires authorization scope of 'iai:outliers-management:update' string -
  • ]
    • +
  • ]
    • No content - indicates the request was successful but there is no content to be returned in the response. @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -85,4 +83,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/import-form-definitions.api.mdx b/docs/api/beta/import-form-definitions.api.mdx index 394840c00..00231f616 100644 --- a/docs/api/beta/import-form-definitions.api.mdx +++ b/docs/api/beta/import-form-definitions.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Import form definitions from export.

    @@ -68,7 +66,7 @@ List of effects. Arbitrary map containing a configuration based on the EffectType. -
  • ]
  • ]
  • ]
    • +
  • ]
  • ]
  • ]
    • Returns statuses of those form definition objects imported diff --git a/docs/api/beta/import-identity-profiles.api.mdx b/docs/api/beta/import-identity-profiles.api.mdx index 63ddfa7ec..5c28adb89 100644 --- a/docs/api/beta/import-identity-profiles.api.mdx +++ b/docs/api/beta/import-identity-profiles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Import Identity Profiles

    @@ -56,7 +54,7 @@ The seaspray transformation definition. Arbitrary key-value pairs to store any metadata for the object -
  • ]
    • identityExceptionReportReference objectnullable
  • ]
    • +
  • ]
    • identityExceptionReportReference objectnullable
  • ]
    • The result of importing Identity Profiles. @@ -116,7 +114,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -132,4 +130,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/import-non-employee-records-in-bulk.api.mdx b/docs/api/beta/import-non-employee-records-in-bulk.api.mdx index c43adbeb2..bc76b937b 100644 --- a/docs/api/beta/import-non-employee-records-in-bulk.api.mdx +++ b/docs/api/beta/import-non-employee-records-in-bulk.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Imports, or Updates, Non-Employee Records

    @@ -34,7 +32,7 @@ Request will need the following security scope: ## Request -

    Path Parameters

    Body

    +

    Path Parameters

    Body

    The CSV was accepted to be bulk inserted now or at a later time. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/import-source-accounts-schema.api.mdx b/docs/api/beta/import-source-accounts-schema.api.mdx index ddb018283..e06c10916 100644 --- a/docs/api/beta/import-source-accounts-schema.api.mdx +++ b/docs/api/beta/import-source-accounts-schema.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Uploads source accounts schema template

    @@ -32,7 +30,7 @@ This API uploads a source schema template file to configure a source's account a ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    Successfully uploaded the file @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -88,4 +86,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/import-source-connector-file.api.mdx b/docs/api/beta/import-source-connector-file.api.mdx index 459f6fea9..8eeed95fa 100644 --- a/docs/api/beta/import-source-connector-file.api.mdx +++ b/docs/api/beta/import-source-connector-file.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Upload connector file to source

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    Uploaded the file successfully and sent all post-upload events @@ -105,7 +103,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -121,4 +119,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/import-source-entitlements-schema.api.mdx b/docs/api/beta/import-source-entitlements-schema.api.mdx index 0473a0d14..acf83d1e3 100644 --- a/docs/api/beta/import-source-entitlements-schema.api.mdx +++ b/docs/api/beta/import-source-entitlements-schema.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Uploads source entitlements schema template

    @@ -32,7 +30,7 @@ This API uploads a source schema template file to configure a source's entitleme ## Request -

    Path Parameters

    Query Parameters

    Body

    required
    +

    Path Parameters

    Query Parameters

    Body

    required
    Successfully uploaded the file @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -88,4 +86,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/import-sp-config.api.mdx b/docs/api/beta/import-sp-config.api.mdx index 7f8b90c6b..f72d334c7 100644 --- a/docs/api/beta/import-sp-config.api.mdx +++ b/docs/api/beta/import-sp-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Initiates configuration objects import job

    @@ -104,7 +102,7 @@ __Sample Import File__ Additional options targeting specific objects related to each item in the includeTypes field -
    property name* ObjectExportImportOptions
    +
    property name* ObjectExportImportOptions
    Import job accepted and queued for processing. @@ -137,7 +135,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -149,7 +147,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -165,4 +163,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-access-profiles.api.mdx b/docs/api/beta/list-access-profiles.api.mdx index 14b69c5d3..e6cfb9800 100644 --- a/docs/api/beta/list-access-profiles.api.mdx +++ b/docs/api/beta/list-access-profiles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Access Profiles

    @@ -34,7 +32,7 @@ A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_ ## Request -

    Query Parameters

    +

    Query Parameters

    List of Access Profiles @@ -102,7 +100,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -118,4 +116,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-access-request-status.api.mdx b/docs/api/beta/list-access-request-status.api.mdx index daed83cca..e2d25fbd1 100644 --- a/docs/api/beta/list-access-request-status.api.mdx +++ b/docs/api/beta/list-access-request-status.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Access Request Status

    @@ -33,7 +31,7 @@ Any token with any authority can request their own status. A token with ORG_ADMI ## Request -

    Query Parameters

    +

    Query Parameters

    List of requested item status. @@ -169,7 +167,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -185,4 +183,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-account-activities.api.mdx b/docs/api/beta/list-account-activities.api.mdx index 2d849f1eb..d607f58be 100644 --- a/docs/api/beta/list-account-activities.api.mdx +++ b/docs/api/beta/list-account-activities.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Account Activities

    @@ -32,7 +30,7 @@ This gets a collection of account activities that satisfy the given query parame ## Request -

    Query Parameters

    +

    Query Parameters

    List of account activities @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-accounts.api.mdx b/docs/api/beta/list-accounts.api.mdx index 354d8ac0a..57dcda982 100644 --- a/docs/api/beta/list-accounts.api.mdx +++ b/docs/api/beta/list-accounts.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Accounts List

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Query Parameters

    +

    Query Parameters

    List of account objects @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-campaign-templates.api.mdx b/docs/api/beta/list-campaign-templates.api.mdx index ff03d3e3c..677d5078d 100644 --- a/docs/api/beta/list-campaign-templates.api.mdx +++ b/docs/api/beta/list-campaign-templates.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Campaign Templates

    @@ -38,7 +36,7 @@ All CampaignTemplates matching the query params ## Request -

    Query Parameters

    +

    Query Parameters

    List of campaign template objects @@ -118,7 +116,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -134,4 +132,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-certification-reviewers.api.mdx b/docs/api/beta/list-certification-reviewers.api.mdx index 61ac639c3..26463069b 100644 --- a/docs/api/beta/list-certification-reviewers.api.mdx +++ b/docs/api/beta/list-certification-reviewers.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List of Reviewers for certification

    @@ -36,7 +34,7 @@ This API returns a list of reviewers for the certification. A token with ORG_ADM ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    A list of reviewers @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-complete-workflow-library.api.mdx b/docs/api/beta/list-complete-workflow-library.api.mdx index 56220812e..f40feaff1 100644 --- a/docs/api/beta/list-complete-workflow-library.api.mdx +++ b/docs/api/beta/list-complete-workflow-library.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Complete Workflow Library

    @@ -32,7 +30,7 @@ This lists all triggers, actions, and operators in the library ## Request -

    Query Parameters

    +

    Query Parameters

    List of workflow steps @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-completed-approvals.api.mdx b/docs/api/beta/list-completed-approvals.api.mdx index 73962b860..704c55805 100644 --- a/docs/api/beta/list-completed-approvals.api.mdx +++ b/docs/api/beta/list-completed-approvals.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Completed Access Request Approvals List

    @@ -32,7 +30,7 @@ This endpoint returns list of completed approvals. See *owner-id* query paramete ## Request -

    Query Parameters

    +

    Query Parameters

    List of Completed Approvals. @@ -132,7 +130,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -148,4 +146,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-connections.api.mdx b/docs/api/beta/list-connections.api.mdx index b89b2cb83..eefc0c8a7 100644 --- a/docs/api/beta/list-connections.api.mdx +++ b/docs/api/beta/list-connections.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List connections for Governance Group

    @@ -32,7 +30,7 @@ This API returns list of connections associated with a Governance Group. ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    List all connections associated with a Governance Group. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-entitlement-children.api.mdx b/docs/api/beta/list-entitlement-children.api.mdx index 1a6442957..a154b9feb 100644 --- a/docs/api/beta/list-entitlement-children.api.mdx +++ b/docs/api/beta/list-entitlement-children.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List of entitlements children

    @@ -32,7 +30,7 @@ This API returns a list of all child entitlements of a given entitlement. ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    List of entitlements children from an entitlement @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -88,7 +86,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -104,4 +102,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-entitlement-parents.api.mdx b/docs/api/beta/list-entitlement-parents.api.mdx index acdae2d07..5752eb20a 100644 --- a/docs/api/beta/list-entitlement-parents.api.mdx +++ b/docs/api/beta/list-entitlement-parents.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List of entitlements parents

    @@ -32,7 +30,7 @@ This API returns a list of all parent entitlements of a given entitlement. ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    List of entitlements parents from an entitlement @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -88,7 +86,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -104,4 +102,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-entitlements.api.mdx b/docs/api/beta/list-entitlements.api.mdx index 10cf387a5..5474e956a 100644 --- a/docs/api/beta/list-entitlements.api.mdx +++ b/docs/api/beta/list-entitlements.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Gets a list of entitlements.

    @@ -36,7 +34,7 @@ Any authenticated token can call this API. ## Request -

    Query Parameters

    +

    Query Parameters

    List of entitlements @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-from-addresses.api.mdx b/docs/api/beta/list-from-addresses.api.mdx index 99adaa3fc..f12840b38 100644 --- a/docs/api/beta/list-from-addresses.api.mdx +++ b/docs/api/beta/list-from-addresses.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List From Addresses

    @@ -32,7 +30,7 @@ Retrieve a list of sender email addresses and their verification statuses ## Request -

    Query Parameters

    +

    Query Parameters

    List of Email Status @@ -52,7 +50,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -68,4 +66,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-historical-identities.api.mdx b/docs/api/beta/list-historical-identities.api.mdx index 7dc21abf0..974634bf8 100644 --- a/docs/api/beta/list-historical-identities.api.mdx +++ b/docs/api/beta/list-historical-identities.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Lists all the identities

    @@ -32,7 +30,7 @@ This gets the list of identities for the customer. This list end point does not ## Request -

    Query Parameters

    +

    Query Parameters

    List of identities for the customer. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-identities.api.mdx b/docs/api/beta/list-identities.api.mdx index 0686928ea..15d51539a 100644 --- a/docs/api/beta/list-identities.api.mdx +++ b/docs/api/beta/list-identities.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Identities

    @@ -32,7 +30,7 @@ This API returns a list of identities. ## Request -

    Query Parameters

    +

    Query Parameters

    List of identities. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -88,4 +86,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-identity-access-items.api.mdx b/docs/api/beta/list-identity-access-items.api.mdx index e539ce45d..3b9302051 100644 --- a/docs/api/beta/list-identity-access-items.api.mdx +++ b/docs/api/beta/list-identity-access-items.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Gets a list of access items for the identity filtered by item type

    @@ -32,7 +30,7 @@ This method retrieves a list of access item for the identity filtered by the acc ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    The list of access items. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -88,4 +86,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-identity-attributes.api.mdx b/docs/api/beta/list-identity-attributes.api.mdx index 84c755a85..7697961df 100644 --- a/docs/api/beta/list-identity-attributes.api.mdx +++ b/docs/api/beta/list-identity-attributes.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Identity Attributes

    @@ -32,7 +30,7 @@ This gets a collection of identity attributes. ## Request -

    Query Parameters

    +

    Query Parameters

    List of identity attributes @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-identity-profiles.api.mdx b/docs/api/beta/list-identity-profiles.api.mdx index 54e7d5578..0307338a8 100644 --- a/docs/api/beta/list-identity-profiles.api.mdx +++ b/docs/api/beta/list-identity-profiles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Identity Profiles list

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN or API authority is required to call this API to get a li ## Request -

    Query Parameters

    +

    Query Parameters

    List of identityProfiles. @@ -81,7 +79,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -97,4 +95,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-identity-snapshot-access-items.api.mdx b/docs/api/beta/list-identity-snapshot-access-items.api.mdx index bef5b73d6..afa98ec31 100644 --- a/docs/api/beta/list-identity-snapshot-access-items.api.mdx +++ b/docs/api/beta/list-identity-snapshot-access-items.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Gets the list of identity access items at a given date filterd by item type

    @@ -32,7 +30,7 @@ This method retrieves the list of identity access items at a given date filterd ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    The identity object. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -88,4 +86,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-identity-snapshots.api.mdx b/docs/api/beta/list-identity-snapshots.api.mdx index 435a7b900..64ccb746f 100644 --- a/docs/api/beta/list-identity-snapshots.api.mdx +++ b/docs/api/beta/list-identity-snapshots.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Lists all the snapshots for the identity

    @@ -32,7 +30,7 @@ This method retrieves all the snapshots for the identity Requires authorization ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    A list of identity summary for each snapshot. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -88,4 +86,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-lifecycle-states.api.mdx b/docs/api/beta/list-lifecycle-states.api.mdx index e5f467516..6a6cfb5de 100644 --- a/docs/api/beta/list-lifecycle-states.api.mdx +++ b/docs/api/beta/list-lifecycle-states.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Lifecycle State

    @@ -35,7 +33,7 @@ A token with ORG_ADMIN or API authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    lifecycle-state @@ -67,7 +65,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -83,4 +81,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-non-employee-approval.api.mdx b/docs/api/beta/list-non-employee-approval.api.mdx index 5d2f38e55..c4b3e3410 100644 --- a/docs/api/beta/list-non-employee-approval.api.mdx +++ b/docs/api/beta/list-non-employee-approval.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get List of Non-Employee Approval Requests

    @@ -32,7 +30,7 @@ This gets a list of non-employee approval requests. ## Request -

    Query Parameters

    +

    Query Parameters

    List of approval items. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-non-employee-records.api.mdx b/docs/api/beta/list-non-employee-records.api.mdx index e923501f5..d8d08ff5e 100644 --- a/docs/api/beta/list-non-employee-records.api.mdx +++ b/docs/api/beta/list-non-employee-records.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Non-Employee Records

    @@ -32,7 +30,7 @@ This gets a list of non-employee records. ## Request -

    Query Parameters

    +

    Query Parameters

    Non-Employee record objects @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-non-employee-requests.api.mdx b/docs/api/beta/list-non-employee-requests.api.mdx index 8684dbe64..8db531c95 100644 --- a/docs/api/beta/list-non-employee-requests.api.mdx +++ b/docs/api/beta/list-non-employee-requests.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Non-Employee Requests

    @@ -32,7 +30,7 @@ This gets a list of non-employee requests. ## Request -

    Query Parameters

    +

    Query Parameters

    List of non-employee request objects. @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-non-employee-sources.api.mdx b/docs/api/beta/list-non-employee-sources.api.mdx index 0d73f7676..f7db34e9c 100644 --- a/docs/api/beta/list-non-employee-sources.api.mdx +++ b/docs/api/beta/list-non-employee-sources.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Non-Employee Sources

    @@ -32,7 +30,7 @@ This gets a list of non-employee sources. ## Request -

    Query Parameters

    +

    Query Parameters

    List of non-employee sources objects. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -88,4 +86,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-notification-template-defaults.api.mdx b/docs/api/beta/list-notification-template-defaults.api.mdx index fabd8357b..f9e5efcef 100644 --- a/docs/api/beta/list-notification-template-defaults.api.mdx +++ b/docs/api/beta/list-notification-template-defaults.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Notification Template Defaults

    @@ -32,7 +30,7 @@ This lists the default templates used for notifications, such as emails from Ide ## Request -

    Query Parameters

    +

    Query Parameters

    A list of the default template objects @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-notification-templates.api.mdx b/docs/api/beta/list-notification-templates.api.mdx index a5ef76c4e..41f91fffc 100644 --- a/docs/api/beta/list-notification-templates.api.mdx +++ b/docs/api/beta/list-notification-templates.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Notification Templates

    @@ -32,7 +30,7 @@ This lists the templates that you have modified for your site. ## Request -

    Query Parameters

    +

    Query Parameters

    A list of template objects for your site @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-oauth-clients.api.mdx b/docs/api/beta/list-oauth-clients.api.mdx index 2b10530c0..1d53bab02 100644 --- a/docs/api/beta/list-oauth-clients.api.mdx +++ b/docs/api/beta/list-oauth-clients.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List OAuth Clients

    @@ -32,7 +30,7 @@ This gets a list of OAuth clients. ## Request -

    Query Parameters

    +

    Query Parameters

    List of OAuth clients. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-outliers-contributing-feature-access-items.api.mdx b/docs/api/beta/list-outliers-contributing-feature-access-items.api.mdx index 7e195a509..5806c16d0 100644 --- a/docs/api/beta/list-outliers-contributing-feature-access-items.api.mdx +++ b/docs/api/beta/list-outliers-contributing-feature-access-items.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Gets a list of access items associated with each identity outlier contributing feature

    @@ -33,7 +31,7 @@ Requires authorization scope of 'iai:outliers-management:read' ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    The list of access items. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-pending-approvals.api.mdx b/docs/api/beta/list-pending-approvals.api.mdx index bd259c907..2de2fa2ab 100644 --- a/docs/api/beta/list-pending-approvals.api.mdx +++ b/docs/api/beta/list-pending-approvals.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Pending Access Request Approvals List

    @@ -32,7 +30,7 @@ This endpoint returns a list of pending approvals. See "owner-id" query paramete ## Request -

    Query Parameters

    +

    Query Parameters

    List of Pending Approvals. @@ -120,7 +118,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -136,4 +134,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-personal-access-tokens.api.mdx b/docs/api/beta/list-personal-access-tokens.api.mdx index 3603ff378..f2ff3b949 100644 --- a/docs/api/beta/list-personal-access-tokens.api.mdx +++ b/docs/api/beta/list-personal-access-tokens.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Personal Access Tokens

    @@ -32,7 +30,7 @@ This gets a collection of personal access tokens associated with the optional `o ## Request -

    Query Parameters

    +

    Query Parameters

    List of personal access tokens. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-provisioning-policies.api.mdx b/docs/api/beta/list-provisioning-policies.api.mdx index 0ddf57580..c0b1203bf 100644 --- a/docs/api/beta/list-provisioning-policies.api.mdx +++ b/docs/api/beta/list-provisioning-policies.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Lists ProvisioningPolicies

    @@ -33,7 +31,7 @@ A token with API, or ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    List of ProvisioningPolicyDto objects @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-reassignment-configurations.api.mdx b/docs/api/beta/list-reassignment-configurations.api.mdx index 0ec01d46b..6d1a9c4a8 100644 --- a/docs/api/beta/list-reassignment-configurations.api.mdx +++ b/docs/api/beta/list-reassignment-configurations.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Reassignment Configurations

    @@ -32,7 +30,7 @@ Gets all Reassignment configuration for the current org. ## Request -
    +
    A list of Reassignment Configurations for an org @@ -88,7 +86,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -100,7 +98,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -116,4 +114,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-requestable-objects.api.mdx b/docs/api/beta/list-requestable-objects.api.mdx index b952f10d1..f2691945a 100644 --- a/docs/api/beta/list-requestable-objects.api.mdx +++ b/docs/api/beta/list-requestable-objects.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Requestable Objects List

    @@ -33,7 +31,7 @@ Any authenticated token can call this endpoint to see their requestable access i ## Request -

    Query Parameters

    +

    Query Parameters

    List of requestable objects @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -81,4 +79,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-roles.api.mdx b/docs/api/beta/list-roles.api.mdx index 86bb5effc..f7563268a 100644 --- a/docs/api/beta/list-roles.api.mdx +++ b/docs/api/beta/list-roles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Roles

    @@ -34,7 +32,7 @@ A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required ## Request -

    Query Parameters

    +

    Query Parameters

    List of Roles @@ -122,7 +120,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -138,4 +136,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-segments.api.mdx b/docs/api/beta/list-segments.api.mdx index 08b2bfcd2..aceffd21d 100644 --- a/docs/api/beta/list-segments.api.mdx +++ b/docs/api/beta/list-segments.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Segments

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN or API authority is required to call this API. ## Request -

    Query Parameters

    +

    Query Parameters

    List of all segments @@ -73,7 +71,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -89,4 +87,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-sod-policies.api.mdx b/docs/api/beta/list-sod-policies.api.mdx index a3d76bd98..41671adc0 100644 --- a/docs/api/beta/list-sod-policies.api.mdx +++ b/docs/api/beta/list-sod-policies.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List SOD policies

    @@ -37,7 +35,7 @@ Requires role of ORG_ADMIN ## Request -

    Query Parameters

    +

    Query Parameters

    List of all SOD policies. @@ -85,7 +83,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -101,4 +99,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-source-schemas.api.mdx b/docs/api/beta/list-source-schemas.api.mdx index 2a332ff66..f2bb2d403 100644 --- a/docs/api/beta/list-source-schemas.api.mdx +++ b/docs/api/beta/list-source-schemas.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Lists the Schemas that exist on the specified Source in IdentityNow.

    @@ -32,7 +30,7 @@ Lists the Schemas that exist on the specified Source in IdentityNow. ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    The Schemas were successfully retrieved. @@ -60,7 +58,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -88,4 +86,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-sources.api.mdx b/docs/api/beta/list-sources.api.mdx index 4ddd507eb..6f46be89c 100644 --- a/docs/api/beta/list-sources.api.mdx +++ b/docs/api/beta/list-sources.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Lists all sources in IdentityNow.

    @@ -34,7 +32,7 @@ A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or ROLE_SUBADMIN authorit ## Request -

    Query Parameters

    +

    Query Parameters

    List of Source objects @@ -106,7 +104,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -118,7 +116,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -134,4 +132,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-sp-config-objects.api.mdx b/docs/api/beta/list-sp-config-objects.api.mdx index e3b959661..7411e16d5 100644 --- a/docs/api/beta/list-sp-config-objects.api.mdx +++ b/docs/api/beta/list-sp-config-objects.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get config object details

    @@ -32,7 +30,7 @@ This gets the list of object configurations which are known to the tenant export ## Request -
    +
    Object configurations returned successfully. @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -92,7 +90,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -108,4 +106,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-subscriptions.api.mdx b/docs/api/beta/list-subscriptions.api.mdx index bd3d7821c..0376ca884 100644 --- a/docs/api/beta/list-subscriptions.api.mdx +++ b/docs/api/beta/list-subscriptions.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Subscriptions

    @@ -32,7 +30,7 @@ Gets a list of all trigger subscriptions. ## Request -

    Query Parameters

    +

    Query Parameters

    List of subscriptions. @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-tagged-objects-by-type.api.mdx b/docs/api/beta/list-tagged-objects-by-type.api.mdx index 1d6145d3a..25f7dfe9f 100644 --- a/docs/api/beta/list-tagged-objects-by-type.api.mdx +++ b/docs/api/beta/list-tagged-objects-by-type.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Tagged Objects by Type

    @@ -34,7 +32,7 @@ Any authenticated token may be used to call this API. ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    List of all tagged objects for specified type. @@ -66,7 +64,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -82,4 +80,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-tagged-objects.api.mdx b/docs/api/beta/list-tagged-objects.api.mdx index 3bed00553..d6dc0cb0b 100644 --- a/docs/api/beta/list-tagged-objects.api.mdx +++ b/docs/api/beta/list-tagged-objects.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Tagged Objects

    @@ -34,7 +32,7 @@ Any authenticated token may be used to call this API. ## Request -

    Query Parameters

    +

    Query Parameters

    List of all tagged objects. @@ -66,7 +64,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -82,4 +80,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-transforms.api.mdx b/docs/api/beta/list-transforms.api.mdx index 5bd94d91c..3a20c6a8d 100644 --- a/docs/api/beta/list-transforms.api.mdx +++ b/docs/api/beta/list-transforms.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List transforms

    @@ -33,7 +31,7 @@ A token with transforms-list read authority is required to call this API. ## Request -

    Query Parameters

    +

    Query Parameters

    A list of transforms matching the given criteria. @@ -297,7 +295,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -309,7 +307,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -325,4 +323,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-trigger-invocation-status.api.mdx b/docs/api/beta/list-trigger-invocation-status.api.mdx index 2fe166b5b..ff86b0339 100644 --- a/docs/api/beta/list-trigger-invocation-status.api.mdx +++ b/docs/api/beta/list-trigger-invocation-status.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Latest Invocation Statuses

    @@ -34,7 +32,7 @@ This endpoint may only fetch up to 2000 invocations, and should not be treated a ## Request -

    Query Parameters

    +

    Query Parameters

    List of latest invocation statuses. @@ -78,7 +76,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -94,4 +92,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-triggers.api.mdx b/docs/api/beta/list-triggers.api.mdx index 9cad41467..3ae8720ac 100644 --- a/docs/api/beta/list-triggers.api.mdx +++ b/docs/api/beta/list-triggers.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Triggers

    @@ -32,7 +30,7 @@ Gets a list of triggers that are available in the tenant. ## Request -

    Query Parameters

    +

    Query Parameters

    List of triggers. @@ -404,7 +402,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -420,4 +418,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-work-items.api.mdx b/docs/api/beta/list-work-items.api.mdx index a578ce914..7338df877 100644 --- a/docs/api/beta/list-work-items.api.mdx +++ b/docs/api/beta/list-work-items.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Work Items

    @@ -32,7 +30,7 @@ This gets a collection of work items belonging to either the specified user(admi ## Request -

    Query Parameters

    +

    Query Parameters

    List of work items @@ -60,7 +58,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -72,4 +70,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 404 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-workflow-executions.api.mdx b/docs/api/beta/list-workflow-executions.api.mdx index b96190264..05f5bce9f 100644 --- a/docs/api/beta/list-workflow-executions.api.mdx +++ b/docs/api/beta/list-workflow-executions.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Workflow Executions

    @@ -42,7 +40,7 @@ This lists the executions for a given workflow. Workflow executions are availabl ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    List of workflow executions for the given workflow @@ -74,7 +72,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -86,7 +84,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -102,4 +100,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-workflow-library-actions.api.mdx b/docs/api/beta/list-workflow-library-actions.api.mdx index e54d92e9f..011484144 100644 --- a/docs/api/beta/list-workflow-library-actions.api.mdx +++ b/docs/api/beta/list-workflow-library-actions.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Workflow Library Actions

    @@ -32,7 +30,7 @@ This lists the workflow actions available to you. ## Request -

    Query Parameters

    +

    Query Parameters

    List of workflow actions @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-workflow-library-operators.api.mdx b/docs/api/beta/list-workflow-library-operators.api.mdx index 9ea3fde77..e8ef47299 100644 --- a/docs/api/beta/list-workflow-library-operators.api.mdx +++ b/docs/api/beta/list-workflow-library-operators.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Workflow Library Operators

    @@ -32,7 +30,7 @@ This lists the workflow operators available to you ## Request -
    +
    List of workflow operators @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-workflow-library-triggers.api.mdx b/docs/api/beta/list-workflow-library-triggers.api.mdx index 012fd59e4..cd04381a4 100644 --- a/docs/api/beta/list-workflow-library-triggers.api.mdx +++ b/docs/api/beta/list-workflow-library-triggers.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Workflow Library Triggers

    @@ -32,7 +30,7 @@ This lists the workflow triggers available to you ## Request -

    Query Parameters

    +

    Query Parameters

    List of workflow triggers @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-workflows.api.mdx b/docs/api/beta/list-workflows.api.mdx index 5c7a33cde..f069b9e1e 100644 --- a/docs/api/beta/list-workflows.api.mdx +++ b/docs/api/beta/list-workflows.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Workflows

    @@ -32,7 +30,7 @@ List all workflows in the tenant. ## Request -
    +
    List of workflows @@ -88,7 +86,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -104,4 +102,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-workgroup-members.api.mdx b/docs/api/beta/list-workgroup-members.api.mdx index 8f3692724..8b2186eb9 100644 --- a/docs/api/beta/list-workgroup-members.api.mdx +++ b/docs/api/beta/list-workgroup-members.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Governance Group Members

    @@ -32,7 +30,7 @@ This API returns list of members associated with a Governance Group. ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    List all members associated with a Governance Group. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/list-workgroups.api.mdx b/docs/api/beta/list-workgroups.api.mdx index 0840b63c0..1f3ae4dd2 100644 --- a/docs/api/beta/list-workgroups.api.mdx +++ b/docs/api/beta/list-workgroups.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Governance Groups

    @@ -32,7 +30,7 @@ This API returns list of Governance Groups ## Request -

    Query Parameters

    +

    Query Parameters

    List of Governance Groups @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/move.api.mdx b/docs/api/beta/move.api.mdx index 6b5422d1d..dcca9cc5d 100644 --- a/docs/api/beta/move.api.mdx +++ b/docs/api/beta/move.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Reassign Certifications

    @@ -36,7 +34,7 @@ This API reassigns the specified certifications from one identity to another. A ## Request -

    Path Parameters

    Body

    required
      = 1`, `<= 250`"} schema={{"description":"List of certification IDs to reassign","type":"array","items":{"type":"string"},"minItems":1,"maxItems":250,"example":["af3859464779471211bb8424a563abc1","af3859464779471211bb8424a563abc2","af3859464779471211bb8424a563abc3"]}}>
      reassignTo object
    +

    Path Parameters

    Body

    required
      = 1`, `<= 250`"} schema={{"description":"List of certification IDs to reassign","type":"array","items":{"type":"string"},"minItems":1,"maxItems":250,"example":["af3859464779471211bb8424a563abc1","af3859464779471211bb8424a563abc2","af3859464779471211bb8424a563abc3"]}}>
      reassignTo object
    The reassign task that has been submitted. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -84,7 +82,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -100,4 +98,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/patch-access-profile.api.mdx b/docs/api/beta/patch-access-profile.api.mdx index 98c06b58e..c12c547a3 100644 --- a/docs/api/beta/patch-access-profile.api.mdx +++ b/docs/api/beta/patch-access-profile.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Patch a specified Access Profile

    @@ -59,7 +57,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • Responds with the Access Profile as updated. @@ -127,7 +125,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -143,4 +141,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/patch-campaign-template.api.mdx b/docs/api/beta/patch-campaign-template.api.mdx index 6c9aca5bd..011b2c878 100644 --- a/docs/api/beta/patch-campaign-template.api.mdx +++ b/docs/api/beta/patch-campaign-template.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update a Campaign Template

    @@ -67,7 +65,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • Indicates the PATCH operation succeeded, and returns the template's new representation. @@ -147,7 +145,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -159,7 +157,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -175,4 +173,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/patch-entitlement.api.mdx b/docs/api/beta/patch-entitlement.api.mdx index 44e5d1a6b..f6d461bad 100644 --- a/docs/api/beta/patch-entitlement.api.mdx +++ b/docs/api/beta/patch-entitlement.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Patch an entitlement

    @@ -58,7 +56,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • Responds with the entitlement as updated. @@ -102,7 +100,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -114,7 +112,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -130,4 +128,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/patch-form-definition.api.mdx b/docs/api/beta/patch-form-definition.api.mdx index ff4597180..9bb35b319 100644 --- a/docs/api/beta/patch-form-definition.api.mdx +++ b/docs/api/beta/patch-form-definition.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Patch a form definition.

    @@ -36,7 +34,7 @@ Parameter `{formDefinitionID}` should match a form definition ID. Body is the request payload to patch a form definition, check: https://jsonpatch.com -
    +
    • Array [
      • property name* object
    • ]
    Returns the form definition updated diff --git a/docs/api/beta/patch-form-instance.api.mdx b/docs/api/beta/patch-form-instance.api.mdx index dd2bd154d..7251c9b99 100644 --- a/docs/api/beta/patch-form-instance.api.mdx +++ b/docs/api/beta/patch-form-instance.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Patch a form instance.

    @@ -36,7 +34,7 @@ Parameter `{formInstanceID}` should match a form instance ID. Body is the request payload to patch a form instance, check: https://jsonpatch.com -
    • Array [
      • property name* object
    • ]
    +
    • Array [
      • property name* object
    • ]
    Returns the form instance updated diff --git a/docs/api/beta/patch-non-employee-record.api.mdx b/docs/api/beta/patch-non-employee-record.api.mdx index 36c3beea7..1ad254ef9 100644 --- a/docs/api/beta/patch-non-employee-record.api.mdx +++ b/docs/api/beta/patch-non-employee-record.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Patch Non-Employee Record

    @@ -56,7 +54,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • A patched non-employee record. @@ -92,7 +90,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -104,7 +102,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -120,4 +118,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/patch-non-employee-schema-attribute.api.mdx b/docs/api/beta/patch-non-employee-schema-attribute.api.mdx index cbe8bf54a..a175f98b3 100644 --- a/docs/api/beta/patch-non-employee-schema-attribute.api.mdx +++ b/docs/api/beta/patch-non-employee-schema-attribute.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Patch Non-Employee Source's Schema Attribute

    @@ -57,7 +55,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • The Schema Attribute was successfully patched. @@ -89,7 +87,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -101,7 +99,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -117,4 +115,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/patch-non-employee-source.api.mdx b/docs/api/beta/patch-non-employee-source.api.mdx index ebe2d6d05..3a09a2ca8 100644 --- a/docs/api/beta/patch-non-employee-source.api.mdx +++ b/docs/api/beta/patch-non-employee-source.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Patch a Non-Employee Source

    @@ -56,7 +54,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • A patched non-employee source object. @@ -96,7 +94,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -112,4 +110,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/patch-oauth-client.api.mdx b/docs/api/beta/patch-oauth-client.api.mdx index c521e82e2..42907bbe7 100644 --- a/docs/api/beta/patch-oauth-client.api.mdx +++ b/docs/api/beta/patch-oauth-client.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Patch OAuth Client

    @@ -74,7 +72,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • Indicates the PATCH operation succeeded, and returns the OAuth client's new representation. @@ -106,7 +104,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -118,7 +116,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -134,4 +132,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/patch-org-config.api.mdx b/docs/api/beta/patch-org-config.api.mdx index 6cd3f0f86..b111b27cd 100644 --- a/docs/api/beta/patch-org-config.api.mdx +++ b/docs/api/beta/patch-org-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Patch an Org configuration property

    @@ -56,7 +54,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • The Org was successfully patched. @@ -88,7 +86,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -100,7 +98,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -116,4 +114,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/patch-personal-access-token.api.mdx b/docs/api/beta/patch-personal-access-token.api.mdx index 10e1a09b6..233917383 100644 --- a/docs/api/beta/patch-personal-access-token.api.mdx +++ b/docs/api/beta/patch-personal-access-token.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Patch Personal Access Token

    @@ -61,7 +59,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • Indicates the PATCH operation succeeded, and returns the PAT's new representation. @@ -97,7 +95,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -109,7 +107,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -125,4 +123,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/patch-potential-role.api.mdx b/docs/api/beta/patch-potential-role.api.mdx index 87dd56409..5f267b081 100644 --- a/docs/api/beta/patch-potential-role.api.mdx +++ b/docs/api/beta/patch-potential-role.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update a potential role

    @@ -44,7 +42,7 @@ The following fields can be modified: ## Request -

    Path Parameters

    Body

    arrayrequired
    • Array [
    • ]
    +

    Path Parameters

    Body

    arrayrequired
    • Array [
    • ]
    Succeeded. Returns the potential role summary based on the potentialRoleId provided. @@ -92,7 +90,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -104,7 +102,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -120,4 +118,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/patch-role-mining-session.api.mdx b/docs/api/beta/patch-role-mining-session.api.mdx index 616deb24a..7929378af 100644 --- a/docs/api/beta/patch-role-mining-session.api.mdx +++ b/docs/api/beta/patch-role-mining-session.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Patch a role mining session

    @@ -56,7 +54,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • Accepted - Returned if the request was successfully accepted into the system. @@ -92,7 +90,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -104,7 +102,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -120,4 +118,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/patch-role.api.mdx b/docs/api/beta/patch-role.api.mdx index 01434e2ee..889572baa 100644 --- a/docs/api/beta/patch-role.api.mdx +++ b/docs/api/beta/patch-role.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Patch a specified Role

    @@ -56,7 +54,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • Responds with the Role as updated. @@ -144,7 +142,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -160,4 +158,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/patch-search-attribute-config.api.mdx b/docs/api/beta/patch-search-attribute-config.api.mdx index 97bd47663..09f16f35a 100644 --- a/docs/api/beta/patch-search-attribute-config.api.mdx +++ b/docs/api/beta/patch-search-attribute-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update the details of a specific extended search attribute in IdentityNow.

    @@ -54,7 +52,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • Responds with the Search Attribute Configuration as updated. @@ -86,7 +84,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -98,7 +96,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -114,4 +112,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/patch-segment.api.mdx b/docs/api/beta/patch-segment.api.mdx index ee9f3ef6e..b274d0661 100644 --- a/docs/api/beta/patch-segment.api.mdx +++ b/docs/api/beta/patch-segment.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Segment

    @@ -50,7 +48,7 @@ The following fields are patchable: object -
  • ]
    • +
  • ]
    • Indicates the PATCH operation succeeded, and returns the segment's new representation. @@ -90,7 +88,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -102,7 +100,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -118,4 +116,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/patch-service-desk-integration.api.mdx b/docs/api/beta/patch-service-desk-integration.api.mdx index 0116512d6..0f6d65c6b 100644 --- a/docs/api/beta/patch-service-desk-integration.api.mdx +++ b/docs/api/beta/patch-service-desk-integration.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Service Desk Integration Update PATCH

    @@ -65,7 +63,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • ServiceDeskIntegrationDto as updated @@ -125,7 +123,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -137,7 +135,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -153,4 +151,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/patch-sod-policy.api.mdx b/docs/api/beta/patch-sod-policy.api.mdx index 6085bf716..30048bc2b 100644 --- a/docs/api/beta/patch-sod-policy.api.mdx +++ b/docs/api/beta/patch-sod-policy.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Patch a SOD policy

    @@ -60,7 +58,7 @@ The following fields are patchable: object -
  • ]
    • +
  • ]
    • Indicates the PATCH operation succeeded, and returns the SOD policy's new representation. @@ -108,7 +106,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -120,7 +118,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -136,4 +134,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/patch-subscription.api.mdx b/docs/api/beta/patch-subscription.api.mdx index 3400c2696..213e02e47 100644 --- a/docs/api/beta/patch-subscription.api.mdx +++ b/docs/api/beta/patch-subscription.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Patch a Subscription

    @@ -54,7 +52,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • Updated subscription. @@ -102,7 +100,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -114,7 +112,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -130,4 +128,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/patch-workflow.api.mdx b/docs/api/beta/patch-workflow.api.mdx index 11cf2d861..f8ef40a2c 100644 --- a/docs/api/beta/patch-workflow.api.mdx +++ b/docs/api/beta/patch-workflow.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Patch Workflow

    @@ -52,7 +50,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • The Workflow object @@ -108,7 +106,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -124,4 +122,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/patch-workgroup.api.mdx b/docs/api/beta/patch-workgroup.api.mdx index b82dcaf19..ba92c6d53 100644 --- a/docs/api/beta/patch-workgroup.api.mdx +++ b/docs/api/beta/patch-workgroup.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Patch a Governance Group

    @@ -58,7 +56,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • A Governance Group. @@ -94,7 +92,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -110,4 +108,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/peek-resource-objects.api.mdx b/docs/api/beta/peek-resource-objects.api.mdx index ab158e39c..5668f90eb 100644 --- a/docs/api/beta/peek-resource-objects.api.mdx +++ b/docs/api/beta/peek-resource-objects.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Peek source connector's resource objects

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    List of resource objects that was fetched from the source connector. @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -81,7 +79,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -97,4 +95,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/ping-cluster.api.mdx b/docs/api/beta/ping-cluster.api.mdx index bd2b90ae8..014685ad1 100644 --- a/docs/api/beta/ping-cluster.api.mdx +++ b/docs/api/beta/ping-cluster.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Ping cluster for source connector

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    The result of pinging connection with the source connector. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/ping-verification-status.api.mdx b/docs/api/beta/ping-verification-status.api.mdx index 819eb2153..38b964297 100644 --- a/docs/api/beta/ping-verification-status.api.mdx +++ b/docs/api/beta/ping-verification-status.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Polling MFA method by VerificationPollRequest

    @@ -32,7 +30,7 @@ This API poll the VerificationPollRequest for the specified MFA method. A token ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    MFA VerificationPollRequest status an MFA method. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/post-external-execute-workflow.api.mdx b/docs/api/beta/post-external-execute-workflow.api.mdx index 7184e70a3..58571fa02 100644 --- a/docs/api/beta/post-external-execute-workflow.api.mdx +++ b/docs/api/beta/post-external-execute-workflow.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Execute Workflow via External Trigger

    @@ -32,7 +30,7 @@ This endpoint allows a service outside of IdentityNow to initiate a workflow tha ## Request -

    Path Parameters

    Body

    +

    Path Parameters

    Body

    The Workflow object @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/post-workflow-external-trigger.api.mdx b/docs/api/beta/post-workflow-external-trigger.api.mdx index c2fb6318a..187bec61a 100644 --- a/docs/api/beta/post-workflow-external-trigger.api.mdx +++ b/docs/api/beta/post-workflow-external-trigger.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Generate External Trigger OAuth Client

    @@ -32,7 +30,7 @@ Create OAuth client ID, client secret, and callback URL for use in an external t ## Request -

    Path Parameters

    +

    Path Parameters

    The OAuth Client object @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/put-account.api.mdx b/docs/api/beta/put-account.api.mdx index c89563c2b..0f7c46e6f 100644 --- a/docs/api/beta/put-account.api.mdx +++ b/docs/api/beta/put-account.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Account

    @@ -35,7 +33,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    Async task details. @@ -67,7 +65,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -79,7 +77,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -95,4 +93,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/put-client-log-configuration.api.mdx b/docs/api/beta/put-client-log-configuration.api.mdx index 6a324e908..7e8eab7e8 100644 --- a/docs/api/beta/put-client-log-configuration.api.mdx +++ b/docs/api/beta/put-client-log-configuration.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update managed cluster's log configuration

    @@ -40,7 +38,7 @@ ClientLogConfiguration for given ManagedCluster Map of log level by key. The keys are logging classes, and the values are logging levels. To see the available connectors and their logging classes, refer to the "Logging Classes" table in [Enabling Connector Logging in IdentityNow](https://community.sailpoint.com/t5/IdentityNow-Articles/Enabling-Connector-Logging-in-IdentityNow/ta-p/188107). -
    +
    Responds with updated ClientLogConfiguration for given ManagedCluster @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -88,7 +86,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -104,4 +102,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/put-entitlement-request-config.api.mdx b/docs/api/beta/put-entitlement-request-config.api.mdx index 3eca983db..eaa484efe 100644 --- a/docs/api/beta/put-entitlement-request-config.api.mdx +++ b/docs/api/beta/put-entitlement-request-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Replace Entitlement Request Config

    @@ -36,7 +34,7 @@ This API replaces the entitlement request config for a specified entitlement. Ordered list of approval steps for the access request. Empty when no approval is required. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Responds with the entitlement request config as updated. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -84,7 +82,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -100,4 +98,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/put-identity-attribute.api.mdx b/docs/api/beta/put-identity-attribute.api.mdx index 9fa5378f1..f7a7bc5af 100644 --- a/docs/api/beta/put-identity-attribute.api.mdx +++ b/docs/api/beta/put-identity-attribute.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Identity Attribute

    @@ -36,7 +34,7 @@ This updates an existing identity attribute. Making an attribute searchable req List of sources for an attribute, this specifies how the value of the rule is derived -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • The identity attribute was updated successfully @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -84,7 +82,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -100,4 +98,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/put-mail-from-attributes.api.mdx b/docs/api/beta/put-mail-from-attributes.api.mdx index 41d87b36b..b642a1849 100644 --- a/docs/api/beta/put-mail-from-attributes.api.mdx +++ b/docs/api/beta/put-mail-from-attributes.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Change MAIL FROM domain

    @@ -32,7 +30,7 @@ Change the MAIL FROM domain of an AWS SES email identity and provide the MX and ## Request -

    Body

    required
    +

    Body

    required
    MAIL FROM Attributes required to verify the change @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/put-native-change-detection-config.api.mdx b/docs/api/beta/put-native-change-detection-config.api.mdx index 0c792d4b9..f1587ef9b 100644 --- a/docs/api/beta/put-native-change-detection-config.api.mdx +++ b/docs/api/beta/put-native-change-detection-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Native Change Detection Configuration

    @@ -34,7 +32,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    Updated native change detection configuration for a source @@ -66,7 +64,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -78,7 +76,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -94,4 +92,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/put-notification-preference.api.mdx b/docs/api/beta/put-notification-preference.api.mdx index ddb8d456e..67dcdf7f1 100644 --- a/docs/api/beta/put-notification-preference.api.mdx +++ b/docs/api/beta/put-notification-preference.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Overwrite preferences notification key.

    @@ -32,7 +30,7 @@ Allows admins to opt in to or out of certain notifications for their org. The de ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    The preferences were successfully replaced, and an echo of the new preferences are sent back to caller. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/put-password-dictionary.api.mdx b/docs/api/beta/put-password-dictionary.api.mdx index 32d3bc0f3..d3a07eb87 100644 --- a/docs/api/beta/put-password-dictionary.api.mdx +++ b/docs/api/beta/put-password-dictionary.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Password Dictionary

    @@ -65,7 +63,7 @@ qazxsws The password dictionary file to be uploaded. -
    +
    Successfully updated. @@ -101,7 +99,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -113,7 +111,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -129,4 +127,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/put-password-org-config.api.mdx b/docs/api/beta/put-password-org-config.api.mdx index 305a12a06..5bfbea309 100644 --- a/docs/api/beta/put-password-org-config.api.mdx +++ b/docs/api/beta/put-password-org-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Password Org Config

    @@ -34,7 +32,7 @@ Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config: ## Request -

    Body

    required
      = 1` and `<= 60`"} schema={{"type":"integer","format":"int32","description":"The duration of \"digit token\" in minutes. The default value is 5.","minimum":1,"maximum":60,"default":5,"example":10}}>= 6` and `<= 18`"} schema={{"type":"integer","format":"int32","description":"The length of \"digit token\". The default value is 6.","minimum":6,"maximum":18,"default":6,"example":9}}>
    +

    Body

    required
      = 1` and `<= 60`"} schema={{"type":"integer","format":"int32","description":"The duration of \"digit token\" in minutes. The default value is 5.","minimum":1,"maximum":60,"default":5,"example":10}}>= 6` and `<= 18`"} schema={{"type":"integer","format":"int32","description":"The length of \"digit token\". The default value is 6.","minimum":6,"maximum":18,"default":6,"example":9}}>
    Reference to the password org config. @@ -66,7 +64,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -82,4 +80,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/put-policy-schedule.api.mdx b/docs/api/beta/put-policy-schedule.api.mdx index e221ef64a..5b79abf4a 100644 --- a/docs/api/beta/put-policy-schedule.api.mdx +++ b/docs/api/beta/put-policy-schedule.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update SOD Policy schedule

    @@ -59,7 +57,7 @@ If `type` is `MONTHLY` or `ANNUALLY`, the values will be a number in double quot The hours selected. -
    recipients object[]
  • Array [
  • ]
    • +
    recipients object[]
  • Array [
  • ]
    • SOD policy by ID. @@ -113,7 +111,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -129,4 +127,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/put-provisioning-policy.api.mdx b/docs/api/beta/put-provisioning-policy.api.mdx index 1cd92b26a..a6dbe3902 100644 --- a/docs/api/beta/put-provisioning-policy.api.mdx +++ b/docs/api/beta/put-provisioning-policy.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Provisioning Policy by UsageType

    @@ -35,7 +33,7 @@ A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is requi ## Request -

    Path Parameters

    Body

    required
      fields object[]
    • Array [
    • ]
    +

    Path Parameters

    Body

    required
      fields object[]
    • Array [
    • ]
    The ProvisioningPolicyDto was successfully replaced. @@ -67,7 +65,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -79,7 +77,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -95,4 +93,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/put-reassignment-config.api.mdx b/docs/api/beta/put-reassignment-config.api.mdx index 7ebfdd07f..5e7120ad2 100644 --- a/docs/api/beta/put-reassignment-config.api.mdx +++ b/docs/api/beta/put-reassignment-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Reassignment Configuration

    @@ -32,7 +30,7 @@ Replaces existing Reassignment configuration for an identity with the newly prov ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    Reassignment Configuration updated @@ -88,7 +86,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -104,4 +102,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/put-service-desk-integration.api.mdx b/docs/api/beta/put-service-desk-integration.api.mdx index 4f2fb8b07..dd328fabc 100644 --- a/docs/api/beta/put-service-desk-integration.api.mdx +++ b/docs/api/beta/put-service-desk-integration.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update a Service Desk integration

    @@ -64,7 +62,7 @@ Service Desk integration's attributes. Validation constraints enforced by the im Before Provisioning Rule. -
    +
    ServiceDeskIntegrationDto as updated @@ -124,7 +122,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -136,7 +134,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -152,4 +150,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/put-sod-policy.api.mdx b/docs/api/beta/put-sod-policy.api.mdx index fce0e30ed..dccdda120 100644 --- a/docs/api/beta/put-sod-policy.api.mdx +++ b/docs/api/beta/put-sod-policy.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update SOD policy by ID

    @@ -53,7 +51,7 @@ List of criteria. There is a min of 1 and max of 50 items in the list. List of criteria. There is a min of 1 and max of 50 items in the list. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • SOD Policy by ID @@ -101,7 +99,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -113,7 +111,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -129,4 +127,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/put-source-attr-sync-config.api.mdx b/docs/api/beta/put-source-attr-sync-config.api.mdx index 2a272747f..6c855634d 100644 --- a/docs/api/beta/put-source-attr-sync-config.api.mdx +++ b/docs/api/beta/put-source-attr-sync-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Attribute Sync Config

    @@ -42,7 +40,7 @@ Target source for attribute synchronization. Attribute synchronization configuration for specific identity attributes in the context of a source -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Updated attribute synchronization configuration for a source @@ -82,7 +80,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -94,7 +92,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -110,4 +108,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/put-source-schema.api.mdx b/docs/api/beta/put-source-schema.api.mdx index b9945d8b3..f788a8a5e 100644 --- a/docs/api/beta/put-source-schema.api.mdx +++ b/docs/api/beta/put-source-schema.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Source Schema (Full)

    @@ -45,7 +43,7 @@ The attribute definitions which form the schema. A reference to the schema on the source to the attribute values map to. -
  • ]
    • +
  • ]
    • The Schema was successfully replaced. @@ -85,7 +83,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -97,7 +95,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -113,4 +111,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/put-source.api.mdx b/docs/api/beta/put-source.api.mdx index 511f63b26..afa007421 100644 --- a/docs/api/beta/put-source.api.mdx +++ b/docs/api/beta/put-source.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Source (Full)

    @@ -87,7 +85,7 @@ List of references to the associated PasswordPolicy objects. Reference to Management Workgroup for this Source -
    +
    Updated Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design. @@ -159,7 +157,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -171,7 +169,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -187,4 +185,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/put-tagged-object.api.mdx b/docs/api/beta/put-tagged-object.api.mdx index 01ddf757d..6d3533475 100644 --- a/docs/api/beta/put-tagged-object.api.mdx +++ b/docs/api/beta/put-tagged-object.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Tagged Object

    @@ -32,7 +30,7 @@ This updates a tagged object for the specified type. ## Request -

    Path Parameters

    Body

    required
      objectRef object
    +

    Path Parameters

    Body

    required
      objectRef object
    Tagged object by type and ID. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/put-tenant-configuration.api.mdx b/docs/api/beta/put-tenant-configuration.api.mdx index bbde93e6b..9460e022d 100644 --- a/docs/api/beta/put-tenant-configuration.api.mdx +++ b/docs/api/beta/put-tenant-configuration.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Tenant-wide Reassignment Configuration settings

    @@ -36,7 +34,7 @@ Replaces existing Tenant-wide Reassignment Configuration settings with the newly Details of any tenant-wide Reassignment Configurations (eg. enabled/disabled) -
    +
    Tenant-wide Reassignment Configuration settings @@ -84,7 +82,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -100,4 +98,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/query-password-info.api.mdx b/docs/api/beta/query-password-info.api.mdx index b68c9e738..01ed96610 100644 --- a/docs/api/beta/query-password-info.api.mdx +++ b/docs/api/beta/query-password-info.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Query Password Info

    @@ -40,7 +38,7 @@ will be returned. ## Request -

    Body

    required
    +

    Body

    required
    Reference to the password info. @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/reject-access-request.api.mdx b/docs/api/beta/reject-access-request.api.mdx index 1b3fc8db5..69e07f3d7 100644 --- a/docs/api/beta/reject-access-request.api.mdx +++ b/docs/api/beta/reject-access-request.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Rejects an access request approval.

    @@ -36,7 +34,7 @@ This endpoint rejects an access request approval. Only the owner of the approval Reviewer's comment. -
    +
      author object
    Accepted - Returned if the request was successfully accepted into the system. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -84,7 +82,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -100,4 +98,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/reject-approval-item.api.mdx b/docs/api/beta/reject-approval-item.api.mdx index d7db2b935..8afe276b4 100644 --- a/docs/api/beta/reject-approval-item.api.mdx +++ b/docs/api/beta/reject-approval-item.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Reject an Approval Item

    @@ -32,7 +30,7 @@ This API rejects an Approval Item. Either an admin, or the owning/current user m ## Request -

    Path Parameters

    +

    Path Parameters

    A work items details object. @@ -60,7 +58,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -72,4 +70,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 404 response object

     \ No newline at end of file diff --git a/docs/api/beta/reject-approval-items-in-bulk.api.mdx b/docs/api/beta/reject-approval-items-in-bulk.api.mdx index a5765c795..c92f6a746 100644 --- a/docs/api/beta/reject-approval-items-in-bulk.api.mdx +++ b/docs/api/beta/reject-approval-items-in-bulk.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Bulk reject Approval Items

    @@ -32,7 +30,7 @@ This API bulk rejects Approval Items. Either an admin, or the owning/current use ## Request -

    Path Parameters

    +

    Path Parameters

    A work items details object. @@ -60,7 +58,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -72,4 +70,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 404 response object

     \ No newline at end of file diff --git a/docs/api/beta/reject-non-employee-request.api.mdx b/docs/api/beta/reject-non-employee-request.api.mdx index 342bf9cbd..468c3f92a 100644 --- a/docs/api/beta/reject-non-employee-request.api.mdx +++ b/docs/api/beta/reject-non-employee-request.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Reject a Non-Employee Request

    @@ -32,7 +30,7 @@ This endpoint will reject an approval item request and notify user. ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    Non-Employee approval item object. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/reload-account.api.mdx b/docs/api/beta/reload-account.api.mdx index 74887e1d7..9ea45e64f 100644 --- a/docs/api/beta/reload-account.api.mdx +++ b/docs/api/beta/reload-account.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Reload Account

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    Async task details @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/search-form-definitions-by-tenant.api.mdx b/docs/api/beta/search-form-definitions-by-tenant.api.mdx index c13eac572..91a2c410d 100644 --- a/docs/api/beta/search-form-definitions-by-tenant.api.mdx +++ b/docs/api/beta/search-form-definitions-by-tenant.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Export form definitions by tenant.

    @@ -32,7 +30,7 @@ No parameters required. ## Request -

    Query Parameters

    +

    Query Parameters

    Returns a list of form definitions by tenant diff --git a/docs/api/beta/search-form-element-data-by-element-id.api.mdx b/docs/api/beta/search-form-element-data-by-element-id.api.mdx index fc869bd88..e98877244 100644 --- a/docs/api/beta/search-form-element-data-by-element-id.api.mdx +++ b/docs/api/beta/search-form-element-data-by-element-id.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Retrieves dynamic data by element.

    @@ -33,7 +31,7 @@ Parameter `{formElementID}` should match a form element ID at the data source co ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Retrieves dynamic data to aid in correctly completing a valid form by form element ID from data source configuration diff --git a/docs/api/beta/search-form-instances-by-tenant.api.mdx b/docs/api/beta/search-form-instances-by-tenant.api.mdx index 1a01fed0b..fa29648f2 100644 --- a/docs/api/beta/search-form-instances-by-tenant.api.mdx +++ b/docs/api/beta/search-form-instances-by-tenant.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List form instances by tenant.

    @@ -32,7 +30,7 @@ No parameters required. ## Request -
    +
    Returns a list of form instances by tenant diff --git a/docs/api/beta/search-pre-defined-select-options.api.mdx b/docs/api/beta/search-pre-defined-select-options.api.mdx index 53c2890ce..6e32449ef 100644 --- a/docs/api/beta/search-pre-defined-select-options.api.mdx +++ b/docs/api/beta/search-pre-defined-select-options.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List predefined select options.

    @@ -32,7 +30,7 @@ No parameters required. ## Request -
    +
    Returns a list of available predefined select options diff --git a/docs/api/beta/send-duo-verify-request.api.mdx b/docs/api/beta/send-duo-verify-request.api.mdx index 37532339d..ad3dc55de 100644 --- a/docs/api/beta/send-duo-verify-request.api.mdx +++ b/docs/api/beta/send-duo-verify-request.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Verifying authentication via Duo method

    @@ -32,7 +30,7 @@ This API Authenticates the user via Duo-Web MFA method. ## Request -

    Body

    required
    +

    Body

    required
    The status of verification request. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/beta/send-kba-answers.api.mdx b/docs/api/beta/send-kba-answers.api.mdx index 391c8a701..b4eea8af9 100644 --- a/docs/api/beta/send-kba-answers.api.mdx +++ b/docs/api/beta/send-kba-answers.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Authenticate KBA provided MFA method

    @@ -36,7 +34,7 @@ This API Authenticate user in KBA MFA method. Kba answers -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • KBA authenticated status. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/beta/send-okta-verify-request.api.mdx b/docs/api/beta/send-okta-verify-request.api.mdx index 4aea47766..ec061ee38 100644 --- a/docs/api/beta/send-okta-verify-request.api.mdx +++ b/docs/api/beta/send-okta-verify-request.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Verifying authentication via Okta method

    @@ -32,7 +30,7 @@ This API Authenticates the user via Okta-Verify MFA method. Request requires a h ## Request -

    Body

    required
    +

    Body

    required
    The status of verification request. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/send-test-notification.api.mdx b/docs/api/beta/send-test-notification.api.mdx index 33aacd9d2..209174fe9 100644 --- a/docs/api/beta/send-test-notification.api.mdx +++ b/docs/api/beta/send-test-notification.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Send Test Notification

    @@ -32,7 +30,7 @@ Send a Test Notification ## Request -

    Body

    required
    +

    Body

    required
    No content - indicates the request was successful but there is no content to be returned in the response. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/send-token-auth-request.api.mdx b/docs/api/beta/send-token-auth-request.api.mdx index e005e994d..cdada7187 100644 --- a/docs/api/beta/send-token-auth-request.api.mdx +++ b/docs/api/beta/send-token-auth-request.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Authenticate Token provided MFA method

    @@ -32,7 +30,7 @@ This API Authenticate user in Token MFA method. ## Request -

    Body

    required
    +

    Body

    required
    Token authenticated status. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/set-access-request-config.api.mdx b/docs/api/beta/set-access-request-config.api.mdx index e4859dc6b..abfe93c61 100644 --- a/docs/api/beta/set-access-request-config.api.mdx +++ b/docs/api/beta/set-access-request-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Access Request Configuration

    @@ -45,7 +43,7 @@ Approval Reminder and Escalation Configuration. Entitlement Request Configuration. -
    +
    Access Request Configuration Details. @@ -89,7 +87,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -105,4 +103,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/set-campaign-reports-config.api.mdx b/docs/api/beta/set-campaign-reports-config.api.mdx index c929a6d61..96243a26c 100644 --- a/docs/api/beta/set-campaign-reports-config.api.mdx +++ b/docs/api/beta/set-campaign-reports-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Set Campaign Reports Configuration

    @@ -41,7 +39,7 @@ Requires roles CERT_ADMIN and ORG_ADMIN. Campaign Report Configuration -
    +
    The persisted Campaign Report Configuration @@ -73,7 +71,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -89,4 +87,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/set-campaign-template-schedule.api.mdx b/docs/api/beta/set-campaign-template-schedule.api.mdx index 9862f3601..ef1c183f3 100644 --- a/docs/api/beta/set-campaign-template-schedule.api.mdx +++ b/docs/api/beta/set-campaign-template-schedule.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Sets a Campaign Template's Schedule

    @@ -108,7 +106,7 @@ At 5AM, noon, and 5PM: * values "5", "12", "17" -
    +
    No content - indicates the request was successful but there is no content to be returned in the response. @@ -140,7 +138,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -152,7 +150,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -168,4 +166,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/set-identity-password.api.mdx b/docs/api/beta/set-identity-password.api.mdx index dace028d2..a8d732cf4 100644 --- a/docs/api/beta/set-identity-password.api.mdx +++ b/docs/api/beta/set-identity-password.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Set Identity's Password

    @@ -73,7 +71,7 @@ You can then use [Get Password Change Request Status](https://developer.sailpoin ## Request -

    Body

    required
    +

    Body

    required
    Reference to the password change. @@ -105,7 +103,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -121,4 +119,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/set-mfa-duo-config.api.mdx b/docs/api/beta/set-mfa-duo-config.api.mdx index 76443db0b..665b41a28 100644 --- a/docs/api/beta/set-mfa-duo-config.api.mdx +++ b/docs/api/beta/set-mfa-duo-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Set Duo MFA configuration

    @@ -36,7 +34,7 @@ This API sets the configuration of an Duo MFA method. A token with ORG_ADMIN aut A map with additional config properties for the given MFA method - duo-web. -
    +
    MFA configuration of an Duo MFA method. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -88,4 +86,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/set-mfa-okta-config.api.mdx b/docs/api/beta/set-mfa-okta-config.api.mdx index 9deb42b09..8f718ca44 100644 --- a/docs/api/beta/set-mfa-okta-config.api.mdx +++ b/docs/api/beta/set-mfa-okta-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Set Okta MFA configuration

    @@ -32,7 +30,7 @@ This API sets the configuration of an Okta MFA method. A token with ORG_ADMIN au ## Request -

    Body

    required
    +

    Body

    required
    MFA configuration of an Okta MFA method. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/set-tag-to-object.api.mdx b/docs/api/beta/set-tag-to-object.api.mdx index 79ed8a901..cf254cb8b 100644 --- a/docs/api/beta/set-tag-to-object.api.mdx +++ b/docs/api/beta/set-tag-to-object.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Add Tag to Object

    @@ -34,7 +32,7 @@ Any authenticated token may be used to call this API. ## Request -

    Body

    required
      objectRef object
    +

    Body

    required
      objectRef object
    Created. @@ -66,7 +64,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -82,4 +80,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/set-tags-to-many-objects.api.mdx b/docs/api/beta/set-tags-to-many-objects.api.mdx index 764a83b3e..29f6f494e 100644 --- a/docs/api/beta/set-tags-to-many-objects.api.mdx +++ b/docs/api/beta/set-tags-to-many-objects.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Tag Multiple Objects

    @@ -38,7 +36,7 @@ A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. -
    +
      objectRefs object[]
    • Array [
    • ]
    Request succeeded. @@ -70,7 +68,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -86,4 +84,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/show-preview-data-source.api.mdx b/docs/api/beta/show-preview-data-source.api.mdx index 4c81e30c7..7f62591b3 100644 --- a/docs/api/beta/show-preview-data-source.api.mdx +++ b/docs/api/beta/show-preview-data-source.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Preview form definition data source.

    @@ -36,7 +34,7 @@ Preview form definition data source. Body is the request payload to create a form definition dynamic schema -
    +
      dataSource object
      config object
    Returns a preview of a form definition data source diff --git a/docs/api/beta/sidebar.js b/docs/api/beta/sidebar.js index 9ff160714..fd4bee207 100644 --- a/docs/api/beta/sidebar.js +++ b/docs/api/beta/sidebar.js @@ -1 +1 @@ -module.exports = [{"type":"doc","id":"api/beta/identitynow-beta-api"},{"type":"category","label":"Access Profiles","link":{"type":"doc","id":"api/beta/access-profiles"},"items":[{"type":"doc","id":"api/beta/list-access-profiles","label":"List Access Profiles","className":"api-method get"},{"type":"doc","id":"api/beta/create-access-profile","label":"Create an Access Profile","className":"api-method post"},{"type":"doc","id":"api/beta/get-access-profile","label":"Get an Access Profile","className":"api-method get"},{"type":"doc","id":"api/beta/patch-access-profile","label":"Patch a specified Access Profile","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-access-profile","label":"Delete the specified Access Profile","className":"api-method delete"},{"type":"doc","id":"api/beta/delete-access-profiles-in-bulk","label":"Delete Access Profile(s)","className":"api-method post"},{"type":"doc","id":"api/beta/update-access-profiles-in-bulk","label":"Update Access Profile(s) requestable field.","className":"api-method post"},{"type":"doc","id":"api/beta/get-access-profile-entitlements","label":"List Access Profile's Entitlements","className":"api-method get"}]},{"type":"category","label":"Access Request Approvals","link":{"type":"doc","id":"api/beta/access-request-approvals"},"items":[{"type":"doc","id":"api/beta/list-pending-approvals","label":"Pending Access Request Approvals List","className":"api-method get"},{"type":"doc","id":"api/beta/list-completed-approvals","label":"Completed Access Request Approvals List","className":"api-method get"},{"type":"doc","id":"api/beta/approve-access-request","label":"Approves an access request approval.","className":"api-method post"},{"type":"doc","id":"api/beta/reject-access-request","label":"Rejects an access request approval.","className":"api-method post"},{"type":"doc","id":"api/beta/forward-access-request","label":"Forwards an access request approval to a new owner.","className":"api-method post"},{"type":"doc","id":"api/beta/get-access-request-approval-summary","label":"Get the number of pending, approved and rejected access requests approvals","className":"api-method get"}]},{"type":"category","label":"Access Requests","link":{"type":"doc","id":"api/beta/access-requests"},"items":[{"type":"doc","id":"api/beta/create-access-request","label":"Submit an Access Request","className":"api-method post"},{"type":"doc","id":"api/beta/cancel-access-request","label":"Cancel Access Request","className":"api-method post"},{"type":"doc","id":"api/beta/close-access-request","label":"Close Access Request","className":"api-method post"},{"type":"doc","id":"api/beta/get-access-request-config","label":"Get Access Request Configuration","className":"api-method get"},{"type":"doc","id":"api/beta/set-access-request-config","label":"Update Access Request Configuration","className":"api-method put"},{"type":"doc","id":"api/beta/list-access-request-status","label":"Access Request Status","className":"api-method get"}]},{"type":"category","label":"Access Request Identity Metrics","link":{"type":"doc","id":"api/beta/access-request-identity-metrics"},"items":[{"type":"doc","id":"api/beta/get-access-request-identity-metrics","label":"Return access request identity metrics","className":"api-method get"}]},{"type":"category","label":"Account Activities","link":{"type":"doc","id":"api/beta/account-activities"},"items":[{"type":"doc","id":"api/beta/list-account-activities","label":"List Account Activities","className":"api-method get"},{"type":"doc","id":"api/beta/get-account-activity","label":"Get Account Activity","className":"api-method get"}]},{"type":"category","label":"Account Aggregations","link":{"type":"doc","id":"api/beta/account-aggregations"},"items":[{"type":"doc","id":"api/beta/get-account-aggregation-status","label":"In-progress Account Aggregation status","className":"api-method get"}]},{"type":"category","label":"Account Usages","link":{"type":"doc","id":"api/beta/account-usages"},"items":[{"type":"doc","id":"api/beta/get-usages-by-account-id","label":"Returns account usage insights","className":"api-method get"}]},{"type":"category","label":"Accounts","link":{"type":"doc","id":"api/beta/accounts"},"items":[{"type":"doc","id":"api/beta/list-accounts","label":"Accounts List","className":"api-method get"},{"type":"doc","id":"api/beta/create-account","label":"Create Account","className":"api-method post"},{"type":"doc","id":"api/beta/get-account","label":"Account Details","className":"api-method get"},{"type":"doc","id":"api/beta/update-account","label":"Update Account","className":"api-method patch"},{"type":"doc","id":"api/beta/put-account","label":"Update Account","className":"api-method put"},{"type":"doc","id":"api/beta/delete-account","label":"Delete Account","className":"api-method delete"},{"type":"doc","id":"api/beta/get-account-entitlements","label":"Account Entitlements","className":"api-method get"},{"type":"doc","id":"api/beta/reload-account","label":"Reload Account","className":"api-method post"},{"type":"doc","id":"api/beta/enable-account","label":"Enable Account","className":"api-method post"},{"type":"doc","id":"api/beta/disable-account","label":"Disable Account","className":"api-method post"},{"type":"doc","id":"api/beta/unlock-account","label":"Unlock Account","className":"api-method post"},{"type":"doc","id":"api/beta/enable-account-for-identity","label":"Enable IDN Account for Identity","className":"api-method post"},{"type":"doc","id":"api/beta/disable-account-for-identity","label":"Disable IDN Account for Identity","className":"api-method post"},{"type":"doc","id":"api/beta/enable-accounts-for-identities","label":"Enable IDN Accounts for Identities","className":"api-method post"},{"type":"doc","id":"api/beta/disable-accounts-for-identities","label":"Disable IDN Accounts for Identities","className":"api-method post"}]},{"type":"category","label":"Certification Campaigns","link":{"type":"doc","id":"api/beta/certification-campaigns"},"items":[{"type":"doc","id":"api/beta/get-active-campaigns","label":"List Campaigns","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/create-campaign","label":"Create a campaign","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/delete-campaigns","label":"Deletes Campaigns","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/get-campaign","label":"Get a campaign","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/update-campaign","label":"Update a Campaign","className":"menu__list-item--deprecated api-method patch"},{"type":"doc","id":"api/beta/start-campaign","label":"Activate a Campaign","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/complete-campaign","label":"Complete a Campaign","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/start-campaign-remediation-scan","label":"Run Campaign Remediation Scan","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/move","label":"Reassign Certifications","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/get-campaign-reports","label":"Get Campaign Reports","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/start-campaign-report","label":"Run Campaign Report","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/get-campaign-reports-config","label":"Get Campaign Reports Configuration","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/set-campaign-reports-config","label":"Set Campaign Reports Configuration","className":"menu__list-item--deprecated api-method put"},{"type":"doc","id":"api/beta/list-campaign-templates","label":"List Campaign Templates","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/create-campaign-template","label":"Create a Campaign Template","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/get-campaign-template","label":"Get a Campaign Template","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/patch-campaign-template","label":"Update a Campaign Template","className":"menu__list-item--deprecated api-method patch"},{"type":"doc","id":"api/beta/delete-campaign-template","label":"Delete a Campaign Template","className":"menu__list-item--deprecated api-method delete"},{"type":"doc","id":"api/beta/start-generate-campaign-template","label":"Generate a Campaign from Template","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/get-campaign-template-schedule","label":"Gets a Campaign Template's Schedule","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/set-campaign-template-schedule","label":"Sets a Campaign Template's Schedule","className":"menu__list-item--deprecated api-method put"},{"type":"doc","id":"api/beta/delete-campaign-template-schedule","label":"Deletes a Campaign Template's Schedule","className":"menu__list-item--deprecated api-method delete"}]},{"type":"category","label":"Certifications","link":{"type":"doc","id":"api/beta/certifications"},"items":[{"type":"doc","id":"api/beta/submit-reassign-certs-async","label":"Reassign Certifications Asynchronously","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/get-identity-certification-task-status","label":"Certification Task Status","className":"api-method get"},{"type":"doc","id":"api/beta/get-identity-certification-pending-tasks","label":"Pending Certification Tasks","className":"api-method get"},{"type":"doc","id":"api/beta/get-identity-certification-item-permissions","label":"Permissions for Entitlement Certification Item","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/list-certification-reviewers","label":"List of Reviewers for certification","className":"menu__list-item--deprecated api-method get"}]},{"type":"category","label":"Connector Rule Management","link":{"type":"doc","id":"api/beta/connector-rule-management"},"items":[{"type":"doc","id":"api/beta/get-connector-rule-list","label":"List Connector Rules","className":"api-method get"},{"type":"doc","id":"api/beta/create-connector-rule","label":"Create Connector Rule","className":"api-method post"},{"type":"doc","id":"api/beta/get-connector-rule","label":"Connector-Rule by ID","className":"api-method get"},{"type":"doc","id":"api/beta/update-connector-rule","label":"Update a Connector Rule","className":"api-method put"},{"type":"doc","id":"api/beta/delete-connector-rule","label":"Delete a Connector-Rule","className":"api-method delete"},{"type":"doc","id":"api/beta/validate-connector-rule","label":"Validate Connector Rule","className":"api-method post"}]},{"type":"category","label":"Connectors","link":{"type":"doc","id":"api/beta/connectors"},"items":[{"type":"doc","id":"api/beta/get-connector-list","label":"Gets connector list","className":"api-method get"}]},{"type":"category","label":"Custom Forms","link":{"type":"doc","id":"api/beta/custom-forms"},"items":[{"type":"doc","id":"api/beta/search-form-definitions-by-tenant","label":"Export form definitions by tenant.","className":"api-method get"},{"type":"doc","id":"api/beta/create-form-definition","label":"Creates a form definition.","className":"api-method post"},{"type":"doc","id":"api/beta/get-form-definition-by-key","label":"Return a form definition.","className":"api-method get"},{"type":"doc","id":"api/beta/delete-form-definition","label":"Deletes a form definition.","className":"api-method delete"},{"type":"doc","id":"api/beta/patch-form-definition","label":"Patch a form definition.","className":"api-method patch"},{"type":"doc","id":"api/beta/show-preview-data-source","label":"Preview form definition data source.","className":"api-method post"},{"type":"doc","id":"api/beta/export-form-definitions-by-tenant","label":"List form definitions by tenant.","className":"api-method get"},{"type":"doc","id":"api/beta/create-form-definition-dynamic-schema","label":"Generate JSON Schema dynamically.","className":"api-method post"},{"type":"doc","id":"api/beta/import-form-definitions","label":"Import form definitions from export.","className":"api-method post"},{"type":"doc","id":"api/beta/create-form-definition-file-request","label":"Upload new form definition file.","className":"api-method post"},{"type":"doc","id":"api/beta/get-file-from-s-3","label":"Download definition file by fileId.","className":"api-method get"},{"type":"doc","id":"api/beta/search-form-instances-by-tenant","label":"List form instances by tenant.","className":"api-method get"},{"type":"doc","id":"api/beta/create-form-instance","label":"Creates a form instance.","className":"api-method post"},{"type":"doc","id":"api/beta/get-form-instance-by-key","label":"Returns a form instance.","className":"api-method get"},{"type":"doc","id":"api/beta/patch-form-instance","label":"Patch a form instance.","className":"api-method patch"},{"type":"doc","id":"api/beta/search-form-element-data-by-element-id","label":"Retrieves dynamic data by element.","className":"api-method get"},{"type":"doc","id":"api/beta/get-form-instance-file","label":"Download instance file by fileId.","className":"api-method get"},{"type":"doc","id":"api/beta/search-pre-defined-select-options","label":"List predefined select options.","className":"api-method get"}]},{"type":"category","label":"Custom Password Instructions","link":{"type":"doc","id":"api/beta/custom-password-instructions"},"items":[{"type":"doc","id":"api/beta/create-custom-password-instructions","label":"Create Custom Password Instructions","className":"api-method post"},{"type":"doc","id":"api/beta/get-custom-password-instructions","label":"Get Custom Password Instructions by Page ID","className":"api-method get"},{"type":"doc","id":"api/beta/delete-custom-password-instructions","label":"Delete Custom Password Instructions by page ID","className":"api-method delete"}]},{"type":"category","label":"Entitlements","link":{"type":"doc","id":"api/beta/entitlements"},"items":[{"type":"doc","id":"api/beta/list-entitlements","label":"Gets a list of entitlements.","className":"api-method get"},{"type":"doc","id":"api/beta/get-entitlement","label":"Get an entitlement","className":"api-method get"},{"type":"doc","id":"api/beta/patch-entitlement","label":"Patch an entitlement","className":"api-method patch"},{"type":"doc","id":"api/beta/list-entitlement-parents","label":"List of entitlements parents","className":"api-method get"},{"type":"doc","id":"api/beta/list-entitlement-children","label":"List of entitlements children","className":"api-method get"},{"type":"doc","id":"api/beta/update-entitlements-in-bulk","label":"Bulk update an entitlement list","className":"api-method post"},{"type":"doc","id":"api/beta/get-entitlement-request-config","label":"Get Entitlement Request Config","className":"api-method get"},{"type":"doc","id":"api/beta/put-entitlement-request-config","label":"Replace Entitlement Request Config","className":"api-method put"}]},{"type":"category","label":"Governance Groups","link":{"type":"doc","id":"api/beta/governance-groups"},"items":[{"type":"doc","id":"api/beta/list-workgroups","label":"List Governance Groups","className":"api-method get"},{"type":"doc","id":"api/beta/create-workgroup","label":"Create a new Governance Group.","className":"api-method post"},{"type":"doc","id":"api/beta/get-workgroup","label":"Get Governance Group by Id","className":"api-method get"},{"type":"doc","id":"api/beta/delete-workgroup","label":"Delete a Governance Group","className":"api-method delete"},{"type":"doc","id":"api/beta/patch-workgroup","label":"Patch a Governance Group","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-workgroups-in-bulk","label":"Delete Governance Group(s)","className":"api-method post"},{"type":"doc","id":"api/beta/list-connections","label":"List connections for Governance Group","className":"api-method get"},{"type":"doc","id":"api/beta/list-workgroup-members","label":"List Governance Group Members","className":"api-method get"},{"type":"doc","id":"api/beta/update-workgroup-members","label":"Add members to Governance Group","className":"api-method post"},{"type":"doc","id":"api/beta/delete-workgroup-members","label":"Remove members from Governance Group","className":"api-method post"}]},{"type":"category","label":"IAI Message Catalogs","link":{"type":"doc","id":"api/beta/iai-message-catalogs"},"items":[{"type":"doc","id":"api/beta/get-message-catalogs","label":"Get Message catalogs","className":"api-method get"}]},{"type":"category","label":"IAI Access Request Recommendations","link":{"type":"doc","id":"api/beta/iai-access-request-recommendations"},"items":[{"type":"doc","id":"api/beta/get-access-request-recommendations","label":"Identity Access Request Recommendations","className":"api-method get"},{"type":"doc","id":"api/beta/add-access-request-recommendations-ignored-item","label":"Notification of Ignored Access Request Recommendations","className":"api-method post"},{"type":"doc","id":"api/beta/get-access-request-recommendations-ignored-items","label":"List of Ignored Access Request Recommendations","className":"api-method get"},{"type":"doc","id":"api/beta/add-access-request-recommendations-requested-item","label":"Notification of Requested Access Request Recommendations","className":"api-method post"},{"type":"doc","id":"api/beta/get-access-request-recommendations-requested-items","label":"List of Requested Access Request Recommendations","className":"api-method get"},{"type":"doc","id":"api/beta/add-access-request-recommendations-viewed-item","label":"Notification of Viewed Access Request Recommendations","className":"api-method post"},{"type":"doc","id":"api/beta/get-access-request-recommendations-viewed-items","label":"List of Viewed Access Request Recommendations","className":"api-method get"},{"type":"doc","id":"api/beta/add-access-request-recommendations-viewed-items","label":"Notification of Viewed Access Request Recommendations in Bulk","className":"api-method post"}]},{"type":"category","label":"IAI Common Access","link":{"type":"doc","id":"api/beta/iai-common-access"},"items":[{"type":"doc","id":"api/beta/get-common-access","label":"Get a paginated list of common access","className":"api-method get"},{"type":"doc","id":"api/beta/create-common-access","label":"Create common access items","className":"api-method post"},{"type":"doc","id":"api/beta/update-common-access-status-in-bulk","label":"Bulk update common access status","className":"api-method post"}]},{"type":"category","label":"IAI Outliers","link":{"type":"doc","id":"api/beta/iai-outliers"},"items":[{"type":"doc","id":"api/beta/get-identity-outlier-snapshots","label":"IAI Identity Outliers Summary","className":"api-method get"},{"type":"doc","id":"api/beta/get-latest-identity-outlier-snapshots","label":"IAI Identity Outliers Latest Summary","className":"api-method get"},{"type":"doc","id":"api/beta/get-identity-outliers","label":"IAI Get Identity Outliers","className":"api-method get"},{"type":"doc","id":"api/beta/get-peer-group-outliers-contributing-features","label":"Get identity outlier's contibuting features","className":"api-method get"},{"type":"doc","id":"api/beta/list-outliers-contributing-feature-access-items","label":"Gets a list of access items associated with each identity outlier contributing feature","className":"api-method get"},{"type":"doc","id":"api/beta/ignore-identity-outliers","label":"IAI Identity Outliers Ignore","className":"api-method post"},{"type":"doc","id":"api/beta/un-ignore-identity-outliers","label":"IAI Identity Outliers Unignore","className":"api-method post"},{"type":"doc","id":"api/beta/export-outliers-zip","label":"IAI Identity Outliers Export","className":"api-method get"},{"type":"doc","id":"api/beta/get-outlier-contributing-feature-summary","label":"Get identity outlier contibuting feature summary","className":"api-method get"}]},{"type":"category","label":"IAI Peer Group Strategies","link":{"type":"doc","id":"api/beta/iai-peer-group-strategies"},"items":[{"type":"doc","id":"api/beta/get-peer-group-outliers","label":"Identity Outliers List","className":"menu__list-item--deprecated api-method get"}]},{"type":"category","label":"IAI Recommendations","link":{"type":"doc","id":"api/beta/iai-recommendations"},"items":[{"type":"doc","id":"api/beta/get-recommendations","label":"Returns a Recommendation Based on Object","className":"api-method post"},{"type":"doc","id":"api/beta/get-recommendations-config","label":"Get certification recommendation config values","className":"api-method get"},{"type":"doc","id":"api/beta/update-recommendations-config","label":"Update certification recommendation config values","className":"api-method put"}]},{"type":"category","label":"IAI Role Mining","link":{"type":"doc","id":"api/beta/iai-role-mining"},"items":[{"type":"doc","id":"api/beta/create-role-mining-sessions","label":"Create a role mining session","className":"api-method post"},{"type":"doc","id":"api/beta/get-role-mining-sessions","label":"Retrieves all role mining sessions","className":"api-method get"},{"type":"doc","id":"api/beta/patch-role-mining-session","label":"Patch a role mining session","className":"api-method patch"},{"type":"doc","id":"api/beta/get-role-mining-session","label":"Get a role mining session","className":"api-method get"},{"type":"doc","id":"api/beta/get-role-mining-session-status","label":"Get role mining session status state","className":"api-method get"},{"type":"doc","id":"api/beta/get-potential-role-summaries","label":"Retrieves all potential role summaries","className":"api-method get"},{"type":"doc","id":"api/beta/get-potential-role","label":"Retrieves a specific potential role","className":"api-method get"},{"type":"doc","id":"api/beta/patch-potential-role","label":"Update a potential role","className":"api-method patch"},{"type":"doc","id":"api/beta/get-potential-role-applications","label":"Retrieves the applications of a potential role for a role mining session","className":"api-method get"},{"type":"doc","id":"api/beta/get-entitlements-potential-role","label":"Retrieves entitlements for a potential role in a role mining session","className":"api-method get"},{"type":"doc","id":"api/beta/get-entitlement-distribution-potential-role","label":"Retrieves entitlement popularity distribution for a potential role in a role mining session","className":"api-method get"},{"type":"doc","id":"api/beta/update-entitlements-potential-role","label":"Edit entitlements for a potential role to exclude some entitlements","className":"api-method post"},{"type":"doc","id":"api/beta/get-identities-potential-role","label":"Retrieves identities for a potential role in a role mining session","className":"api-method get"},{"type":"doc","id":"api/beta/export-role-mining-potential-role","label":"Export (download) details for a potential role in a role mining session","className":"api-method get"},{"type":"doc","id":"api/beta/export-role-mining-potential-role-async","label":"Asynchronously export details for a potential role in a role mining session and upload to S3","className":"api-method post"},{"type":"doc","id":"api/beta/export-role-mining-potential-role-status","label":"Retrieve status of a potential role export job","className":"api-method get"},{"type":"doc","id":"api/beta/download-role-mining-potential-role-zip","label":"Export (download) details for a potential role in a role mining session","className":"api-method get"},{"type":"doc","id":"api/beta/create-potential-role-provision-request","label":"Create request to provision a potential role into an actual role.","className":"api-method post"},{"type":"doc","id":"api/beta/get-excluded-entitlements-potential-role","label":"Retrieves excluded entitlements for a potential role in a role mining session","className":"api-method get"},{"type":"doc","id":"api/beta/get-all-potential-role-summaries","label":"Retrieves all potential role summaries","className":"api-method get"},{"type":"doc","id":"api/beta/get-role-mining-potential-role","label":"Retrieves a specific potential role","className":"api-method get"},{"type":"doc","id":"api/beta/patch-potential-role","label":"Update a potential role","className":"api-method patch"},{"type":"doc","id":"api/beta/get-saved-potential-roles","label":"Retrieves all saved potential roles","className":"api-method get"},{"type":"doc","id":"api/beta/get-potential-role-source-identity-usage","label":"Retrieves potential role source usage","className":"api-method get"}]},{"type":"category","label":"Identities","link":{"type":"doc","id":"api/beta/identities"},"items":[{"type":"doc","id":"api/beta/synchronize-attributes-for-identity","label":"Attribute synchronization for single identity.","className":"api-method post"},{"type":"doc","id":"api/beta/get-identity-ownership-details","label":"Get ownership details","className":"api-method get"},{"type":"doc","id":"api/beta/list-identities","label":"List Identities","className":"api-method get"},{"type":"doc","id":"api/beta/get-identity","label":"Identity Details","className":"api-method get"},{"type":"doc","id":"api/beta/delete-identity","label":"Deletes an identity.","className":"api-method delete"},{"type":"doc","id":"api/beta/start-identity-processing","label":"Process a list of identityIds","className":"api-method post"}]},{"type":"category","label":"Identity Attributes","link":{"type":"doc","id":"api/beta/identity-attributes"},"items":[{"type":"doc","id":"api/beta/list-identity-attributes","label":"List Identity Attributes","className":"api-method get"},{"type":"doc","id":"api/beta/create-identity-attribute","label":"Create Identity Attribute","className":"api-method post"},{"type":"doc","id":"api/beta/get-identity-attribute","label":"Get Identity Attribute","className":"api-method get"},{"type":"doc","id":"api/beta/put-identity-attribute","label":"Update Identity Attribute","className":"api-method put"},{"type":"doc","id":"api/beta/delete-identity-attribute","label":"Delete Identity Attribute","className":"api-method delete"},{"type":"doc","id":"api/beta/delete-identity-attributes-in-bulk","label":"Bulk delete Identity Attributes","className":"api-method post"}]},{"type":"category","label":"Identity History","link":{"type":"doc","id":"api/beta/identity-history"},"items":[{"type":"doc","id":"api/beta/list-historical-identities","label":"Lists all the identities","className":"api-method get"},{"type":"doc","id":"api/beta/get-historical-identity","label":"Get latest snapshot of identity","className":"api-method get"},{"type":"doc","id":"api/beta/list-identity-access-items","label":"Gets a list of access items for the identity filtered by item type","className":"api-method get"},{"type":"doc","id":"api/beta/list-identity-snapshots","label":"Lists all the snapshots for the identity","className":"api-method get"},{"type":"doc","id":"api/beta/get-identity-snapshot-summary","label":"Gets the summary for the event count for a specific identity","className":"api-method get"},{"type":"doc","id":"api/beta/get-identity-snapshot","label":"Gets an identity snapshot at a given date","className":"api-method get"},{"type":"doc","id":"api/beta/list-identity-snapshot-access-items","label":"Gets the list of identity access items at a given date filterd by item type","className":"api-method get"},{"type":"doc","id":"api/beta/get-historical-identity-events","label":"Lists all events for the given identity","className":"api-method get"},{"type":"doc","id":"api/beta/get-identity-start-date","label":"Gets the start date of the identity","className":"api-method get"},{"type":"doc","id":"api/beta/compare-identity-snapshots","label":"Gets a difference of count for each access item types for the given identity between 2 snapshots","className":"api-method get"},{"type":"doc","id":"api/beta/compare-identity-snapshots-access-type","label":"Gets a list of differences of specific accessType for the given identity between 2 snapshots","className":"api-method get"}]},{"type":"category","label":"Identity Profiles","link":{"type":"doc","id":"api/beta/identity-profiles"},"items":[{"type":"doc","id":"api/beta/list-identity-profiles","label":"Identity Profiles list","className":"api-method get"},{"type":"doc","id":"api/beta/create-identity-profile","label":"Create an Identity Profile","className":"api-method post"},{"type":"doc","id":"api/beta/delete-identity-profiles","label":"Delete Identity Profiles","className":"api-method post"},{"type":"doc","id":"api/beta/export-identity-profiles","label":"Export Identity Profiles","className":"api-method get"},{"type":"doc","id":"api/beta/import-identity-profiles","label":"Import Identity Profiles","className":"api-method post"},{"type":"doc","id":"api/beta/generate-identity-preview","label":"Generate Identity Profile Preview","className":"api-method post"},{"type":"doc","id":"api/beta/get-identity-profile","label":"Gets a single Identity Profile","className":"api-method get"},{"type":"doc","id":"api/beta/delete-identity-profile","label":"Delete an Identity Profile","className":"api-method delete"},{"type":"doc","id":"api/beta/update-identity-profile","label":"Update the Identity Profile","className":"api-method patch"},{"type":"doc","id":"api/beta/get-default-identity-attribute-config","label":"Default identity attribute config","className":"api-method get"},{"type":"doc","id":"api/beta/sync-identity-profile","label":"Process identities under profile","className":"api-method post"}]},{"type":"category","label":"Lifecycle States","link":{"type":"doc","id":"api/beta/lifecycle-states"},"items":[{"type":"doc","id":"api/beta/list-lifecycle-states","label":"Lifecycle State","className":"api-method get"},{"type":"doc","id":"api/beta/update-lifecycle-states","label":"Update Lifecycle State","className":"api-method patch"}]},{"type":"category","label":"Managed Clients","link":{"type":"doc","id":"api/beta/managed-clients"},"items":[{"type":"doc","id":"api/beta/get-managed-client-status","label":"Specified Managed Client Status.","className":"api-method get"},{"type":"doc","id":"api/beta/update-managed-client-status","label":"Handle status request from client","className":"api-method post"}]},{"type":"category","label":"Managed Clusters","link":{"type":"doc","id":"api/beta/managed-clusters"},"items":[{"type":"doc","id":"api/beta/get-managed-cluster","label":"Get a specified ManagedCluster.","className":"api-method get"},{"type":"doc","id":"api/beta/get-client-log-configuration","label":"Get managed cluster's log configuration","className":"api-method get"},{"type":"doc","id":"api/beta/put-client-log-configuration","label":"Update managed cluster's log configuration","className":"api-method put"},{"type":"doc","id":"api/beta/get-managed-clusters","label":"Retrieve all Managed Clusters.","className":"api-method get"}]},{"type":"category","label":"MFA Configuration","link":{"type":"doc","id":"api/beta/mfa-configuration"},"items":[{"type":"doc","id":"api/beta/get-mfa-okta-config","label":"Configuration of Okta MFA method","className":"api-method get"},{"type":"doc","id":"api/beta/set-mfa-okta-config","label":"Set Okta MFA configuration","className":"api-method put"},{"type":"doc","id":"api/beta/get-mfa-duo-config","label":"Configuration of Duo MFA method","className":"api-method get"},{"type":"doc","id":"api/beta/set-mfa-duo-config","label":"Set Duo MFA configuration","className":"api-method put"},{"type":"doc","id":"api/beta/test-mfa-config","label":"MFA method's test configuration","className":"api-method get"},{"type":"doc","id":"api/beta/delete-mfa-config","label":"Delete MFA method configuration","className":"api-method delete"}]},{"type":"category","label":"MFA Controller","link":{"type":"doc","id":"api/beta/mfa-controller"},"items":[{"type":"doc","id":"api/beta/send-okta-verify-request","label":"Verifying authentication via Okta method","className":"api-method post"},{"type":"doc","id":"api/beta/send-duo-verify-request","label":"Verifying authentication via Duo method","className":"api-method post"},{"type":"doc","id":"api/beta/ping-verification-status","label":"Polling MFA method by VerificationPollRequest","className":"api-method post"},{"type":"doc","id":"api/beta/send-kba-answers","label":"Authenticate KBA provided MFA method","className":"api-method post"},{"type":"doc","id":"api/beta/send-token-auth-request","label":"Authenticate Token provided MFA method","className":"api-method post"},{"type":"doc","id":"api/beta/create-send-token","label":"Create and send user token","className":"api-method post"}]},{"type":"category","label":"Non-Employee Lifecycle Management","link":{"type":"doc","id":"api/beta/non-employee-lifecycle-management"},"items":[{"type":"doc","id":"api/beta/create-non-employee-record","label":"Create Non-Employee Record","className":"api-method post"},{"type":"doc","id":"api/beta/list-non-employee-records","label":"List Non-Employee Records","className":"api-method get"},{"type":"doc","id":"api/beta/get-non-employee-record","label":"Get a Non-Employee Record","className":"api-method get"},{"type":"doc","id":"api/beta/update-non-employee-record","label":"Update Non-Employee Record","className":"api-method put"},{"type":"doc","id":"api/beta/patch-non-employee-record","label":"Patch Non-Employee Record","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-non-employee-record","label":"Delete Non-Employee Record","className":"api-method delete"},{"type":"doc","id":"api/beta/delete-non-employee-record-in-bulk","label":"Delete Multiple Non-Employee Records","className":"api-method post"},{"type":"doc","id":"api/beta/create-non-employee-request","label":"Create Non-Employee Request","className":"api-method post"},{"type":"doc","id":"api/beta/list-non-employee-requests","label":"List Non-Employee Requests","className":"api-method get"},{"type":"doc","id":"api/beta/get-non-employee-request","label":"Get a Non-Employee Request","className":"api-method get"},{"type":"doc","id":"api/beta/delete-non-employee-request","label":"Delete Non-Employee Request","className":"api-method delete"},{"type":"doc","id":"api/beta/get-non-employee-request-summary","label":"Get Summary of Non-Employee Requests","className":"api-method get"},{"type":"doc","id":"api/beta/create-non-employee-source","label":"Create Non-Employee Source","className":"api-method post"},{"type":"doc","id":"api/beta/list-non-employee-sources","label":"List Non-Employee Sources","className":"api-method get"},{"type":"doc","id":"api/beta/get-non-employee-source","label":"Get a Non-Employee Source","className":"api-method get"},{"type":"doc","id":"api/beta/patch-non-employee-source","label":"Patch a Non-Employee Source","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-non-employee-source","label":"Delete Non-Employee Source","className":"api-method delete"},{"type":"doc","id":"api/beta/export-non-employee-records","label":"Exports Non-Employee Records to CSV","className":"api-method get"},{"type":"doc","id":"api/beta/import-non-employee-records-in-bulk","label":"Imports, or Updates, Non-Employee Records","className":"api-method post"},{"type":"doc","id":"api/beta/get-non-employee-bulk-upload-status","label":"Bulk upload status on source","className":"api-method get"},{"type":"doc","id":"api/beta/export-non-employee-source-schema-template","label":"Exports Source Schema Template","className":"api-method get"},{"type":"doc","id":"api/beta/list-non-employee-approval","label":"Get List of Non-Employee Approval Requests","className":"api-method get"},{"type":"doc","id":"api/beta/get-non-employee-approval","label":"Get a non-employee approval item detail","className":"api-method get"},{"type":"doc","id":"api/beta/approve-non-employee-request","label":"Approve a Non-Employee Request","className":"api-method post"},{"type":"doc","id":"api/beta/reject-non-employee-request","label":"Reject a Non-Employee Request","className":"api-method post"},{"type":"doc","id":"api/beta/get-non-employee-approval-summary","label":"Get Summary of Non-Employee Approval Requests","className":"api-method get"},{"type":"doc","id":"api/beta/get-non-employee-source-schema-attributes","label":"List Schema Attributes Non-Employee Source","className":"api-method get"},{"type":"doc","id":"api/beta/create-non-employee-source-schema-attributes","label":"Create Non-Employee Source Schema Attribute","className":"api-method post"},{"type":"doc","id":"api/beta/delete-non-employee-source-schema-attributes","label":"Delete all custom schema attributes","className":"api-method delete"},{"type":"doc","id":"api/beta/get-non-employee-schema-attribute","label":"Get Schema Attribute Non-Employee Source","className":"api-method get"},{"type":"doc","id":"api/beta/patch-non-employee-schema-attribute","label":"Patch Non-Employee Source's Schema Attribute","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-non-employee-schema-attribute","label":"Delete Non-Employee Source's Schema Attribute","className":"api-method delete"}]},{"type":"category","label":"Notifications","link":{"type":"doc","id":"api/beta/notifications"},"items":[{"type":"doc","id":"api/beta/put-mail-from-attributes","label":"Change MAIL FROM domain","className":"api-method put"},{"type":"doc","id":"api/beta/get-mail-from-attributes","label":"Get MAIL FROM Attributes","className":"api-method get"},{"type":"doc","id":"api/beta/list-notification-template-defaults","label":"List Notification Template Defaults","className":"api-method get"},{"type":"doc","id":"api/beta/list-notification-templates","label":"List Notification Templates","className":"api-method get"},{"type":"doc","id":"api/beta/create-notification-template","label":"Create Notification Template","className":"api-method post"},{"type":"doc","id":"api/beta/get-notification-template","label":"Get Notification Template By Id","className":"api-method get"},{"type":"doc","id":"api/beta/delete-notification-templates-in-bulk","label":"Bulk Delete Notification Templates","className":"api-method post"},{"type":"doc","id":"api/beta/get-notifications-template-context","label":"Get Notification Template Context","className":"api-method get"},{"type":"doc","id":"api/beta/get-notification-preference","label":"Get Notification Preferences for tenant.","className":"api-method get"},{"type":"doc","id":"api/beta/put-notification-preference","label":"Overwrite preferences notification key.","className":"api-method put"},{"type":"doc","id":"api/beta/send-test-notification","label":"Send Test Notification","className":"api-method post"},{"type":"doc","id":"api/beta/list-from-addresses","label":"List From Addresses","className":"api-method get"},{"type":"doc","id":"api/beta/create-verified-from-address","label":"Create Verified From Address","className":"api-method post"},{"type":"doc","id":"api/beta/delete-verified-from-address","label":"Delete Verified From Address","className":"api-method delete"},{"type":"doc","id":"api/beta/get-dkim-attributes","label":"Get DKIM Attributes","className":"api-method get"},{"type":"doc","id":"api/beta/create-domain-dkim","label":"Verify domain address via DKIM","className":"api-method post"}]},{"type":"category","label":"OAuth Clients","link":{"type":"doc","id":"api/beta/o-auth-clients"},"items":[{"type":"doc","id":"api/beta/list-oauth-clients","label":"List OAuth Clients","className":"api-method get"},{"type":"doc","id":"api/beta/create-oauth-client","label":"Create OAuth Client","className":"api-method post"},{"type":"doc","id":"api/beta/get-oauth-client","label":"Get OAuth Client","className":"api-method get"},{"type":"doc","id":"api/beta/delete-oauth-client","label":"Delete OAuth Client","className":"api-method delete"},{"type":"doc","id":"api/beta/patch-oauth-client","label":"Patch OAuth Client","className":"api-method patch"}]},{"type":"category","label":"Org Config","link":{"type":"doc","id":"api/beta/org-config"},"items":[{"type":"doc","id":"api/beta/get-org-config","label":"Get Org configuration settings","className":"api-method get"},{"type":"doc","id":"api/beta/patch-org-config","label":"Patch an Org configuration property","className":"api-method patch"},{"type":"doc","id":"api/beta/get-valid-time-zones","label":"Get list of time zones","className":"api-method get"}]},{"type":"category","label":"Password Configuration","link":{"type":"doc","id":"api/beta/password-configuration"},"items":[{"type":"doc","id":"api/beta/get-password-org-config","label":"Get Password Org Config","className":"api-method get"},{"type":"doc","id":"api/beta/put-password-org-config","label":"Update Password Org Config","className":"api-method put"},{"type":"doc","id":"api/beta/create-password-org-config","label":"Create Password Org Config","className":"api-method post"}]},{"type":"category","label":"Password Dictionary","link":{"type":"doc","id":"api/beta/password-dictionary"},"items":[{"type":"doc","id":"api/beta/get-password-dictionary","label":"Get Password Dictionary","className":"api-method get"},{"type":"doc","id":"api/beta/put-password-dictionary","label":"Update Password Dictionary","className":"api-method put"}]},{"type":"category","label":"Password Management","link":{"type":"doc","id":"api/beta/password-management"},"items":[{"type":"doc","id":"api/beta/generate-digit-token","label":"Generate a digit token","className":"api-method post"},{"type":"doc","id":"api/beta/query-password-info","label":"Query Password Info","className":"api-method post"},{"type":"doc","id":"api/beta/set-identity-password","label":"Set Identity's Password","className":"api-method post"},{"type":"doc","id":"api/beta/get-identity-password-change-status","label":"Get Password Change Request Status","className":"api-method get"}]},{"type":"category","label":"Password Sync Groups","link":{"type":"doc","id":"api/beta/password-sync-groups"},"items":[{"type":"doc","id":"api/beta/get-password-sync-groups","label":"Get Password Sync Group List","className":"api-method get"},{"type":"doc","id":"api/beta/create-password-sync-group","label":"Create Password Sync Group","className":"api-method post"},{"type":"doc","id":"api/beta/get-password-sync-group","label":"Get Password Sync Group by ID","className":"api-method get"},{"type":"doc","id":"api/beta/update-password-sync-group","label":"Update Password Sync Group by ID","className":"api-method put"},{"type":"doc","id":"api/beta/delete-password-sync-group","label":"Delete Password Sync Group by ID","className":"api-method delete"}]},{"type":"category","label":"Personal Access Tokens","link":{"type":"doc","id":"api/beta/personal-access-tokens"},"items":[{"type":"doc","id":"api/beta/list-personal-access-tokens","label":"List Personal Access Tokens","className":"api-method get"},{"type":"doc","id":"api/beta/create-personal-access-token","label":"Create Personal Access Token","className":"api-method post"},{"type":"doc","id":"api/beta/patch-personal-access-token","label":"Patch Personal Access Token","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-personal-access-token","label":"Delete Personal Access Token","className":"api-method delete"}]},{"type":"category","label":"Public Identities Config","link":{"type":"doc","id":"api/beta/public-identities-config"},"items":[{"type":"doc","id":"api/beta/get-public-identity-config","label":"Get Public Identity Config","className":"api-method get"},{"type":"doc","id":"api/beta/update-public-identity-config","label":"Update Public Identity Config","className":"api-method put"}]},{"type":"category","label":"Requestable Objects","link":{"type":"doc","id":"api/beta/requestable-objects"},"items":[{"type":"doc","id":"api/beta/list-requestable-objects","label":"Requestable Objects List","className":"api-method get"}]},{"type":"category","label":"Role Insights","link":{"type":"doc","id":"api/beta/role-insights"},"items":[{"type":"doc","id":"api/beta/create-role-insight-requests","label":"Generate insights for roles","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/get-role-insights-requests","label":"Returns metadata from prior request.","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/get-role-insights-summary","label":"Get role insights summary information","className":"api-method get"},{"type":"doc","id":"api/beta/get-role-insights","label":"Get role insights","className":"api-method get"},{"type":"doc","id":"api/beta/get-role-insight","label":"Get a single role insight","className":"api-method get"},{"type":"doc","id":"api/beta/get-role-insights-entitlements-changes","label":"Get entitlement insights for a role","className":"api-method get"},{"type":"doc","id":"api/beta/download-role-insights-entitlements-changes","label":"Download entitlement insights for a role","className":"api-method get"},{"type":"doc","id":"api/beta/get-role-insights-current-entitlements","label":"Get current entitlement for a role","className":"api-method get"},{"type":"doc","id":"api/beta/get-entitlement-changes-identities","label":"Get identities for a suggested entitlement (for a role)","className":"api-method get"}]},{"type":"category","label":"Roles","link":{"type":"doc","id":"api/beta/roles"},"items":[{"type":"doc","id":"api/beta/list-roles","label":"List Roles","className":"api-method get"},{"type":"doc","id":"api/beta/create-role","label":"Create a Role","className":"api-method post"},{"type":"doc","id":"api/beta/get-role","label":"Get a Role","className":"api-method get"},{"type":"doc","id":"api/beta/patch-role","label":"Patch a specified Role","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-role","label":"Delete a Role","className":"api-method delete"},{"type":"doc","id":"api/beta/bulk-delete-roles","label":"Delete Role(s)","className":"api-method post"},{"type":"doc","id":"api/beta/get-role-assigned-identities","label":"Identities assigned a Role","className":"api-method get"},{"type":"doc","id":"api/beta/get-role-entitlements","label":"List role's Entitlements","className":"api-method get"}]},{"type":"category","label":"Search Attribute Configuration","link":{"type":"doc","id":"api/beta/search-attribute-configuration"},"items":[{"type":"doc","id":"api/beta/create-search-attribute-config","label":"Configure/create extended search attributes in IdentityNow.","className":"api-method post"},{"type":"doc","id":"api/beta/get-search-attribute-config","label":"Retrieve a list of extended search attributes in IdentityNow.","className":"api-method get"},{"type":"doc","id":"api/beta/get-single-search-attribute-config","label":"Get the details of a specific extended search attribute in IdentityNow.","className":"api-method get"},{"type":"doc","id":"api/beta/delete-search-attribute-config","label":"Delete an extended search attribute in IdentityNow.","className":"api-method delete"},{"type":"doc","id":"api/beta/patch-search-attribute-config","label":"Update the details of a specific extended search attribute in IdentityNow.","className":"api-method patch"}]},{"type":"category","label":"Segments","link":{"type":"doc","id":"api/beta/segments"},"items":[{"type":"doc","id":"api/beta/create-segment","label":"Create Segment","className":"api-method post"},{"type":"doc","id":"api/beta/list-segments","label":"List Segments","className":"api-method get"},{"type":"doc","id":"api/beta/get-segment","label":"Get Segment by ID","className":"api-method get"},{"type":"doc","id":"api/beta/delete-segment","label":"Delete Segment by ID","className":"api-method delete"},{"type":"doc","id":"api/beta/patch-segment","label":"Update Segment","className":"api-method patch"}]},{"type":"category","label":"Service Desk Integration","link":{"type":"doc","id":"api/beta/service-desk-integration"},"items":[{"type":"doc","id":"api/beta/get-service-desk-integration-list","label":"List existing Service Desk Integrations","className":"api-method get"},{"type":"doc","id":"api/beta/create-service-desk-integration","label":"Create new Service Desk integration","className":"api-method post"},{"type":"doc","id":"api/beta/get-service-desk-integration","label":"Get a Service Desk integration","className":"api-method get"},{"type":"doc","id":"api/beta/put-service-desk-integration","label":"Update a Service Desk integration","className":"api-method put"},{"type":"doc","id":"api/beta/delete-service-desk-integration","label":"Delete a Service Desk integration","className":"api-method delete"},{"type":"doc","id":"api/beta/patch-service-desk-integration","label":"Service Desk Integration Update PATCH","className":"api-method patch"},{"type":"doc","id":"api/beta/get-service-desk-integration-types","label":"Service Desk Integration Types List.","className":"api-method get"},{"type":"doc","id":"api/beta/get-service-desk-integration-template","label":"Service Desk integration template by scriptName.","className":"api-method get"},{"type":"doc","id":"api/beta/get-status-check-details","label":"Get the time check configuration","className":"api-method get"},{"type":"doc","id":"api/beta/update-status-check-details","label":"Update the time check configuration","className":"api-method put"}]},{"type":"category","label":"SOD Policy","link":{"type":"doc","id":"api/beta/sod-policy"},"items":[{"type":"doc","id":"api/beta/create-sod-policy","label":"Create SOD policy","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/list-sod-policies","label":"List SOD policies","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/get-sod-policy","label":"Get SOD policy by ID","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/put-sod-policy","label":"Update SOD policy by ID","className":"menu__list-item--deprecated api-method put"},{"type":"doc","id":"api/beta/delete-sod-policy","label":"Delete SOD policy by ID","className":"menu__list-item--deprecated api-method delete"},{"type":"doc","id":"api/beta/patch-sod-policy","label":"Patch a SOD policy","className":"menu__list-item--deprecated api-method patch"},{"type":"doc","id":"api/beta/get-sod-policy-schedule","label":"Get SOD policy schedule","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/put-policy-schedule","label":"Update SOD Policy schedule","className":"menu__list-item--deprecated api-method put"},{"type":"doc","id":"api/beta/delete-sod-policy-schedule","label":"Delete SOD policy schedule","className":"menu__list-item--deprecated api-method delete"},{"type":"doc","id":"api/beta/start-sod-policy","label":"Runs SOD policy violation report","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/get-sod-violation-report-status","label":"Get SOD violation report status","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/get-sod-violation-report-run-status","label":"Get violation report run status","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/start-sod-all-policies-for-org","label":"Runs all policies for org","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/get-sod-all-report-run-status","label":"Get multi-report run task status","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/get-default-violation-report","label":"Download violation report","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/get-custom-violation-report","label":"Download custom violation report","className":"menu__list-item--deprecated api-method get"}]},{"type":"category","label":"SOD Violations","link":{"type":"doc","id":"api/beta/sod-violations"},"items":[{"type":"doc","id":"api/beta/start-predict-sod-violations","label":"Predict SOD violations for identity.","className":"menu__list-item--deprecated api-method post"}]},{"type":"category","label":"Source Usages","link":{"type":"doc","id":"api/beta/source-usages"},"items":[{"type":"doc","id":"api/beta/get-status-by-source-id","label":"Finds status of source usage","className":"api-method get"},{"type":"doc","id":"api/beta/get-usages-by-source-id","label":"Returns source usage insights","className":"api-method get"}]},{"type":"category","label":"Sources","link":{"type":"doc","id":"api/beta/sources"},"items":[{"type":"doc","id":"api/beta/list-sources","label":"Lists all sources in IdentityNow.","className":"api-method get"},{"type":"doc","id":"api/beta/create-source","label":"Creates a source in IdentityNow.","className":"api-method post"},{"type":"doc","id":"api/beta/get-source","label":"Get Source by ID","className":"api-method get"},{"type":"doc","id":"api/beta/put-source","label":"Update Source (Full)","className":"api-method put"},{"type":"doc","id":"api/beta/update-source","label":"Update Source (Partial)","className":"api-method patch"},{"type":"doc","id":"api/beta/delete","label":"Delete Source by ID","className":"api-method delete"},{"type":"doc","id":"api/beta/get-source-attr-sync-config","label":"Attribute Sync Config","className":"api-method get"},{"type":"doc","id":"api/beta/put-source-attr-sync-config","label":"Update Attribute Sync Config","className":"api-method put"},{"type":"doc","id":"api/beta/test-source-connection","label":"Check connection for source connector.","className":"api-method post"},{"type":"doc","id":"api/beta/peek-resource-objects","label":"Peek source connector's resource objects","className":"api-method post"},{"type":"doc","id":"api/beta/ping-cluster","label":"Ping cluster for source connector","className":"api-method post"},{"type":"doc","id":"api/beta/test-source-configuration","label":"Test configuration for source connector","className":"api-method post"},{"type":"doc","id":"api/beta/get-source-config","label":"Gets source config with language translations","className":"api-method get"},{"type":"doc","id":"api/beta/get-native-change-detection-config","label":"Native Change Detection Configuration","className":"api-method get"},{"type":"doc","id":"api/beta/put-native-change-detection-config","label":"Update Native Change Detection Configuration","className":"api-method put"},{"type":"doc","id":"api/beta/delete-native-change-detection-config","label":"Delete Native Change Detection Configuration","className":"api-method delete"},{"type":"doc","id":"api/beta/list-provisioning-policies","label":"Lists ProvisioningPolicies","className":"api-method get"},{"type":"doc","id":"api/beta/create-provisioning-policy","label":"Create Provisioning Policy","className":"api-method post"},{"type":"doc","id":"api/beta/get-provisioning-policy","label":"Get Provisioning Policy by UsageType","className":"api-method get"},{"type":"doc","id":"api/beta/put-provisioning-policy","label":"Update Provisioning Policy by UsageType","className":"api-method put"},{"type":"doc","id":"api/beta/update-provisioning-policy","label":"Partial update of Provisioning Policy","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-provisioning-policy","label":"Delete Provisioning Policy by UsageType","className":"api-method delete"},{"type":"doc","id":"api/beta/update-provisioning-policies-in-bulk","label":"Bulk Update Provisioning Policies","className":"api-method post"},{"type":"doc","id":"api/beta/list-source-schemas","label":"Lists the Schemas that exist on the specified Source in IdentityNow.","className":"api-method get"},{"type":"doc","id":"api/beta/create-source-schema","label":"Creates a new Schema on the specified Source in IdentityNow.","className":"api-method post"},{"type":"doc","id":"api/beta/get-source-schema","label":"Get Source Schema by ID","className":"api-method get"},{"type":"doc","id":"api/beta/put-source-schema","label":"Update Source Schema (Full)","className":"api-method put"},{"type":"doc","id":"api/beta/update-source-schema","label":"Update Source Schema (Partial)","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-source-schema","label":"Delete Source Schema by ID","className":"api-method delete"},{"type":"doc","id":"api/beta/get-source-accounts-schema","label":"Downloads source accounts schema template","className":"api-method get"},{"type":"doc","id":"api/beta/import-source-accounts-schema","label":"Uploads source accounts schema template","className":"api-method post"},{"type":"doc","id":"api/beta/get-source-entitlements-schema","label":"Downloads source entitlements schema template","className":"api-method get"},{"type":"doc","id":"api/beta/import-source-entitlements-schema","label":"Uploads source entitlements schema template","className":"api-method post"},{"type":"doc","id":"api/beta/import-source-connector-file","label":"Upload connector file to source","className":"api-method post"},{"type":"doc","id":"api/beta/sync-attributes-for-source","label":"Synchronize single source attributes.","className":"api-method post"},{"type":"doc","id":"api/beta/get-source-entitlement-request-config","label":"Get Source Entitlement Request Configuration","className":"api-method get"},{"type":"doc","id":"api/beta/update-source-entitlement-request-config","label":"Update Source Entitlement Request Configuration","className":"api-method put"}]},{"type":"category","label":"SP-Config","link":{"type":"doc","id":"api/beta/sp-config"},"items":[{"type":"doc","id":"api/beta/export-sp-config","label":"Initiates configuration objects export job","className":"api-method post"},{"type":"doc","id":"api/beta/get-sp-config-export-status","label":"Get export job status","className":"api-method get"},{"type":"doc","id":"api/beta/get-sp-config-export","label":"Download export job result.","className":"api-method get"},{"type":"doc","id":"api/beta/import-sp-config","label":"Initiates configuration objects import job","className":"api-method post"},{"type":"doc","id":"api/beta/get-sp-config-import-status","label":"Get import job status","className":"api-method get"},{"type":"doc","id":"api/beta/get-sp-config-import","label":"Download import job result","className":"api-method get"},{"type":"doc","id":"api/beta/list-sp-config-objects","label":"Get config object details","className":"api-method get"}]},{"type":"category","label":"Tagged Objects","link":{"type":"doc","id":"api/beta/tagged-objects"},"items":[{"type":"doc","id":"api/beta/list-tagged-objects","label":"List Tagged Objects","className":"api-method get"},{"type":"doc","id":"api/beta/set-tag-to-object","label":"Add Tag to Object","className":"api-method post"},{"type":"doc","id":"api/beta/list-tagged-objects-by-type","label":"List Tagged Objects by Type","className":"api-method get"},{"type":"doc","id":"api/beta/get-tagged-object","label":"Get Tagged Object","className":"api-method get"},{"type":"doc","id":"api/beta/put-tagged-object","label":"Update Tagged Object","className":"api-method put"},{"type":"doc","id":"api/beta/delete-tagged-object","label":"Delete Tagged Object","className":"api-method delete"},{"type":"doc","id":"api/beta/set-tags-to-many-objects","label":"Tag Multiple Objects","className":"api-method post"},{"type":"doc","id":"api/beta/delete-tags-to-many-object","label":"Remove Tags from Multiple Objects","className":"api-method post"}]},{"type":"category","label":"Task Management","link":{"type":"doc","id":"api/beta/task-management"},"items":[{"type":"doc","id":"api/beta/get-task-status","label":"Get task status by ID.","className":"api-method get"},{"type":"doc","id":"api/beta/update-task-status","label":"Update task status by ID","className":"api-method patch"},{"type":"doc","id":"api/beta/get-task-status-list","label":"Retrieve a task status list.","className":"api-method get"},{"type":"doc","id":"api/beta/get-pending-tasks","label":"Retrieve a pending task list.","className":"api-method get"},{"type":"doc","id":"api/beta/get-pending-task-headers","label":"Retrieve headers only for pending task list.","className":"api-method head"}]},{"type":"category","label":"Transforms","link":{"type":"doc","id":"api/beta/transforms"},"items":[{"type":"doc","id":"api/beta/list-transforms","label":"List transforms","className":"api-method get"},{"type":"doc","id":"api/beta/create-transform","label":"Create transform","className":"api-method post"},{"type":"doc","id":"api/beta/get-transform","label":"Transform by ID","className":"api-method get"},{"type":"doc","id":"api/beta/update-transform","label":"Update a transform","className":"api-method put"},{"type":"doc","id":"api/beta/delete-transform","label":"Delete a transform","className":"api-method delete"}]},{"type":"category","label":"Triggers","link":{"type":"doc","id":"api/beta/triggers"},"items":[{"type":"doc","id":"api/beta/list-triggers","label":"List Triggers","className":"api-method get"},{"type":"doc","id":"api/beta/create-subscription","label":"Create a Subscription","className":"api-method post"},{"type":"doc","id":"api/beta/list-subscriptions","label":"List Subscriptions","className":"api-method get"},{"type":"doc","id":"api/beta/update-subscription","label":"Update a Subscription","className":"api-method put"},{"type":"doc","id":"api/beta/patch-subscription","label":"Patch a Subscription","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-subscription","label":"Delete a Subscription","className":"api-method delete"},{"type":"doc","id":"api/beta/test-subscription-filter","label":"Validate a Subscription Filter","className":"api-method post"},{"type":"doc","id":"api/beta/list-trigger-invocation-status","label":"List Latest Invocation Statuses","className":"api-method get"},{"type":"doc","id":"api/beta/complete-trigger-invocation","label":"Complete Trigger Invocation","className":"api-method post"},{"type":"doc","id":"api/beta/start-test-trigger-invocation","label":"Start a Test Invocation","className":"api-method post"}]},{"type":"category","label":"Work Items","link":{"type":"doc","id":"api/beta/work-items"},"items":[{"type":"doc","id":"api/beta/list-work-items","label":"List Work Items","className":"api-method get"},{"type":"doc","id":"api/beta/get-completed-work-items","label":"Completed Work Items","className":"api-method get"},{"type":"doc","id":"api/beta/get-count-work-items","label":"Count Work Items","className":"api-method get"},{"type":"doc","id":"api/beta/get-count-completed-work-items","label":"Count Completed Work Items","className":"api-method get"},{"type":"doc","id":"api/beta/get-work-items-summary","label":"Work Items Summary","className":"api-method get"},{"type":"doc","id":"api/beta/get-work-item","label":"Get a Work Item","className":"api-method get"},{"type":"doc","id":"api/beta/complete-work-item","label":"Complete a Work Item","className":"api-method post"},{"type":"doc","id":"api/beta/forward-work-item","label":"Forward a Work Item","className":"api-method post"},{"type":"doc","id":"api/beta/approve-approval-item","label":"Approve an Approval Item","className":"api-method post"},{"type":"doc","id":"api/beta/reject-approval-item","label":"Reject an Approval Item","className":"api-method post"},{"type":"doc","id":"api/beta/approve-approval-items-in-bulk","label":"Bulk approve Approval Items","className":"api-method post"},{"type":"doc","id":"api/beta/reject-approval-items-in-bulk","label":"Bulk reject Approval Items","className":"api-method post"},{"type":"doc","id":"api/beta/submit-account-selection","label":"Submit Account Selections","className":"api-method post"}]},{"type":"category","label":"Work Reassignment","link":{"type":"doc","id":"api/beta/work-reassignment"},"items":[{"type":"doc","id":"api/beta/get-reassignment-config-types","label":"List Reassignment Config Types","className":"api-method get"},{"type":"doc","id":"api/beta/list-reassignment-configurations","label":"List Reassignment Configurations","className":"api-method get"},{"type":"doc","id":"api/beta/create-reassignment-configuration","label":"Create a Reassignment Configuration","className":"api-method post"},{"type":"doc","id":"api/beta/get-reassignment-configuration","label":"Get Reassignment Configuration","className":"api-method get"},{"type":"doc","id":"api/beta/put-reassignment-config","label":"Update Reassignment Configuration","className":"api-method put"},{"type":"doc","id":"api/beta/delete-reassignment-configuration","label":"Delete Reassignment Configuration","className":"api-method delete"},{"type":"doc","id":"api/beta/get-evaluate-reassignment-configuration","label":"Evaluate Reassignment Configuration","className":"api-method get"},{"type":"doc","id":"api/beta/get-tenant-config-configuration","label":"Get Tenant-wide Reassignment Configuration settings","className":"api-method get"},{"type":"doc","id":"api/beta/put-tenant-configuration","label":"Update Tenant-wide Reassignment Configuration settings","className":"api-method put"}]},{"type":"category","label":"Workflows","link":{"type":"doc","id":"api/beta/workflows"},"items":[{"type":"doc","id":"api/beta/create-workflow","label":"Create Workflow","className":"api-method post"},{"type":"doc","id":"api/beta/list-workflows","label":"List Workflows","className":"api-method get"},{"type":"doc","id":"api/beta/get-workflow","label":"Get Workflow By Id","className":"api-method get"},{"type":"doc","id":"api/beta/update-workflow","label":"Update Workflow","className":"api-method put"},{"type":"doc","id":"api/beta/patch-workflow","label":"Patch Workflow","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-workflow","label":"Delete Workflow By Id","className":"api-method delete"},{"type":"doc","id":"api/beta/test-workflow","label":"Test Workflow By Id","className":"api-method post"},{"type":"doc","id":"api/beta/list-workflow-executions","label":"List Workflow Executions","className":"api-method get"},{"type":"doc","id":"api/beta/get-workflow-execution","label":"Get a Workflow Execution","className":"api-method get"},{"type":"doc","id":"api/beta/get-workflow-execution-history","label":"Get Workflow Execution History","className":"api-method get"},{"type":"doc","id":"api/beta/cancel-workflow-execution","label":"Cancel Workflow Execution by ID","className":"api-method post"},{"type":"doc","id":"api/beta/list-complete-workflow-library","label":"List Complete Workflow Library","className":"api-method get"},{"type":"doc","id":"api/beta/list-workflow-library-actions","label":"List Workflow Library Actions","className":"api-method get"},{"type":"doc","id":"api/beta/list-workflow-library-triggers","label":"List Workflow Library Triggers","className":"api-method get"},{"type":"doc","id":"api/beta/list-workflow-library-operators","label":"List Workflow Library Operators","className":"api-method get"},{"type":"doc","id":"api/beta/post-workflow-external-trigger","label":"Generate External Trigger OAuth Client","className":"api-method post"},{"type":"doc","id":"api/beta/post-external-execute-workflow","label":"Execute Workflow via External Trigger","className":"api-method post"},{"type":"doc","id":"api/beta/test-external-execute-workflow","label":"Test Workflow via External Trigger","className":"api-method post"}]}]; \ No newline at end of file +module.exports = [{"type":"doc","id":"api/beta/identitynow-beta-api"},{"type":"category","label":"Access Profiles","link":{"type":"doc","id":"api/beta/access-profiles"},"items":[{"type":"doc","id":"api/beta/list-access-profiles","label":"List Access Profiles","className":"api-method get"},{"type":"doc","id":"api/beta/create-access-profile","label":"Create an Access Profile","className":"api-method post"},{"type":"doc","id":"api/beta/get-access-profile","label":"Get an Access Profile","className":"api-method get"},{"type":"doc","id":"api/beta/patch-access-profile","label":"Patch a specified Access Profile","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-access-profile","label":"Delete the specified Access Profile","className":"api-method delete"},{"type":"doc","id":"api/beta/delete-access-profiles-in-bulk","label":"Delete Access Profile(s)","className":"api-method post"},{"type":"doc","id":"api/beta/update-access-profiles-in-bulk","label":"Update Access Profile(s) requestable field.","className":"api-method post"},{"type":"doc","id":"api/beta/get-access-profile-entitlements","label":"List Access Profile's Entitlements","className":"api-method get"}]},{"type":"category","label":"Access Request Approvals","link":{"type":"doc","id":"api/beta/access-request-approvals"},"items":[{"type":"doc","id":"api/beta/list-pending-approvals","label":"Pending Access Request Approvals List","className":"api-method get"},{"type":"doc","id":"api/beta/list-completed-approvals","label":"Completed Access Request Approvals List","className":"api-method get"},{"type":"doc","id":"api/beta/approve-access-request","label":"Approves an access request approval.","className":"api-method post"},{"type":"doc","id":"api/beta/reject-access-request","label":"Rejects an access request approval.","className":"api-method post"},{"type":"doc","id":"api/beta/forward-access-request","label":"Forwards an access request approval to a new owner.","className":"api-method post"},{"type":"doc","id":"api/beta/get-access-request-approval-summary","label":"Get the number of pending, approved and rejected access requests approvals","className":"api-method get"}]},{"type":"category","label":"Access Requests","link":{"type":"doc","id":"api/beta/access-requests"},"items":[{"type":"doc","id":"api/beta/create-access-request","label":"Submit an Access Request","className":"api-method post"},{"type":"doc","id":"api/beta/cancel-access-request","label":"Cancel Access Request","className":"api-method post"},{"type":"doc","id":"api/beta/close-access-request","label":"Close Access Request","className":"api-method post"},{"type":"doc","id":"api/beta/get-access-request-config","label":"Get Access Request Configuration","className":"api-method get"},{"type":"doc","id":"api/beta/set-access-request-config","label":"Update Access Request Configuration","className":"api-method put"},{"type":"doc","id":"api/beta/list-access-request-status","label":"Access Request Status","className":"api-method get"}]},{"type":"category","label":"Access Request Identity Metrics","link":{"type":"doc","id":"api/beta/access-request-identity-metrics"},"items":[{"type":"doc","id":"api/beta/get-access-request-identity-metrics","label":"Return access request identity metrics","className":"api-method get"}]},{"type":"category","label":"Account Activities","link":{"type":"doc","id":"api/beta/account-activities"},"items":[{"type":"doc","id":"api/beta/list-account-activities","label":"List Account Activities","className":"api-method get"},{"type":"doc","id":"api/beta/get-account-activity","label":"Get Account Activity","className":"api-method get"}]},{"type":"category","label":"Account Aggregations","link":{"type":"doc","id":"api/beta/account-aggregations"},"items":[{"type":"doc","id":"api/beta/get-account-aggregation-status","label":"In-progress Account Aggregation status","className":"api-method get"}]},{"type":"category","label":"Account Usages","link":{"type":"doc","id":"api/beta/account-usages"},"items":[{"type":"doc","id":"api/beta/get-usages-by-account-id","label":"Returns account usage insights","className":"api-method get"}]},{"type":"category","label":"Accounts","link":{"type":"doc","id":"api/beta/accounts"},"items":[{"type":"doc","id":"api/beta/list-accounts","label":"Accounts List","className":"api-method get"},{"type":"doc","id":"api/beta/create-account","label":"Create Account","className":"api-method post"},{"type":"doc","id":"api/beta/get-account","label":"Account Details","className":"api-method get"},{"type":"doc","id":"api/beta/update-account","label":"Update Account","className":"api-method patch"},{"type":"doc","id":"api/beta/put-account","label":"Update Account","className":"api-method put"},{"type":"doc","id":"api/beta/delete-account","label":"Delete Account","className":"api-method delete"},{"type":"doc","id":"api/beta/get-account-entitlements","label":"Account Entitlements","className":"api-method get"},{"type":"doc","id":"api/beta/reload-account","label":"Reload Account","className":"api-method post"},{"type":"doc","id":"api/beta/enable-account","label":"Enable Account","className":"api-method post"},{"type":"doc","id":"api/beta/disable-account","label":"Disable Account","className":"api-method post"},{"type":"doc","id":"api/beta/unlock-account","label":"Unlock Account","className":"api-method post"},{"type":"doc","id":"api/beta/enable-account-for-identity","label":"Enable IDN Account for Identity","className":"api-method post"},{"type":"doc","id":"api/beta/disable-account-for-identity","label":"Disable IDN Account for Identity","className":"api-method post"},{"type":"doc","id":"api/beta/enable-accounts-for-identities","label":"Enable IDN Accounts for Identities","className":"api-method post"},{"type":"doc","id":"api/beta/disable-accounts-for-identities","label":"Disable IDN Accounts for Identities","className":"api-method post"}]},{"type":"category","label":"Certification Campaigns","link":{"type":"doc","id":"api/beta/certification-campaigns"},"items":[{"type":"doc","id":"api/beta/get-active-campaigns","label":"List Campaigns","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/create-campaign","label":"Create a campaign","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/delete-campaigns","label":"Deletes Campaigns","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/get-campaign","label":"Get a campaign","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/update-campaign","label":"Update a Campaign","className":"menu__list-item--deprecated api-method patch"},{"type":"doc","id":"api/beta/start-campaign","label":"Activate a Campaign","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/complete-campaign","label":"Complete a Campaign","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/start-campaign-remediation-scan","label":"Run Campaign Remediation Scan","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/move","label":"Reassign Certifications","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/get-campaign-reports","label":"Get Campaign Reports","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/start-campaign-report","label":"Run Campaign Report","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/get-campaign-reports-config","label":"Get Campaign Reports Configuration","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/set-campaign-reports-config","label":"Set Campaign Reports Configuration","className":"menu__list-item--deprecated api-method put"},{"type":"doc","id":"api/beta/list-campaign-templates","label":"List Campaign Templates","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/create-campaign-template","label":"Create a Campaign Template","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/get-campaign-template","label":"Get a Campaign Template","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/patch-campaign-template","label":"Update a Campaign Template","className":"menu__list-item--deprecated api-method patch"},{"type":"doc","id":"api/beta/delete-campaign-template","label":"Delete a Campaign Template","className":"menu__list-item--deprecated api-method delete"},{"type":"doc","id":"api/beta/start-generate-campaign-template","label":"Generate a Campaign from Template","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/get-campaign-template-schedule","label":"Gets a Campaign Template's Schedule","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/set-campaign-template-schedule","label":"Sets a Campaign Template's Schedule","className":"menu__list-item--deprecated api-method put"},{"type":"doc","id":"api/beta/delete-campaign-template-schedule","label":"Deletes a Campaign Template's Schedule","className":"menu__list-item--deprecated api-method delete"}]},{"type":"category","label":"Certifications","link":{"type":"doc","id":"api/beta/certifications"},"items":[{"type":"doc","id":"api/beta/submit-reassign-certs-async","label":"Reassign Certifications Asynchronously","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/get-identity-certification-task-status","label":"Certification Task Status","className":"api-method get"},{"type":"doc","id":"api/beta/get-identity-certification-pending-tasks","label":"Pending Certification Tasks","className":"api-method get"},{"type":"doc","id":"api/beta/get-identity-certification-item-permissions","label":"Permissions for Entitlement Certification Item","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/list-certification-reviewers","label":"List of Reviewers for certification","className":"menu__list-item--deprecated api-method get"}]},{"type":"category","label":"Connector Rule Management","link":{"type":"doc","id":"api/beta/connector-rule-management"},"items":[{"type":"doc","id":"api/beta/get-connector-rule-list","label":"List Connector Rules","className":"api-method get"},{"type":"doc","id":"api/beta/create-connector-rule","label":"Create Connector Rule","className":"api-method post"},{"type":"doc","id":"api/beta/get-connector-rule","label":"Connector-Rule by ID","className":"api-method get"},{"type":"doc","id":"api/beta/update-connector-rule","label":"Update a Connector Rule","className":"api-method put"},{"type":"doc","id":"api/beta/delete-connector-rule","label":"Delete a Connector-Rule","className":"api-method delete"},{"type":"doc","id":"api/beta/validate-connector-rule","label":"Validate Connector Rule","className":"api-method post"}]},{"type":"category","label":"Connectors","link":{"type":"doc","id":"api/beta/connectors"},"items":[{"type":"doc","id":"api/beta/get-connector-list","label":"Gets connector list","className":"api-method get"}]},{"type":"category","label":"Custom Forms","link":{"type":"doc","id":"api/beta/custom-forms"},"items":[{"type":"doc","id":"api/beta/search-form-definitions-by-tenant","label":"Export form definitions by tenant.","className":"api-method get"},{"type":"doc","id":"api/beta/create-form-definition","label":"Creates a form definition.","className":"api-method post"},{"type":"doc","id":"api/beta/get-form-definition-by-key","label":"Return a form definition.","className":"api-method get"},{"type":"doc","id":"api/beta/delete-form-definition","label":"Deletes a form definition.","className":"api-method delete"},{"type":"doc","id":"api/beta/patch-form-definition","label":"Patch a form definition.","className":"api-method patch"},{"type":"doc","id":"api/beta/show-preview-data-source","label":"Preview form definition data source.","className":"api-method post"},{"type":"doc","id":"api/beta/export-form-definitions-by-tenant","label":"List form definitions by tenant.","className":"api-method get"},{"type":"doc","id":"api/beta/create-form-definition-dynamic-schema","label":"Generate JSON Schema dynamically.","className":"api-method post"},{"type":"doc","id":"api/beta/import-form-definitions","label":"Import form definitions from export.","className":"api-method post"},{"type":"doc","id":"api/beta/create-form-definition-file-request","label":"Upload new form definition file.","className":"api-method post"},{"type":"doc","id":"api/beta/get-file-from-s-3","label":"Download definition file by fileId.","className":"api-method get"},{"type":"doc","id":"api/beta/search-form-instances-by-tenant","label":"List form instances by tenant.","className":"api-method get"},{"type":"doc","id":"api/beta/create-form-instance","label":"Creates a form instance.","className":"api-method post"},{"type":"doc","id":"api/beta/get-form-instance-by-key","label":"Returns a form instance.","className":"api-method get"},{"type":"doc","id":"api/beta/patch-form-instance","label":"Patch a form instance.","className":"api-method patch"},{"type":"doc","id":"api/beta/search-form-element-data-by-element-id","label":"Retrieves dynamic data by element.","className":"api-method get"},{"type":"doc","id":"api/beta/get-form-instance-file","label":"Download instance file by fileId.","className":"api-method get"},{"type":"doc","id":"api/beta/search-pre-defined-select-options","label":"List predefined select options.","className":"api-method get"}]},{"type":"category","label":"Custom Password Instructions","link":{"type":"doc","id":"api/beta/custom-password-instructions"},"items":[{"type":"doc","id":"api/beta/create-custom-password-instructions","label":"Create Custom Password Instructions","className":"api-method post"},{"type":"doc","id":"api/beta/get-custom-password-instructions","label":"Get Custom Password Instructions by Page ID","className":"api-method get"},{"type":"doc","id":"api/beta/delete-custom-password-instructions","label":"Delete Custom Password Instructions by page ID","className":"api-method delete"}]},{"type":"category","label":"Entitlements","link":{"type":"doc","id":"api/beta/entitlements"},"items":[{"type":"doc","id":"api/beta/list-entitlements","label":"Gets a list of entitlements.","className":"api-method get"},{"type":"doc","id":"api/beta/get-entitlement","label":"Get an entitlement","className":"api-method get"},{"type":"doc","id":"api/beta/patch-entitlement","label":"Patch an entitlement","className":"api-method patch"},{"type":"doc","id":"api/beta/list-entitlement-parents","label":"List of entitlements parents","className":"api-method get"},{"type":"doc","id":"api/beta/list-entitlement-children","label":"List of entitlements children","className":"api-method get"},{"type":"doc","id":"api/beta/update-entitlements-in-bulk","label":"Bulk update an entitlement list","className":"api-method post"},{"type":"doc","id":"api/beta/get-entitlement-request-config","label":"Get Entitlement Request Config","className":"api-method get"},{"type":"doc","id":"api/beta/put-entitlement-request-config","label":"Replace Entitlement Request Config","className":"api-method put"}]},{"type":"category","label":"Governance Groups","link":{"type":"doc","id":"api/beta/governance-groups"},"items":[{"type":"doc","id":"api/beta/list-workgroups","label":"List Governance Groups","className":"api-method get"},{"type":"doc","id":"api/beta/create-workgroup","label":"Create a new Governance Group.","className":"api-method post"},{"type":"doc","id":"api/beta/get-workgroup","label":"Get Governance Group by Id","className":"api-method get"},{"type":"doc","id":"api/beta/delete-workgroup","label":"Delete a Governance Group","className":"api-method delete"},{"type":"doc","id":"api/beta/patch-workgroup","label":"Patch a Governance Group","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-workgroups-in-bulk","label":"Delete Governance Group(s)","className":"api-method post"},{"type":"doc","id":"api/beta/list-connections","label":"List connections for Governance Group","className":"api-method get"},{"type":"doc","id":"api/beta/list-workgroup-members","label":"List Governance Group Members","className":"api-method get"},{"type":"doc","id":"api/beta/update-workgroup-members","label":"Add members to Governance Group","className":"api-method post"},{"type":"doc","id":"api/beta/delete-workgroup-members","label":"Remove members from Governance Group","className":"api-method post"}]},{"type":"category","label":"IAI Message Catalogs","link":{"type":"doc","id":"api/beta/iai-message-catalogs"},"items":[{"type":"doc","id":"api/beta/get-message-catalogs","label":"Get Message catalogs","className":"api-method get"}]},{"type":"category","label":"IAI Access Request Recommendations","link":{"type":"doc","id":"api/beta/iai-access-request-recommendations"},"items":[{"type":"doc","id":"api/beta/get-access-request-recommendations","label":"Identity Access Request Recommendations","className":"api-method get"},{"type":"doc","id":"api/beta/add-access-request-recommendations-ignored-item","label":"Notification of Ignored Access Request Recommendations","className":"api-method post"},{"type":"doc","id":"api/beta/get-access-request-recommendations-ignored-items","label":"List of Ignored Access Request Recommendations","className":"api-method get"},{"type":"doc","id":"api/beta/add-access-request-recommendations-requested-item","label":"Notification of Requested Access Request Recommendations","className":"api-method post"},{"type":"doc","id":"api/beta/get-access-request-recommendations-requested-items","label":"List of Requested Access Request Recommendations","className":"api-method get"},{"type":"doc","id":"api/beta/add-access-request-recommendations-viewed-item","label":"Notification of Viewed Access Request Recommendations","className":"api-method post"},{"type":"doc","id":"api/beta/get-access-request-recommendations-viewed-items","label":"List of Viewed Access Request Recommendations","className":"api-method get"},{"type":"doc","id":"api/beta/add-access-request-recommendations-viewed-items","label":"Notification of Viewed Access Request Recommendations in Bulk","className":"api-method post"}]},{"type":"category","label":"IAI Common Access","link":{"type":"doc","id":"api/beta/iai-common-access"},"items":[{"type":"doc","id":"api/beta/get-common-access","label":"Get a paginated list of common access","className":"api-method get"},{"type":"doc","id":"api/beta/create-common-access","label":"Create common access items","className":"api-method post"},{"type":"doc","id":"api/beta/update-common-access-status-in-bulk","label":"Bulk update common access status","className":"api-method post"}]},{"type":"category","label":"IAI Outliers","link":{"type":"doc","id":"api/beta/iai-outliers"},"items":[{"type":"doc","id":"api/beta/get-identity-outlier-snapshots","label":"IAI Identity Outliers Summary","className":"api-method get"},{"type":"doc","id":"api/beta/get-latest-identity-outlier-snapshots","label":"IAI Identity Outliers Latest Summary","className":"api-method get"},{"type":"doc","id":"api/beta/get-identity-outliers","label":"IAI Get Identity Outliers","className":"api-method get"},{"type":"doc","id":"api/beta/get-peer-group-outliers-contributing-features","label":"Get identity outlier's contibuting features","className":"api-method get"},{"type":"doc","id":"api/beta/list-outliers-contributing-feature-access-items","label":"Gets a list of access items associated with each identity outlier contributing feature","className":"api-method get"},{"type":"doc","id":"api/beta/ignore-identity-outliers","label":"IAI Identity Outliers Ignore","className":"api-method post"},{"type":"doc","id":"api/beta/un-ignore-identity-outliers","label":"IAI Identity Outliers Unignore","className":"api-method post"},{"type":"doc","id":"api/beta/export-outliers-zip","label":"IAI Identity Outliers Export","className":"api-method get"},{"type":"doc","id":"api/beta/get-outlier-contributing-feature-summary","label":"Get identity outlier contibuting feature summary","className":"api-method get"}]},{"type":"category","label":"IAI Peer Group Strategies","link":{"type":"doc","id":"api/beta/iai-peer-group-strategies"},"items":[{"type":"doc","id":"api/beta/get-peer-group-outliers","label":"Identity Outliers List","className":"menu__list-item--deprecated api-method get"}]},{"type":"category","label":"IAI Recommendations","link":{"type":"doc","id":"api/beta/iai-recommendations"},"items":[{"type":"doc","id":"api/beta/get-recommendations","label":"Returns a Recommendation Based on Object","className":"api-method post"},{"type":"doc","id":"api/beta/get-recommendations-config","label":"Get certification recommendation config values","className":"api-method get"},{"type":"doc","id":"api/beta/update-recommendations-config","label":"Update certification recommendation config values","className":"api-method put"}]},{"type":"category","label":"IAI Role Mining","link":{"type":"doc","id":"api/beta/iai-role-mining"},"items":[{"type":"doc","id":"api/beta/create-role-mining-sessions","label":"Create a role mining session","className":"api-method post"},{"type":"doc","id":"api/beta/get-role-mining-sessions","label":"Retrieves all role mining sessions","className":"api-method get"},{"type":"doc","id":"api/beta/patch-role-mining-session","label":"Patch a role mining session","className":"api-method patch"},{"type":"doc","id":"api/beta/get-role-mining-session","label":"Get a role mining session","className":"api-method get"},{"type":"doc","id":"api/beta/get-role-mining-session-status","label":"Get role mining session status state","className":"api-method get"},{"type":"doc","id":"api/beta/get-potential-role-summaries","label":"Retrieves all potential role summaries","className":"api-method get"},{"type":"doc","id":"api/beta/get-potential-role","label":"Retrieves a specific potential role","className":"api-method get"},{"type":"doc","id":"api/beta/patch-potential-role","label":"Update a potential role","className":"api-method patch"},{"type":"doc","id":"api/beta/get-potential-role-applications","label":"Retrieves the applications of a potential role for a role mining session","className":"api-method get"},{"type":"doc","id":"api/beta/get-entitlements-potential-role","label":"Retrieves entitlements for a potential role in a role mining session","className":"api-method get"},{"type":"doc","id":"api/beta/get-entitlement-distribution-potential-role","label":"Retrieves entitlement popularity distribution for a potential role in a role mining session","className":"api-method get"},{"type":"doc","id":"api/beta/update-entitlements-potential-role","label":"Edit entitlements for a potential role to exclude some entitlements","className":"api-method post"},{"type":"doc","id":"api/beta/get-identities-potential-role","label":"Retrieves identities for a potential role in a role mining session","className":"api-method get"},{"type":"doc","id":"api/beta/export-role-mining-potential-role","label":"Export (download) details for a potential role in a role mining session","className":"api-method get"},{"type":"doc","id":"api/beta/export-role-mining-potential-role-async","label":"Asynchronously export details for a potential role in a role mining session and upload to S3","className":"api-method post"},{"type":"doc","id":"api/beta/export-role-mining-potential-role-status","label":"Retrieve status of a potential role export job","className":"api-method get"},{"type":"doc","id":"api/beta/download-role-mining-potential-role-zip","label":"Export (download) details for a potential role in a role mining session","className":"api-method get"},{"type":"doc","id":"api/beta/create-potential-role-provision-request","label":"Create request to provision a potential role into an actual role.","className":"api-method post"},{"type":"doc","id":"api/beta/get-excluded-entitlements-potential-role","label":"Retrieves excluded entitlements for a potential role in a role mining session","className":"api-method get"},{"type":"doc","id":"api/beta/get-all-potential-role-summaries","label":"Retrieves all potential role summaries","className":"api-method get"},{"type":"doc","id":"api/beta/get-role-mining-potential-role","label":"Retrieves a specific potential role","className":"api-method get"},{"type":"doc","id":"api/beta/patch-potential-role","label":"Update a potential role","className":"api-method patch"},{"type":"doc","id":"api/beta/get-saved-potential-roles","label":"Retrieves all saved potential roles","className":"api-method get"},{"type":"doc","id":"api/beta/get-potential-role-source-identity-usage","label":"Retrieves potential role source usage","className":"api-method get"}]},{"type":"category","label":"Identities","link":{"type":"doc","id":"api/beta/identities"},"items":[{"type":"doc","id":"api/beta/synchronize-attributes-for-identity","label":"Attribute synchronization for single identity.","className":"api-method post"},{"type":"doc","id":"api/beta/get-identity-ownership-details","label":"Get ownership details","className":"api-method get"},{"type":"doc","id":"api/beta/list-identities","label":"List Identities","className":"api-method get"},{"type":"doc","id":"api/beta/get-identity","label":"Identity Details","className":"api-method get"},{"type":"doc","id":"api/beta/delete-identity","label":"Deletes an identity.","className":"api-method delete"},{"type":"doc","id":"api/beta/start-identity-processing","label":"Process a list of identityIds","className":"api-method post"}]},{"type":"category","label":"Identity Attributes","link":{"type":"doc","id":"api/beta/identity-attributes"},"items":[{"type":"doc","id":"api/beta/list-identity-attributes","label":"List Identity Attributes","className":"api-method get"},{"type":"doc","id":"api/beta/create-identity-attribute","label":"Create Identity Attribute","className":"api-method post"},{"type":"doc","id":"api/beta/get-identity-attribute","label":"Get Identity Attribute","className":"api-method get"},{"type":"doc","id":"api/beta/put-identity-attribute","label":"Update Identity Attribute","className":"api-method put"},{"type":"doc","id":"api/beta/delete-identity-attribute","label":"Delete Identity Attribute","className":"api-method delete"},{"type":"doc","id":"api/beta/delete-identity-attributes-in-bulk","label":"Bulk delete Identity Attributes","className":"api-method post"}]},{"type":"category","label":"Identity History","link":{"type":"doc","id":"api/beta/identity-history"},"items":[{"type":"doc","id":"api/beta/list-historical-identities","label":"Lists all the identities","className":"api-method get"},{"type":"doc","id":"api/beta/get-historical-identity","label":"Get latest snapshot of identity","className":"api-method get"},{"type":"doc","id":"api/beta/list-identity-access-items","label":"Gets a list of access items for the identity filtered by item type","className":"api-method get"},{"type":"doc","id":"api/beta/list-identity-snapshots","label":"Lists all the snapshots for the identity","className":"api-method get"},{"type":"doc","id":"api/beta/get-identity-snapshot-summary","label":"Gets the summary for the event count for a specific identity","className":"api-method get"},{"type":"doc","id":"api/beta/get-identity-snapshot","label":"Gets an identity snapshot at a given date","className":"api-method get"},{"type":"doc","id":"api/beta/list-identity-snapshot-access-items","label":"Gets the list of identity access items at a given date filterd by item type","className":"api-method get"},{"type":"doc","id":"api/beta/get-historical-identity-events","label":"Lists all events for the given identity","className":"api-method get"},{"type":"doc","id":"api/beta/get-identity-start-date","label":"Gets the start date of the identity","className":"api-method get"},{"type":"doc","id":"api/beta/compare-identity-snapshots","label":"Gets a difference of count for each access item types for the given identity between 2 snapshots","className":"api-method get"},{"type":"doc","id":"api/beta/compare-identity-snapshots-access-type","label":"Gets a list of differences of specific accessType for the given identity between 2 snapshots","className":"api-method get"}]},{"type":"category","label":"Identity Profiles","link":{"type":"doc","id":"api/beta/identity-profiles"},"items":[{"type":"doc","id":"api/beta/list-identity-profiles","label":"Identity Profiles list","className":"api-method get"},{"type":"doc","id":"api/beta/create-identity-profile","label":"Create an Identity Profile","className":"api-method post"},{"type":"doc","id":"api/beta/delete-identity-profiles","label":"Delete Identity Profiles","className":"api-method post"},{"type":"doc","id":"api/beta/export-identity-profiles","label":"Export Identity Profiles","className":"api-method get"},{"type":"doc","id":"api/beta/import-identity-profiles","label":"Import Identity Profiles","className":"api-method post"},{"type":"doc","id":"api/beta/generate-identity-preview","label":"Generate Identity Profile Preview","className":"api-method post"},{"type":"doc","id":"api/beta/get-identity-profile","label":"Gets a single Identity Profile","className":"api-method get"},{"type":"doc","id":"api/beta/delete-identity-profile","label":"Delete an Identity Profile","className":"api-method delete"},{"type":"doc","id":"api/beta/update-identity-profile","label":"Update the Identity Profile","className":"api-method patch"},{"type":"doc","id":"api/beta/get-default-identity-attribute-config","label":"Default identity attribute config","className":"api-method get"},{"type":"doc","id":"api/beta/sync-identity-profile","label":"Process identities under profile","className":"api-method post"}]},{"type":"category","label":"Lifecycle States","link":{"type":"doc","id":"api/beta/lifecycle-states"},"items":[{"type":"doc","id":"api/beta/list-lifecycle-states","label":"Lifecycle State","className":"api-method get"},{"type":"doc","id":"api/beta/update-lifecycle-states","label":"Update Lifecycle State","className":"api-method patch"}]},{"type":"category","label":"Managed Clients","link":{"type":"doc","id":"api/beta/managed-clients"},"items":[{"type":"doc","id":"api/beta/get-managed-client-status","label":"Specified Managed Client Status.","className":"api-method get"},{"type":"doc","id":"api/beta/update-managed-client-status","label":"Handle status request from client","className":"api-method post"}]},{"type":"category","label":"Managed Clusters","link":{"type":"doc","id":"api/beta/managed-clusters"},"items":[{"type":"doc","id":"api/beta/get-managed-cluster","label":"Get a specified ManagedCluster.","className":"api-method get"},{"type":"doc","id":"api/beta/get-client-log-configuration","label":"Get managed cluster's log configuration","className":"api-method get"},{"type":"doc","id":"api/beta/put-client-log-configuration","label":"Update managed cluster's log configuration","className":"api-method put"},{"type":"doc","id":"api/beta/get-managed-clusters","label":"Retrieve all Managed Clusters.","className":"api-method get"}]},{"type":"category","label":"MFA Configuration","link":{"type":"doc","id":"api/beta/mfa-configuration"},"items":[{"type":"doc","id":"api/beta/get-mfa-okta-config","label":"Configuration of Okta MFA method","className":"api-method get"},{"type":"doc","id":"api/beta/set-mfa-okta-config","label":"Set Okta MFA configuration","className":"api-method put"},{"type":"doc","id":"api/beta/get-mfa-duo-config","label":"Configuration of Duo MFA method","className":"api-method get"},{"type":"doc","id":"api/beta/set-mfa-duo-config","label":"Set Duo MFA configuration","className":"api-method put"},{"type":"doc","id":"api/beta/test-mfa-config","label":"MFA method's test configuration","className":"api-method get"},{"type":"doc","id":"api/beta/delete-mfa-config","label":"Delete MFA method configuration","className":"api-method delete"}]},{"type":"category","label":"MFA Controller","link":{"type":"doc","id":"api/beta/mfa-controller"},"items":[{"type":"doc","id":"api/beta/send-okta-verify-request","label":"Verifying authentication via Okta method","className":"api-method post"},{"type":"doc","id":"api/beta/send-duo-verify-request","label":"Verifying authentication via Duo method","className":"api-method post"},{"type":"doc","id":"api/beta/ping-verification-status","label":"Polling MFA method by VerificationPollRequest","className":"api-method post"},{"type":"doc","id":"api/beta/send-kba-answers","label":"Authenticate KBA provided MFA method","className":"api-method post"},{"type":"doc","id":"api/beta/send-token-auth-request","label":"Authenticate Token provided MFA method","className":"api-method post"},{"type":"doc","id":"api/beta/create-send-token","label":"Create and send user token","className":"api-method post"}]},{"type":"category","label":"Non-Employee Lifecycle Management","link":{"type":"doc","id":"api/beta/non-employee-lifecycle-management"},"items":[{"type":"doc","id":"api/beta/create-non-employee-record","label":"Create Non-Employee Record","className":"api-method post"},{"type":"doc","id":"api/beta/list-non-employee-records","label":"List Non-Employee Records","className":"api-method get"},{"type":"doc","id":"api/beta/get-non-employee-record","label":"Get a Non-Employee Record","className":"api-method get"},{"type":"doc","id":"api/beta/update-non-employee-record","label":"Update Non-Employee Record","className":"api-method put"},{"type":"doc","id":"api/beta/patch-non-employee-record","label":"Patch Non-Employee Record","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-non-employee-record","label":"Delete Non-Employee Record","className":"api-method delete"},{"type":"doc","id":"api/beta/delete-non-employee-record-in-bulk","label":"Delete Multiple Non-Employee Records","className":"api-method post"},{"type":"doc","id":"api/beta/create-non-employee-request","label":"Create Non-Employee Request","className":"api-method post"},{"type":"doc","id":"api/beta/list-non-employee-requests","label":"List Non-Employee Requests","className":"api-method get"},{"type":"doc","id":"api/beta/get-non-employee-request","label":"Get a Non-Employee Request","className":"api-method get"},{"type":"doc","id":"api/beta/delete-non-employee-request","label":"Delete Non-Employee Request","className":"api-method delete"},{"type":"doc","id":"api/beta/get-non-employee-request-summary","label":"Get Summary of Non-Employee Requests","className":"api-method get"},{"type":"doc","id":"api/beta/create-non-employee-source","label":"Create Non-Employee Source","className":"api-method post"},{"type":"doc","id":"api/beta/list-non-employee-sources","label":"List Non-Employee Sources","className":"api-method get"},{"type":"doc","id":"api/beta/get-non-employee-source","label":"Get a Non-Employee Source","className":"api-method get"},{"type":"doc","id":"api/beta/patch-non-employee-source","label":"Patch a Non-Employee Source","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-non-employee-source","label":"Delete Non-Employee Source","className":"api-method delete"},{"type":"doc","id":"api/beta/export-non-employee-records","label":"Exports Non-Employee Records to CSV","className":"api-method get"},{"type":"doc","id":"api/beta/import-non-employee-records-in-bulk","label":"Imports, or Updates, Non-Employee Records","className":"api-method post"},{"type":"doc","id":"api/beta/get-non-employee-bulk-upload-status","label":"Bulk upload status on source","className":"api-method get"},{"type":"doc","id":"api/beta/export-non-employee-source-schema-template","label":"Exports Source Schema Template","className":"api-method get"},{"type":"doc","id":"api/beta/list-non-employee-approval","label":"Get List of Non-Employee Approval Requests","className":"api-method get"},{"type":"doc","id":"api/beta/get-non-employee-approval","label":"Get a non-employee approval item detail","className":"api-method get"},{"type":"doc","id":"api/beta/approve-non-employee-request","label":"Approve a Non-Employee Request","className":"api-method post"},{"type":"doc","id":"api/beta/reject-non-employee-request","label":"Reject a Non-Employee Request","className":"api-method post"},{"type":"doc","id":"api/beta/get-non-employee-approval-summary","label":"Get Summary of Non-Employee Approval Requests","className":"api-method get"},{"type":"doc","id":"api/beta/get-non-employee-source-schema-attributes","label":"List Schema Attributes Non-Employee Source","className":"api-method get"},{"type":"doc","id":"api/beta/create-non-employee-source-schema-attributes","label":"Create Non-Employee Source Schema Attribute","className":"api-method post"},{"type":"doc","id":"api/beta/delete-non-employee-source-schema-attributes","label":"Delete all custom schema attributes","className":"api-method delete"},{"type":"doc","id":"api/beta/get-non-employee-schema-attribute","label":"Get Schema Attribute Non-Employee Source","className":"api-method get"},{"type":"doc","id":"api/beta/patch-non-employee-schema-attribute","label":"Patch Non-Employee Source's Schema Attribute","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-non-employee-schema-attribute","label":"Delete Non-Employee Source's Schema Attribute","className":"api-method delete"}]},{"type":"category","label":"Notifications","link":{"type":"doc","id":"api/beta/notifications"},"items":[{"type":"doc","id":"api/beta/put-mail-from-attributes","label":"Change MAIL FROM domain","className":"api-method put"},{"type":"doc","id":"api/beta/get-mail-from-attributes","label":"Get MAIL FROM Attributes","className":"api-method get"},{"type":"doc","id":"api/beta/list-notification-template-defaults","label":"List Notification Template Defaults","className":"api-method get"},{"type":"doc","id":"api/beta/list-notification-templates","label":"List Notification Templates","className":"api-method get"},{"type":"doc","id":"api/beta/create-notification-template","label":"Create Notification Template","className":"api-method post"},{"type":"doc","id":"api/beta/get-notification-template","label":"Get Notification Template By Id","className":"api-method get"},{"type":"doc","id":"api/beta/delete-notification-templates-in-bulk","label":"Bulk Delete Notification Templates","className":"api-method post"},{"type":"doc","id":"api/beta/get-notifications-template-context","label":"Get Notification Template Context","className":"api-method get"},{"type":"doc","id":"api/beta/get-notification-preference","label":"Get Notification Preferences for tenant.","className":"api-method get"},{"type":"doc","id":"api/beta/put-notification-preference","label":"Overwrite preferences notification key.","className":"api-method put"},{"type":"doc","id":"api/beta/send-test-notification","label":"Send Test Notification","className":"api-method post"},{"type":"doc","id":"api/beta/list-from-addresses","label":"List From Addresses","className":"api-method get"},{"type":"doc","id":"api/beta/create-verified-from-address","label":"Create Verified From Address","className":"api-method post"},{"type":"doc","id":"api/beta/delete-verified-from-address","label":"Delete Verified From Address","className":"api-method delete"},{"type":"doc","id":"api/beta/get-dkim-attributes","label":"Get DKIM Attributes","className":"api-method get"},{"type":"doc","id":"api/beta/create-domain-dkim","label":"Verify domain address via DKIM","className":"api-method post"}]},{"type":"category","label":"OAuth Clients","link":{"type":"doc","id":"api/beta/o-auth-clients"},"items":[{"type":"doc","id":"api/beta/list-oauth-clients","label":"List OAuth Clients","className":"api-method get"},{"type":"doc","id":"api/beta/create-oauth-client","label":"Create OAuth Client","className":"api-method post"},{"type":"doc","id":"api/beta/get-oauth-client","label":"Get OAuth Client","className":"api-method get"},{"type":"doc","id":"api/beta/delete-oauth-client","label":"Delete OAuth Client","className":"api-method delete"},{"type":"doc","id":"api/beta/patch-oauth-client","label":"Patch OAuth Client","className":"api-method patch"}]},{"type":"category","label":"Org Config","link":{"type":"doc","id":"api/beta/org-config"},"items":[{"type":"doc","id":"api/beta/get-org-config","label":"Get Org configuration settings","className":"api-method get"},{"type":"doc","id":"api/beta/patch-org-config","label":"Patch an Org configuration property","className":"api-method patch"},{"type":"doc","id":"api/beta/get-valid-time-zones","label":"Get list of time zones","className":"api-method get"}]},{"type":"category","label":"Password Configuration","link":{"type":"doc","id":"api/beta/password-configuration"},"items":[{"type":"doc","id":"api/beta/get-password-org-config","label":"Get Password Org Config","className":"api-method get"},{"type":"doc","id":"api/beta/put-password-org-config","label":"Update Password Org Config","className":"api-method put"},{"type":"doc","id":"api/beta/create-password-org-config","label":"Create Password Org Config","className":"api-method post"}]},{"type":"category","label":"Password Dictionary","link":{"type":"doc","id":"api/beta/password-dictionary"},"items":[{"type":"doc","id":"api/beta/get-password-dictionary","label":"Get Password Dictionary","className":"api-method get"},{"type":"doc","id":"api/beta/put-password-dictionary","label":"Update Password Dictionary","className":"api-method put"}]},{"type":"category","label":"Password Management","link":{"type":"doc","id":"api/beta/password-management"},"items":[{"type":"doc","id":"api/beta/generate-digit-token","label":"Generate a digit token","className":"api-method post"},{"type":"doc","id":"api/beta/query-password-info","label":"Query Password Info","className":"api-method post"},{"type":"doc","id":"api/beta/set-identity-password","label":"Set Identity's Password","className":"api-method post"},{"type":"doc","id":"api/beta/get-identity-password-change-status","label":"Get Password Change Request Status","className":"api-method get"}]},{"type":"category","label":"Password Sync Groups","link":{"type":"doc","id":"api/beta/password-sync-groups"},"items":[{"type":"doc","id":"api/beta/get-password-sync-groups","label":"Get Password Sync Group List","className":"api-method get"},{"type":"doc","id":"api/beta/create-password-sync-group","label":"Create Password Sync Group","className":"api-method post"},{"type":"doc","id":"api/beta/get-password-sync-group","label":"Get Password Sync Group by ID","className":"api-method get"},{"type":"doc","id":"api/beta/update-password-sync-group","label":"Update Password Sync Group by ID","className":"api-method put"},{"type":"doc","id":"api/beta/delete-password-sync-group","label":"Delete Password Sync Group by ID","className":"api-method delete"}]},{"type":"category","label":"Personal Access Tokens","link":{"type":"doc","id":"api/beta/personal-access-tokens"},"items":[{"type":"doc","id":"api/beta/list-personal-access-tokens","label":"List Personal Access Tokens","className":"api-method get"},{"type":"doc","id":"api/beta/create-personal-access-token","label":"Create Personal Access Token","className":"api-method post"},{"type":"doc","id":"api/beta/patch-personal-access-token","label":"Patch Personal Access Token","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-personal-access-token","label":"Delete Personal Access Token","className":"api-method delete"}]},{"type":"category","label":"Public Identities Config","link":{"type":"doc","id":"api/beta/public-identities-config"},"items":[{"type":"doc","id":"api/beta/get-public-identity-config","label":"Get Public Identity Config","className":"api-method get"},{"type":"doc","id":"api/beta/update-public-identity-config","label":"Update Public Identity Config","className":"api-method put"}]},{"type":"category","label":"Requestable Objects","link":{"type":"doc","id":"api/beta/requestable-objects"},"items":[{"type":"doc","id":"api/beta/list-requestable-objects","label":"Requestable Objects List","className":"api-method get"}]},{"type":"category","label":"Role Insights","link":{"type":"doc","id":"api/beta/role-insights"},"items":[{"type":"doc","id":"api/beta/create-role-insight-requests","label":"Generate insights for roles","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/get-role-insights-requests","label":"Returns metadata from prior request.","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/get-role-insights-summary","label":"Get role insights summary information","className":"api-method get"},{"type":"doc","id":"api/beta/get-role-insights","label":"Get role insights","className":"api-method get"},{"type":"doc","id":"api/beta/get-role-insight","label":"Get a single role insight","className":"api-method get"},{"type":"doc","id":"api/beta/get-role-insights-entitlements-changes","label":"Get entitlement insights for a role","className":"api-method get"},{"type":"doc","id":"api/beta/download-role-insights-entitlements-changes","label":"Download entitlement insights for a role","className":"api-method get"},{"type":"doc","id":"api/beta/get-role-insights-current-entitlements","label":"Get current entitlement for a role","className":"api-method get"},{"type":"doc","id":"api/beta/get-entitlement-changes-identities","label":"Get identities for a suggested entitlement (for a role)","className":"api-method get"}]},{"type":"category","label":"Roles","link":{"type":"doc","id":"api/beta/roles"},"items":[{"type":"doc","id":"api/beta/list-roles","label":"List Roles","className":"api-method get"},{"type":"doc","id":"api/beta/create-role","label":"Create a Role","className":"api-method post"},{"type":"doc","id":"api/beta/get-role","label":"Get a Role","className":"api-method get"},{"type":"doc","id":"api/beta/patch-role","label":"Patch a specified Role","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-role","label":"Delete a Role","className":"api-method delete"},{"type":"doc","id":"api/beta/bulk-delete-roles","label":"Delete Role(s)","className":"api-method post"},{"type":"doc","id":"api/beta/get-role-assigned-identities","label":"Identities assigned a Role","className":"api-method get"},{"type":"doc","id":"api/beta/get-role-entitlements","label":"List role's Entitlements","className":"api-method get"}]},{"type":"category","label":"Search Attribute Configuration","link":{"type":"doc","id":"api/beta/search-attribute-configuration"},"items":[{"type":"doc","id":"api/beta/create-search-attribute-config","label":"Configure/create extended search attributes in IdentityNow.","className":"api-method post"},{"type":"doc","id":"api/beta/get-search-attribute-config","label":"Retrieve a list of extended search attributes in IdentityNow.","className":"api-method get"},{"type":"doc","id":"api/beta/get-single-search-attribute-config","label":"Get the details of a specific extended search attribute in IdentityNow.","className":"api-method get"},{"type":"doc","id":"api/beta/delete-search-attribute-config","label":"Delete an extended search attribute in IdentityNow.","className":"api-method delete"},{"type":"doc","id":"api/beta/patch-search-attribute-config","label":"Update the details of a specific extended search attribute in IdentityNow.","className":"api-method patch"}]},{"type":"category","label":"Segments","link":{"type":"doc","id":"api/beta/segments"},"items":[{"type":"doc","id":"api/beta/create-segment","label":"Create Segment","className":"api-method post"},{"type":"doc","id":"api/beta/list-segments","label":"List Segments","className":"api-method get"},{"type":"doc","id":"api/beta/get-segment","label":"Get Segment by ID","className":"api-method get"},{"type":"doc","id":"api/beta/delete-segment","label":"Delete Segment by ID","className":"api-method delete"},{"type":"doc","id":"api/beta/patch-segment","label":"Update Segment","className":"api-method patch"}]},{"type":"category","label":"Service Desk Integration","link":{"type":"doc","id":"api/beta/service-desk-integration"},"items":[{"type":"doc","id":"api/beta/get-service-desk-integration-list","label":"List existing Service Desk Integrations","className":"api-method get"},{"type":"doc","id":"api/beta/create-service-desk-integration","label":"Create new Service Desk integration","className":"api-method post"},{"type":"doc","id":"api/beta/get-service-desk-integration","label":"Get a Service Desk integration","className":"api-method get"},{"type":"doc","id":"api/beta/put-service-desk-integration","label":"Update a Service Desk integration","className":"api-method put"},{"type":"doc","id":"api/beta/delete-service-desk-integration","label":"Delete a Service Desk integration","className":"api-method delete"},{"type":"doc","id":"api/beta/patch-service-desk-integration","label":"Service Desk Integration Update PATCH","className":"api-method patch"},{"type":"doc","id":"api/beta/get-service-desk-integration-types","label":"Service Desk Integration Types List.","className":"api-method get"},{"type":"doc","id":"api/beta/get-service-desk-integration-template","label":"Service Desk integration template by scriptName.","className":"api-method get"},{"type":"doc","id":"api/beta/get-status-check-details","label":"Get the time check configuration","className":"api-method get"},{"type":"doc","id":"api/beta/update-status-check-details","label":"Update the time check configuration","className":"api-method put"}]},{"type":"category","label":"SOD Policy","link":{"type":"doc","id":"api/beta/sod-policy"},"items":[{"type":"doc","id":"api/beta/create-sod-policy","label":"Create SOD policy","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/list-sod-policies","label":"List SOD policies","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/get-sod-policy","label":"Get SOD policy by ID","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/put-sod-policy","label":"Update SOD policy by ID","className":"menu__list-item--deprecated api-method put"},{"type":"doc","id":"api/beta/delete-sod-policy","label":"Delete SOD policy by ID","className":"menu__list-item--deprecated api-method delete"},{"type":"doc","id":"api/beta/patch-sod-policy","label":"Patch a SOD policy","className":"menu__list-item--deprecated api-method patch"},{"type":"doc","id":"api/beta/get-sod-policy-schedule","label":"Get SOD policy schedule","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/put-policy-schedule","label":"Update SOD Policy schedule","className":"menu__list-item--deprecated api-method put"},{"type":"doc","id":"api/beta/delete-sod-policy-schedule","label":"Delete SOD policy schedule","className":"menu__list-item--deprecated api-method delete"},{"type":"doc","id":"api/beta/start-sod-policy","label":"Runs SOD policy violation report","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/get-sod-violation-report-status","label":"Get SOD violation report status","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/get-sod-violation-report-run-status","label":"Get violation report run status","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/start-sod-all-policies-for-org","label":"Runs all policies for org","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/get-sod-all-report-run-status","label":"Get multi-report run task status","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/get-default-violation-report","label":"Download violation report","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/get-custom-violation-report","label":"Download custom violation report","className":"menu__list-item--deprecated api-method get"}]},{"type":"category","label":"SOD Violations","link":{"type":"doc","id":"api/beta/sod-violations"},"items":[{"type":"doc","id":"api/beta/start-predict-sod-violations","label":"Predict SOD violations for identity.","className":"menu__list-item--deprecated api-method post"}]},{"type":"category","label":"Source Usages","link":{"type":"doc","id":"api/beta/source-usages"},"items":[{"type":"doc","id":"api/beta/get-status-by-source-id","label":"Finds status of source usage","className":"api-method get"},{"type":"doc","id":"api/beta/get-usages-by-source-id","label":"Returns source usage insights","className":"api-method get"}]},{"type":"category","label":"Sources","link":{"type":"doc","id":"api/beta/sources"},"items":[{"type":"doc","id":"api/beta/list-sources","label":"Lists all sources in IdentityNow.","className":"api-method get"},{"type":"doc","id":"api/beta/create-source","label":"Creates a source in IdentityNow.","className":"api-method post"},{"type":"doc","id":"api/beta/get-source","label":"Get Source by ID","className":"api-method get"},{"type":"doc","id":"api/beta/put-source","label":"Update Source (Full)","className":"api-method put"},{"type":"doc","id":"api/beta/update-source","label":"Update Source (Partial)","className":"api-method patch"},{"type":"doc","id":"api/beta/delete","label":"Delete Source by ID","className":"api-method delete"},{"type":"doc","id":"api/beta/get-source-attr-sync-config","label":"Attribute Sync Config","className":"api-method get"},{"type":"doc","id":"api/beta/put-source-attr-sync-config","label":"Update Attribute Sync Config","className":"api-method put"},{"type":"doc","id":"api/beta/test-source-connection","label":"Check connection for source connector.","className":"api-method post"},{"type":"doc","id":"api/beta/peek-resource-objects","label":"Peek source connector's resource objects","className":"api-method post"},{"type":"doc","id":"api/beta/ping-cluster","label":"Ping cluster for source connector","className":"api-method post"},{"type":"doc","id":"api/beta/test-source-configuration","label":"Test configuration for source connector","className":"api-method post"},{"type":"doc","id":"api/beta/get-source-config","label":"Gets source config with language translations","className":"api-method get"},{"type":"doc","id":"api/beta/get-native-change-detection-config","label":"Native Change Detection Configuration","className":"api-method get"},{"type":"doc","id":"api/beta/put-native-change-detection-config","label":"Update Native Change Detection Configuration","className":"api-method put"},{"type":"doc","id":"api/beta/delete-native-change-detection-config","label":"Delete Native Change Detection Configuration","className":"api-method delete"},{"type":"doc","id":"api/beta/list-provisioning-policies","label":"Lists ProvisioningPolicies","className":"api-method get"},{"type":"doc","id":"api/beta/create-provisioning-policy","label":"Create Provisioning Policy","className":"api-method post"},{"type":"doc","id":"api/beta/get-provisioning-policy","label":"Get Provisioning Policy by UsageType","className":"api-method get"},{"type":"doc","id":"api/beta/put-provisioning-policy","label":"Update Provisioning Policy by UsageType","className":"api-method put"},{"type":"doc","id":"api/beta/update-provisioning-policy","label":"Partial update of Provisioning Policy","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-provisioning-policy","label":"Delete Provisioning Policy by UsageType","className":"api-method delete"},{"type":"doc","id":"api/beta/update-provisioning-policies-in-bulk","label":"Bulk Update Provisioning Policies","className":"api-method post"},{"type":"doc","id":"api/beta/list-source-schemas","label":"Lists the Schemas that exist on the specified Source in IdentityNow.","className":"api-method get"},{"type":"doc","id":"api/beta/create-source-schema","label":"Creates a new Schema on the specified Source in IdentityNow.","className":"api-method post"},{"type":"doc","id":"api/beta/get-source-schema","label":"Get Source Schema by ID","className":"api-method get"},{"type":"doc","id":"api/beta/put-source-schema","label":"Update Source Schema (Full)","className":"api-method put"},{"type":"doc","id":"api/beta/update-source-schema","label":"Update Source Schema (Partial)","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-source-schema","label":"Delete Source Schema by ID","className":"api-method delete"},{"type":"doc","id":"api/beta/get-source-accounts-schema","label":"Downloads source accounts schema template","className":"api-method get"},{"type":"doc","id":"api/beta/import-source-accounts-schema","label":"Uploads source accounts schema template","className":"api-method post"},{"type":"doc","id":"api/beta/get-source-entitlements-schema","label":"Downloads source entitlements schema template","className":"api-method get"},{"type":"doc","id":"api/beta/import-source-entitlements-schema","label":"Uploads source entitlements schema template","className":"api-method post"},{"type":"doc","id":"api/beta/import-source-connector-file","label":"Upload connector file to source","className":"api-method post"},{"type":"doc","id":"api/beta/sync-attributes-for-source","label":"Synchronize single source attributes.","className":"api-method post"},{"type":"doc","id":"api/beta/get-source-entitlement-request-config","label":"Get Source Entitlement Request Configuration","className":"api-method get"},{"type":"doc","id":"api/beta/update-source-entitlement-request-config","label":"Update Source Entitlement Request Configuration","className":"api-method put"}]},{"type":"category","label":"SP-Config","link":{"type":"doc","id":"api/beta/sp-config"},"items":[{"type":"doc","id":"api/beta/export-sp-config","label":"Initiates configuration objects export job","className":"api-method post"},{"type":"doc","id":"api/beta/get-sp-config-export-status","label":"Get export job status","className":"api-method get"},{"type":"doc","id":"api/beta/get-sp-config-export","label":"Download export job result.","className":"api-method get"},{"type":"doc","id":"api/beta/import-sp-config","label":"Initiates configuration objects import job","className":"api-method post"},{"type":"doc","id":"api/beta/get-sp-config-import-status","label":"Get import job status","className":"api-method get"},{"type":"doc","id":"api/beta/get-sp-config-import","label":"Download import job result","className":"api-method get"},{"type":"doc","id":"api/beta/list-sp-config-objects","label":"Get config object details","className":"api-method get"}]},{"type":"category","label":"Tagged Objects","link":{"type":"doc","id":"api/beta/tagged-objects"},"items":[{"type":"doc","id":"api/beta/list-tagged-objects","label":"List Tagged Objects","className":"api-method get"},{"type":"doc","id":"api/beta/set-tag-to-object","label":"Add Tag to Object","className":"api-method post"},{"type":"doc","id":"api/beta/list-tagged-objects-by-type","label":"List Tagged Objects by Type","className":"api-method get"},{"type":"doc","id":"api/beta/get-tagged-object","label":"Get Tagged Object","className":"api-method get"},{"type":"doc","id":"api/beta/put-tagged-object","label":"Update Tagged Object","className":"api-method put"},{"type":"doc","id":"api/beta/delete-tagged-object","label":"Delete Tagged Object","className":"api-method delete"},{"type":"doc","id":"api/beta/set-tags-to-many-objects","label":"Tag Multiple Objects","className":"api-method post"},{"type":"doc","id":"api/beta/delete-tags-to-many-object","label":"Remove Tags from Multiple Objects","className":"api-method post"}]},{"type":"category","label":"Task Management","link":{"type":"doc","id":"api/beta/task-management"},"items":[{"type":"doc","id":"api/beta/get-task-status","label":"Get task status by ID.","className":"api-method get"},{"type":"doc","id":"api/beta/update-task-status","label":"Update task status by ID","className":"api-method patch"},{"type":"doc","id":"api/beta/get-task-status-list","label":"Retrieve a task status list.","className":"api-method get"},{"type":"doc","id":"api/beta/get-pending-tasks","label":"Retrieve a pending task list.","className":"api-method get"},{"type":"doc","id":"api/beta/get-pending-task-headers","label":"Retrieve headers only for pending task list.","className":"api-method head"}]},{"type":"category","label":"Tenant","link":{"type":"doc","id":"api/beta/tenant"},"items":[{"type":"doc","id":"api/beta/get-tenant","label":"Get Tenant Information.","className":"api-method get"}]},{"type":"category","label":"Transforms","link":{"type":"doc","id":"api/beta/transforms"},"items":[{"type":"doc","id":"api/beta/list-transforms","label":"List transforms","className":"api-method get"},{"type":"doc","id":"api/beta/create-transform","label":"Create transform","className":"api-method post"},{"type":"doc","id":"api/beta/get-transform","label":"Transform by ID","className":"api-method get"},{"type":"doc","id":"api/beta/update-transform","label":"Update a transform","className":"api-method put"},{"type":"doc","id":"api/beta/delete-transform","label":"Delete a transform","className":"api-method delete"}]},{"type":"category","label":"Triggers","link":{"type":"doc","id":"api/beta/triggers"},"items":[{"type":"doc","id":"api/beta/list-triggers","label":"List Triggers","className":"api-method get"},{"type":"doc","id":"api/beta/create-subscription","label":"Create a Subscription","className":"api-method post"},{"type":"doc","id":"api/beta/list-subscriptions","label":"List Subscriptions","className":"api-method get"},{"type":"doc","id":"api/beta/update-subscription","label":"Update a Subscription","className":"api-method put"},{"type":"doc","id":"api/beta/patch-subscription","label":"Patch a Subscription","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-subscription","label":"Delete a Subscription","className":"api-method delete"},{"type":"doc","id":"api/beta/test-subscription-filter","label":"Validate a Subscription Filter","className":"api-method post"},{"type":"doc","id":"api/beta/list-trigger-invocation-status","label":"List Latest Invocation Statuses","className":"api-method get"},{"type":"doc","id":"api/beta/complete-trigger-invocation","label":"Complete Trigger Invocation","className":"api-method post"},{"type":"doc","id":"api/beta/start-test-trigger-invocation","label":"Start a Test Invocation","className":"api-method post"}]},{"type":"category","label":"Work Items","link":{"type":"doc","id":"api/beta/work-items"},"items":[{"type":"doc","id":"api/beta/list-work-items","label":"List Work Items","className":"api-method get"},{"type":"doc","id":"api/beta/get-completed-work-items","label":"Completed Work Items","className":"api-method get"},{"type":"doc","id":"api/beta/get-count-work-items","label":"Count Work Items","className":"api-method get"},{"type":"doc","id":"api/beta/get-count-completed-work-items","label":"Count Completed Work Items","className":"api-method get"},{"type":"doc","id":"api/beta/get-work-items-summary","label":"Work Items Summary","className":"api-method get"},{"type":"doc","id":"api/beta/get-work-item","label":"Get a Work Item","className":"api-method get"},{"type":"doc","id":"api/beta/complete-work-item","label":"Complete a Work Item","className":"api-method post"},{"type":"doc","id":"api/beta/forward-work-item","label":"Forward a Work Item","className":"api-method post"},{"type":"doc","id":"api/beta/approve-approval-item","label":"Approve an Approval Item","className":"api-method post"},{"type":"doc","id":"api/beta/reject-approval-item","label":"Reject an Approval Item","className":"api-method post"},{"type":"doc","id":"api/beta/approve-approval-items-in-bulk","label":"Bulk approve Approval Items","className":"api-method post"},{"type":"doc","id":"api/beta/reject-approval-items-in-bulk","label":"Bulk reject Approval Items","className":"api-method post"},{"type":"doc","id":"api/beta/submit-account-selection","label":"Submit Account Selections","className":"api-method post"}]},{"type":"category","label":"Work Reassignment","link":{"type":"doc","id":"api/beta/work-reassignment"},"items":[{"type":"doc","id":"api/beta/get-reassignment-config-types","label":"List Reassignment Config Types","className":"api-method get"},{"type":"doc","id":"api/beta/list-reassignment-configurations","label":"List Reassignment Configurations","className":"api-method get"},{"type":"doc","id":"api/beta/create-reassignment-configuration","label":"Create a Reassignment Configuration","className":"api-method post"},{"type":"doc","id":"api/beta/get-reassignment-configuration","label":"Get Reassignment Configuration","className":"api-method get"},{"type":"doc","id":"api/beta/put-reassignment-config","label":"Update Reassignment Configuration","className":"api-method put"},{"type":"doc","id":"api/beta/delete-reassignment-configuration","label":"Delete Reassignment Configuration","className":"api-method delete"},{"type":"doc","id":"api/beta/get-evaluate-reassignment-configuration","label":"Evaluate Reassignment Configuration","className":"api-method get"},{"type":"doc","id":"api/beta/get-tenant-config-configuration","label":"Get Tenant-wide Reassignment Configuration settings","className":"api-method get"},{"type":"doc","id":"api/beta/put-tenant-configuration","label":"Update Tenant-wide Reassignment Configuration settings","className":"api-method put"}]},{"type":"category","label":"Workflows","link":{"type":"doc","id":"api/beta/workflows"},"items":[{"type":"doc","id":"api/beta/create-workflow","label":"Create Workflow","className":"api-method post"},{"type":"doc","id":"api/beta/list-workflows","label":"List Workflows","className":"api-method get"},{"type":"doc","id":"api/beta/get-workflow","label":"Get Workflow By Id","className":"api-method get"},{"type":"doc","id":"api/beta/update-workflow","label":"Update Workflow","className":"api-method put"},{"type":"doc","id":"api/beta/patch-workflow","label":"Patch Workflow","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-workflow","label":"Delete Workflow By Id","className":"api-method delete"},{"type":"doc","id":"api/beta/test-workflow","label":"Test Workflow By Id","className":"api-method post"},{"type":"doc","id":"api/beta/list-workflow-executions","label":"List Workflow Executions","className":"api-method get"},{"type":"doc","id":"api/beta/get-workflow-execution","label":"Get a Workflow Execution","className":"api-method get"},{"type":"doc","id":"api/beta/get-workflow-execution-history","label":"Get Workflow Execution History","className":"api-method get"},{"type":"doc","id":"api/beta/cancel-workflow-execution","label":"Cancel Workflow Execution by ID","className":"api-method post"},{"type":"doc","id":"api/beta/list-complete-workflow-library","label":"List Complete Workflow Library","className":"api-method get"},{"type":"doc","id":"api/beta/list-workflow-library-actions","label":"List Workflow Library Actions","className":"api-method get"},{"type":"doc","id":"api/beta/list-workflow-library-triggers","label":"List Workflow Library Triggers","className":"api-method get"},{"type":"doc","id":"api/beta/list-workflow-library-operators","label":"List Workflow Library Operators","className":"api-method get"},{"type":"doc","id":"api/beta/post-workflow-external-trigger","label":"Generate External Trigger OAuth Client","className":"api-method post"},{"type":"doc","id":"api/beta/post-external-execute-workflow","label":"Execute Workflow via External Trigger","className":"api-method post"},{"type":"doc","id":"api/beta/test-external-execute-workflow","label":"Test Workflow via External Trigger","className":"api-method post"}]},{"type":"category","label":"Auth Profile","items":[{"type":"doc","id":"api/beta/get-profile-config-list","label":"Get list of Auth Profiles.","className":"api-method get"},{"type":"doc","id":"api/beta/get-profile-config","label":"Get Auth Profile.","className":"api-method get"},{"type":"doc","id":"api/beta/create-profile-config","label":"Create Auth Profile.","className":"api-method post"},{"type":"doc","id":"api/beta/patch-profile-config","label":"Patch a specified Auth Profile","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-profile-config","label":"Delete the specified Auth Profile","className":"api-method delete"}]}]; \ No newline at end of file diff --git a/docs/api/beta/start-campaign-remediation-scan.api.mdx b/docs/api/beta/start-campaign-remediation-scan.api.mdx index fcf5d735a..e54bf61dc 100644 --- a/docs/api/beta/start-campaign-remediation-scan.api.mdx +++ b/docs/api/beta/start-campaign-remediation-scan.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Run Campaign Remediation Scan

    @@ -37,7 +35,7 @@ Requires roles of CERT_ADMIN and ORG_ADMIN ## Request -

    Path Parameters

    +

    Path Parameters

    Accepted - Returned if the request was successfully accepted into the system. @@ -73,7 +71,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -85,7 +83,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -101,4 +99,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/start-campaign-report.api.mdx b/docs/api/beta/start-campaign-report.api.mdx index 20ea175f8..c36854c88 100644 --- a/docs/api/beta/start-campaign-report.api.mdx +++ b/docs/api/beta/start-campaign-report.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Run Campaign Report

    @@ -37,7 +35,7 @@ Requires the following roles: CERT_ADMIN, DASHBOARD, ORG_ADMIN and REPORT_ADMIN. ## Request -

    Path Parameters

    +

    Path Parameters

    Accepted - Returned if the request was successfully accepted into the system. @@ -73,7 +71,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -85,7 +83,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -101,4 +99,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/start-campaign.api.mdx b/docs/api/beta/start-campaign.api.mdx index 9d91c721f..0055ed6cf 100644 --- a/docs/api/beta/start-campaign.api.mdx +++ b/docs/api/beta/start-campaign.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Activate a Campaign

    @@ -41,7 +39,7 @@ Requires roles of CERT_ADMIN and ORG_ADMIN Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. -
    +
    Accepted - Returned if the request was successfully accepted into the system. @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -89,7 +87,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -105,4 +103,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/start-generate-campaign-template.api.mdx b/docs/api/beta/start-generate-campaign-template.api.mdx index 014b475b0..03942f392 100644 --- a/docs/api/beta/start-generate-campaign-template.api.mdx +++ b/docs/api/beta/start-generate-campaign-template.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Generate a Campaign from Template

    @@ -40,7 +38,7 @@ Requires roles ORG_ADMIN. ## Request -

    Path Parameters

    +

    Path Parameters

    Indicates a campaign was successfully generated from this template, and returns a reference to the new campaign. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -88,4 +86,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/start-identity-processing.api.mdx b/docs/api/beta/start-identity-processing.api.mdx index d8b25c3f5..231095661 100644 --- a/docs/api/beta/start-identity-processing.api.mdx +++ b/docs/api/beta/start-identity-processing.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Process a list of identityIds

    @@ -42,7 +40,7 @@ A token with ORG_ADMIN or HELPDESK authority is required to call this API. ## Request -

    Body

    required
      = 1`, `<= 250`"} schema={{"type":"array","minItems":1,"maxItems":250,"description":"List of up to 250 identity IDs to process.","items":{"type":"string","example":"ef38f94347e94562b5bb8424a56397d8"}}}>
    +

    Body

    required
      = 1`, `<= 250`"} schema={{"type":"array","minItems":1,"maxItems":250,"description":"List of up to 250 identity IDs to process.","items":{"type":"string","example":"ef38f94347e94562b5bb8424a56397d8"}}}>
    Object containing the DTO type TASK_RESULT and the job id for the task @@ -74,7 +72,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -86,7 +84,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -102,4 +100,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/start-predict-sod-violations.api.mdx b/docs/api/beta/start-predict-sod-violations.api.mdx index 7ed173ee9..407d6dfaf 100644 --- a/docs/api/beta/start-predict-sod-violations.api.mdx +++ b/docs/api/beta/start-predict-sod-violations.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Predict SOD violations for identity.

    @@ -42,7 +40,7 @@ A token with ORG_ADMIN or API authority is required to call this API. The list of entitlements to consider for possible violations in a preventive check. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Violation Contexts @@ -90,7 +88,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -102,7 +100,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -118,4 +116,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/start-sod-all-policies-for-org.api.mdx b/docs/api/beta/start-sod-all-policies-for-org.api.mdx index 829cd5cda..db647d918 100644 --- a/docs/api/beta/start-sod-all-policies-for-org.api.mdx +++ b/docs/api/beta/start-sod-all-policies-for-org.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Runs all policies for org

    @@ -37,7 +35,7 @@ Requires role of ORG_ADMIN. ## Request -

    Body

    +

    Body

    Reference to the violation report run task. @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -85,4 +83,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/start-sod-policy.api.mdx b/docs/api/beta/start-sod-policy.api.mdx index ff69e86a7..0cb3ef2ff 100644 --- a/docs/api/beta/start-sod-policy.api.mdx +++ b/docs/api/beta/start-sod-policy.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Runs SOD policy violation report

    @@ -37,7 +35,7 @@ Requires role of ORG_ADMIN. ## Request -

    Path Parameters

    +

    Path Parameters

    Reference to the violation report run task. @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -81,7 +79,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -97,4 +95,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/start-test-trigger-invocation.api.mdx b/docs/api/beta/start-test-trigger-invocation.api.mdx index fbc194baa..f374fa5a5 100644 --- a/docs/api/beta/start-test-trigger-invocation.api.mdx +++ b/docs/api/beta/start-test-trigger-invocation.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Start a Test Invocation

    @@ -32,7 +30,7 @@ Initiate a test event for all subscribers of the specified event trigger. If th ## Request -

    Body

    required
    +

    Body

    required
    Test trigger invocations that have been started for specified subscription(s). @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/submit-account-selection.api.mdx b/docs/api/beta/submit-account-selection.api.mdx index 25d924366..6c63676a7 100644 --- a/docs/api/beta/submit-account-selection.api.mdx +++ b/docs/api/beta/submit-account-selection.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Submit Account Selections

    @@ -36,7 +34,7 @@ This API submits account selections. Either an admin, or the owning/current user Account Selection Data map, keyed on fieldName -
    +
    A work items details object. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,4 +74,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 404 response object

     \ No newline at end of file diff --git a/docs/api/beta/submit-reassign-certs-async.api.mdx b/docs/api/beta/submit-reassign-certs-async.api.mdx index 86ef42077..7368da0e8 100644 --- a/docs/api/beta/submit-reassign-certs-async.api.mdx +++ b/docs/api/beta/submit-reassign-certs-async.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Reassign Certifications Asynchronously

    @@ -36,7 +34,7 @@ This API initiates a task to reassign up to 500 identities or items in an identi ## Request -

    Path Parameters

    Body

    required
      reassign object[]required
    • Array [
    • ]
    +

    Path Parameters

    Body

    required
      reassign object[]required
    • Array [
    • ]
    A certification task object for the reassignment which can be queried for status. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/sync-attributes-for-source.api.mdx b/docs/api/beta/sync-attributes-for-source.api.mdx index cd2991dc0..eb5407c20 100644 --- a/docs/api/beta/sync-attributes-for-source.api.mdx +++ b/docs/api/beta/sync-attributes-for-source.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Synchronize single source attributes.

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    A Source Sync job @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -81,7 +79,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -97,4 +95,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/sync-identity-profile.api.mdx b/docs/api/beta/sync-identity-profile.api.mdx index fd46f8114..8c591ebda 100644 --- a/docs/api/beta/sync-identity-profile.api.mdx +++ b/docs/api/beta/sync-identity-profile.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Process identities under profile

    @@ -34,7 +32,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    Accepted - Returned if the request was successfully accepted into the system. @@ -70,7 +68,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -82,7 +80,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -98,4 +96,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/synchronize-attributes-for-identity.api.mdx b/docs/api/beta/synchronize-attributes-for-identity.api.mdx index 46f841c78..b9fc6715b 100644 --- a/docs/api/beta/synchronize-attributes-for-identity.api.mdx +++ b/docs/api/beta/synchronize-attributes-for-identity.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Attribute synchronization for single identity.

    @@ -32,7 +30,7 @@ This end-point performs attribute synchronization for a selected identity. The e ## Request -

    Path Parameters

    +

    Path Parameters

    An Identity Sync job @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/test-external-execute-workflow.api.mdx b/docs/api/beta/test-external-execute-workflow.api.mdx index 0507e4ae8..f157b6d52 100644 --- a/docs/api/beta/test-external-execute-workflow.api.mdx +++ b/docs/api/beta/test-external-execute-workflow.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Test Workflow via External Trigger

    @@ -32,7 +30,7 @@ Validate a workflow with an "External Trigger" can receive input. The response ## Request -

    Path Parameters

    Body

    +

    Path Parameters

    Body

    Responds with the test input @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/test-mfa-config.api.mdx b/docs/api/beta/test-mfa-config.api.mdx index 6b378bf75..c79d61a88 100644 --- a/docs/api/beta/test-mfa-config.api.mdx +++ b/docs/api/beta/test-mfa-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    MFA method's test configuration

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    The result of configuration test for the MFA provider. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -81,4 +79,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/test-source-configuration.api.mdx b/docs/api/beta/test-source-configuration.api.mdx index cbf7efffe..f24ba8f54 100644 --- a/docs/api/beta/test-source-configuration.api.mdx +++ b/docs/api/beta/test-source-configuration.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Test configuration for source connector

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    The result of testing source connector configuration with response from it. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/test-source-connection.api.mdx b/docs/api/beta/test-source-connection.api.mdx index a854dff87..e6089715f 100644 --- a/docs/api/beta/test-source-connection.api.mdx +++ b/docs/api/beta/test-source-connection.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Check connection for source connector.

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    The result of checking connection to the source connector with response from it. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/test-subscription-filter.api.mdx b/docs/api/beta/test-subscription-filter.api.mdx index ad469f9fc..99d276199 100644 --- a/docs/api/beta/test-subscription-filter.api.mdx +++ b/docs/api/beta/test-subscription-filter.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Validate a Subscription Filter

    @@ -33,7 +31,7 @@ Request requires a security scope of: ## Request -

    Body

    required
    +

    Body

    required
    Boolean whether specified filter expression is valid against the input. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -81,4 +79,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/test-workflow.api.mdx b/docs/api/beta/test-workflow.api.mdx index 153845982..83c2e7f5b 100644 --- a/docs/api/beta/test-workflow.api.mdx +++ b/docs/api/beta/test-workflow.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Test Workflow By Id

    @@ -34,7 +32,7 @@ This endpoint will return an execution ID, which can be used to lookup more info ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    The Workflow object @@ -66,7 +64,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -82,4 +80,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/un-ignore-identity-outliers.api.mdx b/docs/api/beta/un-ignore-identity-outliers.api.mdx index 4a942cfec..94d074355 100644 --- a/docs/api/beta/un-ignore-identity-outliers.api.mdx +++ b/docs/api/beta/un-ignore-identity-outliers.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    IAI Identity Outliers Unignore

    @@ -37,7 +35,7 @@ Requires authorization scope of 'iai:outliers-management:update' string -
  • ]
    • +
  • ]
    • No content - indicates the request was successful but there is no content to be returned in the response. @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -85,4 +83,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/unlock-account.api.mdx b/docs/api/beta/unlock-account.api.mdx index 72c04c4e7..18ec21ba7 100644 --- a/docs/api/beta/unlock-account.api.mdx +++ b/docs/api/beta/unlock-account.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Unlock Account

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    Async task details @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/update-access-profiles-in-bulk.api.mdx b/docs/api/beta/update-access-profiles-in-bulk.api.mdx index dd0cfe30a..cdd16a33f 100644 --- a/docs/api/beta/update-access-profiles-in-bulk.api.mdx +++ b/docs/api/beta/update-access-profiles-in-bulk.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Access Profile(s) requestable field.

    @@ -38,7 +36,7 @@ This API initiates a bulk update of field requestable for one or more Access Pro ## Request -

    Body

    arrayrequired
    • Array [
    • ]
    +

    Body

    arrayrequired
    • Array [
    • ]
    List of updated and not updated Access Profiles. @@ -70,7 +68,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Precondition Failed - Returned in response if API/Feature not enabled for an organization. @@ -90,4 +88,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/update-account.api.mdx b/docs/api/beta/update-account.api.mdx index 1a64c0f67..ebf6a48d3 100644 --- a/docs/api/beta/update-account.api.mdx +++ b/docs/api/beta/update-account.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Account

    @@ -42,7 +40,7 @@ A list of account update operations according to the [JSON Patch](https://tools. object -
  • ]
    • +
  • ]
    • Accepted - Returned if the request was successfully accepted into the system. @@ -78,7 +76,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -90,7 +88,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -106,4 +104,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/update-campaign.api.mdx b/docs/api/beta/update-campaign.api.mdx index c16d5cde8..a56012f10 100644 --- a/docs/api/beta/update-campaign.api.mdx +++ b/docs/api/beta/update-campaign.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update a Campaign

    @@ -57,7 +55,7 @@ In the *ACTIVE* status, the following fields can be patched: object -
  • ]
    • +
  • ]
    • Indicates the PATCH operation succeeded, and returns the campaign's new representation. @@ -93,7 +91,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -105,7 +103,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -121,4 +119,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/update-common-access-status-in-bulk.api.mdx b/docs/api/beta/update-common-access-status-in-bulk.api.mdx index a8021f16d..27d1273e3 100644 --- a/docs/api/beta/update-common-access-status-in-bulk.api.mdx +++ b/docs/api/beta/update-common-access-status-in-bulk.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Bulk update common access status

    @@ -36,7 +34,7 @@ This submits an update request to the common access application. At this time th Confirm or deny in bulk the common access ids that are (or aren't) common access -
    +
    • Array [
    • ]
    Accepted - Returned if the request was successfully accepted into the system. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -88,4 +86,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/update-connector-rule.api.mdx b/docs/api/beta/update-connector-rule.api.mdx index 25064c013..50c561fbb 100644 --- a/docs/api/beta/update-connector-rule.api.mdx +++ b/docs/api/beta/update-connector-rule.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update a Connector Rule

    @@ -45,7 +43,7 @@ The rule's function signature. Describes the rule's input arguments and output ( SourceCode -
    +
    The updated connector rule @@ -85,7 +83,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -97,7 +95,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -113,4 +111,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/update-entitlements-in-bulk.api.mdx b/docs/api/beta/update-entitlements-in-bulk.api.mdx index 8dcf6b00c..647f7ae04 100644 --- a/docs/api/beta/update-entitlements-in-bulk.api.mdx +++ b/docs/api/beta/update-entitlements-in-bulk.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Bulk update an entitlement list

    @@ -58,7 +56,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • No content - indicates the request was successful but there is no content to be returned in the response. @@ -90,7 +88,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -106,4 +104,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/update-entitlements-potential-role.api.mdx b/docs/api/beta/update-entitlements-potential-role.api.mdx index fa9b8d8b7..b04ae8cd9 100644 --- a/docs/api/beta/update-entitlements-potential-role.api.mdx +++ b/docs/api/beta/update-entitlements-potential-role.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Edit entitlements for a potential role to exclude some entitlements

    @@ -36,7 +34,7 @@ This endpoint adds or removes entitlements from an exclusion list for a potentia Role mining session parameters -
    +
    Adds or removes entitlements from a potential role's entitlement exclusion list. @@ -84,7 +82,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/update-identity-profile.api.mdx b/docs/api/beta/update-identity-profile.api.mdx index 7739a87e5..48860d2df 100644 --- a/docs/api/beta/update-identity-profile.api.mdx +++ b/docs/api/beta/update-identity-profile.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update the Identity Profile

    @@ -61,7 +59,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • The updated Identity Profile. @@ -109,7 +107,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -121,7 +119,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -137,4 +135,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/update-lifecycle-states.api.mdx b/docs/api/beta/update-lifecycle-states.api.mdx index 9c8896d98..e47f5cf37 100644 --- a/docs/api/beta/update-lifecycle-states.api.mdx +++ b/docs/api/beta/update-lifecycle-states.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Lifecycle State

    @@ -67,7 +65,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • Updated lifecycle-state. @@ -99,7 +97,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -115,4 +113,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/update-managed-client-status.api.mdx b/docs/api/beta/update-managed-client-status.api.mdx index 05e1a5cd1..96c527408 100644 --- a/docs/api/beta/update-managed-client-status.api.mdx +++ b/docs/api/beta/update-managed-client-status.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Handle status request from client

    @@ -32,7 +30,7 @@ Update a status detail passed in from the client ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    Responds with the updated Managed Client Status. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/update-non-employee-record.api.mdx b/docs/api/beta/update-non-employee-record.api.mdx index 97e5862a4..a8e0ecd0d 100644 --- a/docs/api/beta/update-non-employee-record.api.mdx +++ b/docs/api/beta/update-non-employee-record.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Non-Employee Record

    @@ -40,7 +38,7 @@ Non-employee record creation request body. Attributes are restricted by user typ Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported. -
    +
    An updated non-employee record. @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -88,7 +86,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -104,4 +102,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/update-password-sync-group.api.mdx b/docs/api/beta/update-password-sync-group.api.mdx index eb9d2217b..e7a033fb0 100644 --- a/docs/api/beta/update-password-sync-group.api.mdx +++ b/docs/api/beta/update-password-sync-group.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Password Sync Group by ID

    @@ -32,7 +30,7 @@ This API updates the specified password sync group. A token with ORG_ADMIN autho ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    Reference to the password sync group. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/update-provisioning-policies-in-bulk.api.mdx b/docs/api/beta/update-provisioning-policies-in-bulk.api.mdx index 76132cfd3..cced93e40 100644 --- a/docs/api/beta/update-provisioning-policies-in-bulk.api.mdx +++ b/docs/api/beta/update-provisioning-policies-in-bulk.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Bulk Update Provisioning Policies

    @@ -33,7 +31,7 @@ A token with API, or ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    Body

    arrayrequired
    • Array [
      • fields object[]
    • Array [
    • ]
    • ]
    +

    Path Parameters

    Body

    arrayrequired
    • Array [
      • fields object[]
    • Array [
    • ]
    • ]
    A list of the ProvisioningPolicyDto was successfully replaced. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/update-provisioning-policy.api.mdx b/docs/api/beta/update-provisioning-policy.api.mdx index a0d794a41..71a03a368 100644 --- a/docs/api/beta/update-provisioning-policy.api.mdx +++ b/docs/api/beta/update-provisioning-policy.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Partial update of Provisioning Policy

    @@ -59,7 +57,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • The ProvisioningPolicyDto was successfully updated. @@ -91,7 +89,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -103,7 +101,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -119,4 +117,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/update-public-identity-config.api.mdx b/docs/api/beta/update-public-identity-config.api.mdx index 5bbf6b2fa..3aa868748 100644 --- a/docs/api/beta/update-public-identity-config.api.mdx +++ b/docs/api/beta/update-public-identity-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Public Identity Config

    @@ -36,7 +34,7 @@ This updates the details of public identity config. The manager for the identity. -
    +
    Request succeeded. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -88,4 +86,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/update-recommendations-config.api.mdx b/docs/api/beta/update-recommendations-config.api.mdx index 5bfd51c20..ac7a4f266 100644 --- a/docs/api/beta/update-recommendations-config.api.mdx +++ b/docs/api/beta/update-recommendations-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update certification recommendation config values

    @@ -32,7 +30,7 @@ Updates configuration attributes used by certification recommendations. ## Request -

    Body

    required
    +

    Body

    required
    Cert recommendation configuration attributes after update @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Internal Server Error - Returned if there is an unexpected error. @@ -76,4 +74,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/update-source-entitlement-request-config.api.mdx b/docs/api/beta/update-source-entitlement-request-config.api.mdx index 081b78727..10088f131 100644 --- a/docs/api/beta/update-source-entitlement-request-config.api.mdx +++ b/docs/api/beta/update-source-entitlement-request-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Source Entitlement Request Configuration

    @@ -46,7 +44,7 @@ Configuration for requesting access to entitlements Ordered list of approval steps for the access request. Empty when no approval is required. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Source Entitlement Request Configuration Details. @@ -86,7 +84,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -102,4 +100,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/update-source-schema.api.mdx b/docs/api/beta/update-source-schema.api.mdx index a42b134c9..3c8cbaa6c 100644 --- a/docs/api/beta/update-source-schema.api.mdx +++ b/docs/api/beta/update-source-schema.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Source Schema (Partial)

    @@ -85,7 +83,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • The Schema was successfully updated. @@ -125,7 +123,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -137,7 +135,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -153,4 +151,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/update-source.api.mdx b/docs/api/beta/update-source.api.mdx index 58ac6d9da..b546f0390 100644 --- a/docs/api/beta/update-source.api.mdx +++ b/docs/api/beta/update-source.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Source (Partial)

    @@ -72,7 +70,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • Updated Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design. @@ -144,7 +142,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -156,7 +154,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -172,4 +170,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/update-status-check-details.api.mdx b/docs/api/beta/update-status-check-details.api.mdx index b985ecee0..4f68c3191 100644 --- a/docs/api/beta/update-status-check-details.api.mdx +++ b/docs/api/beta/update-status-check-details.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update the time check configuration

    @@ -36,7 +34,7 @@ Update the time check configuration of queued SDIM tickets. A token with Org Ad the modified time check configuration -
    +
    QueuedCheckConfigDetails as updated @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/update-subscription.api.mdx b/docs/api/beta/update-subscription.api.mdx index 8004ca71a..22d180e50 100644 --- a/docs/api/beta/update-subscription.api.mdx +++ b/docs/api/beta/update-subscription.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update a Subscription

    @@ -57,7 +55,7 @@ Config required if BEARER_TOKEN authentication is used. On response, this field Config required if EVENTBRIDGE subscription type is used. -
    +
    Updated subscription. @@ -105,7 +103,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -117,7 +115,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -133,4 +131,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/update-task-status.api.mdx b/docs/api/beta/update-task-status.api.mdx index a98ed1afa..6f25891f0 100644 --- a/docs/api/beta/update-task-status.api.mdx +++ b/docs/api/beta/update-task-status.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update task status by ID

    @@ -56,7 +54,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • Responds with the updated TaskStatus for the task with the given task ID. @@ -104,7 +102,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -116,7 +114,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -132,4 +130,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/update-transform.api.mdx b/docs/api/beta/update-transform.api.mdx index 318f30a24..1dafd9b2a 100644 --- a/docs/api/beta/update-transform.api.mdx +++ b/docs/api/beta/update-transform.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update a transform

    @@ -269,7 +267,7 @@ This is an optional attribute that can explicitly define the input data which wi This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. -
    +
    Indicates the transform was successfully updated and returns its new representation. @@ -533,7 +531,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -545,7 +543,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -561,4 +559,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/update-workflow.api.mdx b/docs/api/beta/update-workflow.api.mdx index 6cc777508..54dfa9396 100644 --- a/docs/api/beta/update-workflow.api.mdx +++ b/docs/api/beta/update-workflow.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Workflow

    @@ -52,7 +50,7 @@ The trigger that starts the workflow Workflow Trigger Attributes. -
    oneOf
    +
    oneOf
    The Workflow object @@ -108,7 +106,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -124,4 +122,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/update-workgroup-members.api.mdx b/docs/api/beta/update-workgroup-members.api.mdx index e29228313..d6b149c0e 100644 --- a/docs/api/beta/update-workgroup-members.api.mdx +++ b/docs/api/beta/update-workgroup-members.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Add members to Governance Group

    @@ -40,7 +38,7 @@ This API adds one or more members to a Governance Group. A token with API, ORG_ List of identities to be added to a Governance Group members list. -
    +
    • Array [
    • ]
    List of added and not added identities into Governance Group members list. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -88,4 +86,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/beta/validate-connector-rule.api.mdx b/docs/api/beta/validate-connector-rule.api.mdx index beceab64a..62e581366 100644 --- a/docs/api/beta/validate-connector-rule.api.mdx +++ b/docs/api/beta/validate-connector-rule.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Validate Connector Rule

    @@ -37,7 +35,7 @@ A token with ORG_ADMIN authority is required to call this API. The code to validate -
    +
    The status of the code's eligibility as a connector rule @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -85,4 +83,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/products/idn/api/getting-started.md b/docs/api/getting-started.md similarity index 66% rename from products/idn/api/getting-started.md rename to docs/api/getting-started.md index bbe215b77..49e79258c 100644 --- a/products/idn/api/getting-started.md +++ b/docs/api/getting-started.md @@ -6,14 +6,14 @@ sidebar_label: Getting Started sidebar_position: 1 sidebar_class_name: gettingStarted keywords: ['getting started'] -description: This is this place to get started with IdentityNow APIs. +description: Start using the ISC APIs. slug: /api/getting-started tags: ['Getting Started'] --- ## Overview -This guide is intended to help you quickly make your first API call to SailPoint IdentityNow and assumes an intermediate level of understanding of APIs. For beginners to APIs, we recommend you watch this presentation that covers the fundamentals of APIs with visual demonstrations of how to make an API call in SailPoint. +This guide is intended to help you quickly make your first API call to SailPoint Identity Security Cloud and assumes an intermediate level of understanding of APIs. For beginners to APIs, we recommend you watch this presentation that covers the fundamentals of APIs with visual demonstrations of how to make an API call in SailPoint.
    @@ -21,13 +21,13 @@ This guide is intended to help you quickly make your first API call to SailPoint ## Find Your Tenant Name -To form the proper URL for an API request, you must know your tenant name. To find your tenant name, log into IdentityNow, navigate to Admin, select the Dashboard dropdown, and select Overview. The org name is displayed within the Org Details section of the dashboard. If you do not have admin access, you can still find your tenant name and the API base URL you will use for API calls. To do so, view your session details when you are logged into your IdentityNow instance. Change your URL to the following: `https://{your-IdentityNow-hostname}.com/ui/session`, where `{your-IdentityNow-hostname}` is your company's domain name for accessing IdentityNow. The session detail you want is the `baseUrl`, which has the form of `https://{tenant}.api.identitynow.com`. +To form the proper URL for an API request, you must know your tenant name. To find your tenant name, log into Identity Security Cloud, navigate to Admin, select the Dashboard dropdown, and select Overview. The org name is displayed within the Org Details section of the dashboard. If you do not have admin access, you can still find your tenant name and the API base URL you will use for API calls. To do so, view your session details when you are logged into your Identity Security Cloud instance. Change your URL to the following: `https://{your-Identity Security Cloud-hostname}.com/ui/session`, where `{your-Identity Security Cloud-hostname}` is your company's domain name for accessing Identity Security Cloud. The session detail you want is the `baseUrl`, which has the form of `https://{tenant}.api.identitynow.com`. ## Make Your First API Call -To get started, create a [personal access token](./authentication.md#personal-access-tokens), which can then be used to generate access tokens to authenticate your API calls. To generate a personal access token from IdentityNow, after logging into your IdentityNow instance, do the following: +To get started, create a [personal access token](./authentication.md#personal-access-tokens), which can then be used to generate access tokens to authenticate your API calls. To generate a personal access token from Identity Security Cloud, after logging into your Identity Security Cloud instance, do the following: -1. Select **Preferences** from the drop-down menu under your username. Then select **Personal Access Tokens** on the left. You can also go straight to the page using this URL, replacing `{tenant}` with your IdentityNow tenant: `https://{tenant}.identitynow.com/ui/d/user-preferences/personal-access-tokens`. +1. Select **Preferences** from the drop-down menu under your username. Then select **Personal Access Tokens** on the left. You can also go straight to the page using this URL, replacing `{tenant}` with your Identity Security Cloud tenant: `https://{tenant}.identitynow.com/ui/d/user-preferences/personal-access-tokens`. 2. Select **New Token** and enter a meaningful description to differentiate the token from others. @@ -47,13 +47,13 @@ The **New Token** button will be disabled when you reach the limit of 10 persona 4. Copy both values somewhere that will be secure and accessible to you when you need to use the the token. -5. To create an `access_token` that can be used to authenticate API requests, use the following cURL command, replacing `{tenant}` with your IdentityNow tenant. The response body will contain an `access_token`, which will look like a long string of random characters. +5. To create an `access_token` that can be used to authenticate API requests, use the following cURL command, replacing `{tenant}` with your Identity Security Cloud tenant. The response body will contain an `access_token`, which will look like a long string of random characters. ```bash curl --location --request POST 'https://{tenant}.api.identitynow.com/oauth/token?grant_type=client_credentials&client_id={client_id}&client_secret={secret}' ``` -6. To test your `access_token`, execute the following cURL command, replacing `{tenant}` with your IdentityNow tenant and `access_token` with the token you generated in the previous step. If this is successful, you should get a JSON representation of an identity in your tenant. +6. To test your `access_token`, execute the following cURL command, replacing `{tenant}` with your Identity Security Cloud tenant and `access_token` with the token you generated in the previous step. If this is successful, you should get a JSON representation of an identity in your tenant. ```bash curl --request GET --url 'https://{tenant}.api.identitynow.com/v3/public-identities?limit=1' --header 'authorization: Bearer {access_token}' diff --git a/docs/api/identity-security-cloud.md b/docs/api/identity-security-cloud.md new file mode 100644 index 000000000..b74855807 --- /dev/null +++ b/docs/api/identity-security-cloud.md @@ -0,0 +1,29 @@ +--- +id: identity-security-cloud +title: Identity Security Cloud API Specifications +pagination_label: Identity Security Cloud API Specifications +sidebar_label: Identity Security Cloud API Specifications +sidebar_position: 1 +sidebar_class_name: iscSpecifications +keywords: ['api', 'specifications'] +description: ISC API specifications. +slug: /api +tags: ['API Specifications'] +--- + +## Overview + +The Identity Security Cloud (ISC) APIs provide developers with a way to interact with the ISC platform and extend it. Developers can leverage these APIs to customize their platform experiences and build new solutions and integrations that meet their needs. + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + +## Discuss + +The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions. + +To learn more about the ISC APIs and discuss them with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/tags/c/isc/6/apis). \ No newline at end of file diff --git a/docs/api/iiq/check-policy-violations.api.mdx b/docs/api/iiq/check-policy-violations.api.mdx index 27bd55cab..d8fac0035 100644 --- a/docs/api/iiq/check-policy-violations.api.mdx +++ b/docs/api/iiq/check-policy-violations.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    This endpoint simulates provisioning a set of access items, and then checks against a set of policies to determine if granting the access items would cause creation of new policy violations.

    @@ -53,7 +51,7 @@ import TabItem from "@theme/TabItem"; A provisioning plan detailing the access to request on the simulation -
    value object
    accounts object[]
  • Array [
    • attributes object[]
  • Array [
  • ]
  • ]
    • +
    value object
    accounts object[]
  • Array [
    • attributes object[]
  • Array [
  • ]
  • ]
    • Returns a list of violations based on simulated requested access diff --git a/docs/api/iiq/create-account.api.mdx b/docs/api/iiq/create-account.api.mdx index 5ed9974ce..58463ac08 100644 --- a/docs/api/iiq/create-account.api.mdx +++ b/docs/api/iiq/create-account.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Creates an Account.

    @@ -56,7 +54,7 @@ The corresponding Application object of the Account. Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.

    Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { "department": "IT"} -

    Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { \"department\": \"IT\"}","type":"object","additionalProperties":true}} collapsible={false} discriminator={false}>
    +

    Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { \"department\": \"IT\"}","type":"object","additionalProperties":true}} collapsible={false} discriminator={false}>
    Creates an Account and returns the resultant Account. @@ -76,4 +74,4 @@ Provide the name of Application that corresponds to this Account in APPLICATION Metadata of the SCIM resource. -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/api/iiq/create-alert.api.mdx b/docs/api/iiq/create-alert.api.mdx index 26b2c8bb0..9abe4f903 100644 --- a/docs/api/iiq/create-alert.api.mdx +++ b/docs/api/iiq/create-alert.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Creates a new Alert.

    @@ -40,7 +38,7 @@ A list of attributes of the Alert. The corresponding Application object of the Alert. -
    +
    Creates an Alert and returns the resultant Alert. diff --git a/docs/api/iiq/create-user.api.mdx b/docs/api/iiq/create-user.api.mdx index 8e9c493fc..494b09c18 100644 --- a/docs/api/iiq/create-user.api.mdx +++ b/docs/api/iiq/create-user.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Creates a User.

    @@ -88,7 +86,7 @@ Enterprise User Schema. Contains the manager of the User. Manager of the user. -
    +
    Creates a User and returns the resultant User. @@ -140,7 +138,7 @@ Manager of the User. Metadata of the resource. -
    +
    Returned if userName is not unique. diff --git a/docs/api/iiq/delete-account.api.mdx b/docs/api/iiq/delete-account.api.mdx index bcb9bddd8..62c33a183 100644 --- a/docs/api/iiq/delete-account.api.mdx +++ b/docs/api/iiq/delete-account.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Deletes an existing Account.

    @@ -32,7 +30,7 @@ The endpoint used to delete an Account resource. **This is not reversible.** ## Request -

    Path Parameters

    +

    Path Parameters

    Returns a 204 with no response body if delete was successful. diff --git a/docs/api/iiq/delete-user.api.mdx b/docs/api/iiq/delete-user.api.mdx index 5a91f862c..91c70087d 100644 --- a/docs/api/iiq/delete-user.api.mdx +++ b/docs/api/iiq/delete-user.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Deletes an existing User.

    @@ -32,7 +30,7 @@ The endpoint used to delete a User resource. **This is not reversible.** ## Request -

    Path Parameters

    Query Parameters


      **Example**: scim/v2/Users/**Mock.User**?**lookupByName=true**"}}>
    +

    Path Parameters

    Query Parameters


      **Example**: scim/v2/Users/**Mock.User**?**lookupByName=true**"}}>
    Returns a 204 with no response body if delete was successful. diff --git a/docs/api/iiq/get-account-by-id.api.mdx b/docs/api/iiq/get-account-by-id.api.mdx index d151045e1..17b814e89 100644 --- a/docs/api/iiq/get-account-by-id.api.mdx +++ b/docs/api/iiq/get-account-by-id.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns an Account resource based on id.

    @@ -32,7 +30,7 @@ The Account resource with matching id is returned. ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Returns a single Account resource based on the id. @@ -52,7 +50,7 @@ Provide the name of Application that corresponds to this Account in APPLICATION Metadata of the SCIM resource. -
    Schema
      identity
      +
    Schema
      identity
      The corresponding User object of the Account. @@ -68,4 +66,4 @@ Provide the name of Application that corresponds to this Account in APPLICATION Metadata of the SCIM resource. -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/api/iiq/get-accounts.api.mdx b/docs/api/iiq/get-accounts.api.mdx index a91844331..286b63414 100644 --- a/docs/api/iiq/get-accounts.api.mdx +++ b/docs/api/iiq/get-accounts.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns all Account resources.

    @@ -32,7 +30,7 @@ This endpoint returns all Account resources. ## Request -

    Query Parameters

    +

    Query Parameters

    Returns all Account resources. @@ -52,7 +50,7 @@ Provide the name of Application that corresponds to this Account in APPLICATION Metadata of the SCIM resource. -
  • ]
    • Schema
      Resources undefined[]
      +
    • ]
    Schema
      Resources undefined[]
      The SCIM resources returned for this endpoint. @@ -72,4 +70,4 @@ Provide the name of Application that corresponds to this Account in APPLICATION Metadata of the SCIM resource. -
    • ]
    \ No newline at end of file +
  • ]
    • \ No newline at end of file diff --git a/docs/api/iiq/get-alert-by-id.api.mdx b/docs/api/iiq/get-alert-by-id.api.mdx index f534aafcf..89cd86c16 100644 --- a/docs/api/iiq/get-alert-by-id.api.mdx +++ b/docs/api/iiq/get-alert-by-id.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns an Alert resource based on id.

    @@ -35,7 +33,7 @@ import TabItem from "@theme/TabItem"; ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Returns a single Alert resource based on the id. diff --git a/docs/api/iiq/get-alerts.api.mdx b/docs/api/iiq/get-alerts.api.mdx index 162c0eb10..398b6638f 100644 --- a/docs/api/iiq/get-alerts.api.mdx +++ b/docs/api/iiq/get-alerts.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns all Alert resources.

    @@ -38,7 +36,7 @@ The schemas related to Alerts are: ## Request -

    Query Parameters

    +

    Query Parameters

    Returned all SCIM resources for this endpoint. diff --git a/docs/api/iiq/get-application.api.mdx b/docs/api/iiq/get-application.api.mdx index 602f5ce3a..d15131eaf 100644 --- a/docs/api/iiq/get-application.api.mdx +++ b/docs/api/iiq/get-application.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns an Application resource based on id or name.

    @@ -36,7 +34,7 @@ The schema related to Application is: ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Returns a single Application resource based on the id. diff --git a/docs/api/iiq/get-applications.api.mdx b/docs/api/iiq/get-applications.api.mdx index 13ebb101a..edcd60193 100644 --- a/docs/api/iiq/get-applications.api.mdx +++ b/docs/api/iiq/get-applications.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns all Application resources.

    @@ -37,7 +35,7 @@ The schema related to Applications is: ## Request -

    Query Parameters

    +

    Query Parameters

    Returns all SCIM Application resources. diff --git a/docs/api/iiq/get-entitlement-by-id.api.mdx b/docs/api/iiq/get-entitlement-by-id.api.mdx index a8410948d..a3c0657fd 100644 --- a/docs/api/iiq/get-entitlement-by-id.api.mdx +++ b/docs/api/iiq/get-entitlement-by-id.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns an Entitlement resource based on id.

    @@ -35,7 +33,7 @@ Attributes to exclude from the response can be specified with the excludedAttrib ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Returns a single Entitlement resource based on the id. diff --git a/docs/api/iiq/get-entitlements.api.mdx b/docs/api/iiq/get-entitlements.api.mdx index e6402d594..7cbbba48a 100644 --- a/docs/api/iiq/get-entitlements.api.mdx +++ b/docs/api/iiq/get-entitlements.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns all Entitlement resources.

    @@ -37,7 +35,7 @@ The schemas related to Entitlements are: ## Request -

    Query Parameters

    +

    Query Parameters

    Returned all SCIM resources for this endpoint. diff --git a/docs/api/iiq/get-launched-workflow-by-id.api.mdx b/docs/api/iiq/get-launched-workflow-by-id.api.mdx index ff132a08d..15985fe95 100644 --- a/docs/api/iiq/get-launched-workflow-by-id.api.mdx +++ b/docs/api/iiq/get-launched-workflow-by-id.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns a LaunchedWorkflow resource based on id.

    @@ -38,7 +36,7 @@ The schema related to LaunchedWorkflow is: ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Returns a single LaunchedWorkflow resource based on the id.
    **LaunchedWorkflow responses include attributes from the TaskResult related to the Workflow execution.** diff --git a/docs/api/iiq/get-object-config-by-id.api.mdx b/docs/api/iiq/get-object-config-by-id.api.mdx index 1ed9825b7..834b6a309 100644 --- a/docs/api/iiq/get-object-config-by-id.api.mdx +++ b/docs/api/iiq/get-object-config-by-id.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns an ObjectConfig resource based on its name or id.

    @@ -40,7 +38,7 @@ The schema related to ObjectConfig is: ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Returns a single ObjectConfig resource based on its name or id. diff --git a/docs/api/iiq/get-object-configs.api.mdx b/docs/api/iiq/get-object-configs.api.mdx index cc8ed17b7..579760021 100644 --- a/docs/api/iiq/get-object-configs.api.mdx +++ b/docs/api/iiq/get-object-configs.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns all object of type ObjectConfig.

    @@ -40,7 +38,7 @@ The schema related to ObjectConfig is: ## Request -

    Query Parameters

    +

    Query Parameters

    Returned all SCIM resources for this endpoint. diff --git a/docs/api/iiq/get-policy-violation-by-id.api.mdx b/docs/api/iiq/get-policy-violation-by-id.api.mdx index ee58b9999..6e0f5755a 100644 --- a/docs/api/iiq/get-policy-violation-by-id.api.mdx +++ b/docs/api/iiq/get-policy-violation-by-id.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns a PolicyViolation resource based on id.

    @@ -32,7 +30,7 @@ The PolicyViolation resource with matching id is returned. ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Returns a PolicyViolation resource based on the id. diff --git a/docs/api/iiq/get-policy-violations.api.mdx b/docs/api/iiq/get-policy-violations.api.mdx index 6eeba281c..3eaefc048 100644 --- a/docs/api/iiq/get-policy-violations.api.mdx +++ b/docs/api/iiq/get-policy-violations.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns all PolicyViolation resources.

    @@ -32,7 +30,7 @@ This endpoint returns all PolicyViolation resources. ## Request -

    Query Parameters

    +

    Query Parameters

    Returns all PolicyViolation resources. diff --git a/docs/api/iiq/get-resource-type-by-id.api.mdx b/docs/api/iiq/get-resource-type-by-id.api.mdx index 58d0eb444..286a212f5 100644 --- a/docs/api/iiq/get-resource-type-by-id.api.mdx +++ b/docs/api/iiq/get-resource-type-by-id.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns a ResourceType resource based on ID.

    @@ -32,7 +30,7 @@ The ResourceType with the matching ID is returned. The ID is the URN of the SCIM ## Request -

    Path Parameters

    +

    Path Parameters

    Returns a single ResourceType resource based on the ID. diff --git a/docs/api/iiq/get-resource-types.api.mdx b/docs/api/iiq/get-resource-types.api.mdx index 7777805d1..631adee39 100644 --- a/docs/api/iiq/get-resource-types.api.mdx +++ b/docs/api/iiq/get-resource-types.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns all ResourceType resources.

    @@ -32,7 +30,7 @@ All ResourceType resources are listed in the response. The common fields for eac ## Request -
    +
    Returns all ResourceType resources. diff --git a/docs/api/iiq/get-role.api.mdx b/docs/api/iiq/get-role.api.mdx index 66c70fef3..023f0994f 100644 --- a/docs/api/iiq/get-role.api.mdx +++ b/docs/api/iiq/get-role.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns a Role resource based on ID or name.

    @@ -32,7 +30,7 @@ The Role resource with matching ID or name is returned. Attributes to include in ## Request -

    Path Parameters

    Query Parameters


      **Example**: scim/v2/Roles/**Data Analyst**?**lookupByName=true**"}}>
      **Example**: attributes=name,type

      The attributes listed will be the only ones returned in the response, with the exception of id, schemas, and meta, which are always returned for a Role."}}>
      **Example**: excludedAttributes=permits,requirements

      The attributes listed will be the only ones excluded frome the response, with the exception of id, schemas, and meta, which are always returned for a Role."}}>
    +

    Path Parameters

    Query Parameters


      **Example**: scim/v2/Roles/**Data Analyst**?**lookupByName=true**"}}>
      **Example**: attributes=name,type

      The attributes listed will be the only ones returned in the response, with the exception of id, schemas, and meta, which are always returned for a Role."}}>
      **Example**: excludedAttributes=permits,requirements

      The attributes listed will be the only ones excluded frome the response, with the exception of id, schemas, and meta, which are always returned for a Role."}}>
    Returns a single Role resource based on the ID. diff --git a/docs/api/iiq/get-roles.api.mdx b/docs/api/iiq/get-roles.api.mdx index fdd76e465..a22ca5559 100644 --- a/docs/api/iiq/get-roles.api.mdx +++ b/docs/api/iiq/get-roles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns all Role resources.

    @@ -32,7 +30,7 @@ This endpoint returns all Role resources. Attributes to include in the response ## Request -

    Query Parameters


      **Example**: filter=name eq \"Data Analyst\""}}>
      **Example**: sortBy=\"name\""}}>
      **Example**: sortOrder=\"descending\""}}>
      **Example**: startIndex=1100"}}>
      **Example**: count=10"}}>
      **Example**: attributes=name,type,classifications

      The attributes listed will be the only ones returned in the response, with the exception of id, schemas, and meta, which are always returned for a Role."}}>
      **Example**: excludedAttributes=permits,requirements,inheritance

      The attributes listed will be the only ones excluded frome the response, with the exception of id, schemas, and meta, which are always returned for a Role."}}>
    +

    Query Parameters


      **Example**: filter=name eq \"Data Analyst\""}}>
      **Example**: sortBy=\"name\""}}>
      **Example**: sortOrder=\"descending\""}}>
      **Example**: startIndex=1100"}}>
      **Example**: count=10"}}>
      **Example**: attributes=name,type,classifications

      The attributes listed will be the only ones returned in the response, with the exception of id, schemas, and meta, which are always returned for a Role."}}>
      **Example**: excludedAttributes=permits,requirements,inheritance

      The attributes listed will be the only ones excluded frome the response, with the exception of id, schemas, and meta, which are always returned for a Role."}}>
    Returns all SCIM Role resources. diff --git a/docs/api/iiq/get-schema-by-id.api.mdx b/docs/api/iiq/get-schema-by-id.api.mdx index 17bfdbe49..fe17bdc83 100644 --- a/docs/api/iiq/get-schema-by-id.api.mdx +++ b/docs/api/iiq/get-schema-by-id.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns a Schema based on id.

    @@ -32,7 +30,7 @@ The Schema with the matching id is returned. The id is the URN of the SCIM resou ## Request -

    Path Parameters

    +

    Path Parameters

    Returns a single Schema based on the id. diff --git a/docs/api/iiq/get-schemas.api.mdx b/docs/api/iiq/get-schemas.api.mdx index fd502c685..923d3d000 100644 --- a/docs/api/iiq/get-schemas.api.mdx +++ b/docs/api/iiq/get-schemas.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns all Schema resources.

    @@ -32,7 +30,7 @@ All Schema resources are listed in the response. The 'attributes' field holds th ## Request -
    +
    Returns all Schema resources. diff --git a/docs/api/iiq/get-task-result-by-id.api.mdx b/docs/api/iiq/get-task-result-by-id.api.mdx index f7c9cd3e7..30774d7fb 100644 --- a/docs/api/iiq/get-task-result-by-id.api.mdx +++ b/docs/api/iiq/get-task-result-by-id.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns a TaskResult resource based on id.

    @@ -37,7 +35,7 @@ The schema related to TaskResult is: ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Returns a single TaskResult resource based on the id. diff --git a/docs/api/iiq/get-user-by-id.api.mdx b/docs/api/iiq/get-user-by-id.api.mdx index 2f666357d..dead6ba9a 100644 --- a/docs/api/iiq/get-user-by-id.api.mdx +++ b/docs/api/iiq/get-user-by-id.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns a User resource based on id.

    @@ -32,7 +30,7 @@ The User resource with matching id is returned. There are attributes marked as ' ## Request -

    Path Parameters

    Query Parameters


      **Example**: scim/v2/Users/**Mock.User**?**lookupByName=true**"}}>
    +

    Path Parameters

    Query Parameters


      **Example**: scim/v2/Users/**Mock.User**?**lookupByName=true**"}}>
    Returns a single User resource based on the id. @@ -84,7 +82,7 @@ Manager of the User. Metadata of the resource. -
    Schema
      name
      +
    Schema
      name
      The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined. @@ -132,4 +130,4 @@ Manager of the User. Metadata of the resource. -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/api/iiq/get-users.api.mdx b/docs/api/iiq/get-users.api.mdx index 2db063662..32488e327 100644 --- a/docs/api/iiq/get-users.api.mdx +++ b/docs/api/iiq/get-users.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns all User resources.

    @@ -32,7 +30,7 @@ This endpoint returns all User resources. There are attributes marked as 'return ## Request -

    Query Parameters

    +

    Query Parameters

    Returns all SCIM User resources. @@ -84,7 +82,7 @@ Manager of the User. Metadata of the resource. -
  • ]
    • Schema
      Resources undefined[]
      +
    • ]
    Schema
      Resources undefined[]
      The SCIM resources returned for this endpoint. @@ -136,4 +134,4 @@ Manager of the User. Metadata of the resource. -
    • ]
    \ No newline at end of file +
  • ]
    • \ No newline at end of file diff --git a/docs/api/iiq/get-workflow-by-id.api.mdx b/docs/api/iiq/get-workflow-by-id.api.mdx index ed7c9d0b5..e65d84dd4 100644 --- a/docs/api/iiq/get-workflow-by-id.api.mdx +++ b/docs/api/iiq/get-workflow-by-id.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns a Workflow resource based on id.

    @@ -38,7 +36,7 @@ The schema related to Workflow is:
    ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Returns a single Workflow resource based on the id. diff --git a/docs/api/iiq/launch-workflow.api.mdx b/docs/api/iiq/launch-workflow.api.mdx index 1da1f789a..d39f74e88 100644 --- a/docs/api/iiq/launch-workflow.api.mdx +++ b/docs/api/iiq/launch-workflow.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Endpoint used to launch a Workflow.

    @@ -40,7 +38,7 @@ A list of input attributes of the Launched Workflow. A list of input attributes of the Launched Workflow. -
  • Array [
    • \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n"}}>
  • ]
    • +
  • Array [
    • \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n"}}>
  • ]
    • Executes a workflow and returns the resulting LaunchedWorkflow. **LaunchedWorkflow responses include attributes from the TaskResult related to the Workflow execution.** diff --git a/docs/api/iiq/launched-workflows-get.api.mdx b/docs/api/iiq/launched-workflows-get.api.mdx index 1b15e7018..1fbdb6928 100644 --- a/docs/api/iiq/launched-workflows-get.api.mdx +++ b/docs/api/iiq/launched-workflows-get.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns all LaunchedWorkflow resources.

    @@ -37,7 +35,7 @@ The schema related to LaunchedWorkflow is: ## Request -

    Query Parameters

    +

    Query Parameters

    Returned all SCIM resources for this endpoint.
    **LaunchedWorkflow responses include attributes from the TaskResult related to the Workflow execution.** diff --git a/docs/api/iiq/service-provider-config-get.api.mdx b/docs/api/iiq/service-provider-config-get.api.mdx index 066ee4105..8552eb90a 100644 --- a/docs/api/iiq/service-provider-config-get.api.mdx +++ b/docs/api/iiq/service-provider-config-get.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns all ServiceProviderConfig resources.

    @@ -37,7 +35,7 @@ The schema related to ServiceProviderConfig is:
    ## Request -
    +
    Returned all SCIM resources for this endpoint. diff --git a/docs/api/iiq/task-results-get.api.mdx b/docs/api/iiq/task-results-get.api.mdx index d4bf89197..9710bf102 100644 --- a/docs/api/iiq/task-results-get.api.mdx +++ b/docs/api/iiq/task-results-get.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns all TaskResult resources.

    @@ -37,7 +35,7 @@ The schema related to TaskResult is: ## Request -

    Query Parameters

    +

    Query Parameters

    Returned all SCIM resources for this endpoint. diff --git a/docs/api/iiq/update-account.api.mdx b/docs/api/iiq/update-account.api.mdx index 4fff58720..45cd653dc 100644 --- a/docs/api/iiq/update-account.api.mdx +++ b/docs/api/iiq/update-account.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Updates an existing Account.

    @@ -56,7 +54,7 @@ The corresponding Application object of the Account. Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.

    Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { "department": "IT"} -

    Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { \"department\": \"IT\"}","type":"object","additionalProperties":true}} collapsible={false} discriminator={false}>
    +

    Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { \"department\": \"IT\"}","type":"object","additionalProperties":true}} collapsible={false} discriminator={false}>
    Updates an existing Account and returns that Account. @@ -76,4 +74,4 @@ Provide the name of Application that corresponds to this Account in APPLICATION Metadata of the SCIM resource. -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/api/iiq/update-user.api.mdx b/docs/api/iiq/update-user.api.mdx index d9ad9a23a..a7eb74a2c 100644 --- a/docs/api/iiq/update-user.api.mdx +++ b/docs/api/iiq/update-user.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Updates an existing User.

    @@ -88,7 +86,7 @@ Enterprise User Schema. Contains the manager of the User. Manager of the user. -
    +
    Updates an existing User and returns that User. @@ -140,4 +138,4 @@ Manager of the User. Metadata of the resource. -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/api/iiq/workflows-get.api.mdx b/docs/api/iiq/workflows-get.api.mdx index f2c50398b..174990a1e 100644 --- a/docs/api/iiq/workflows-get.api.mdx +++ b/docs/api/iiq/workflows-get.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns all Workflow resources.

    @@ -37,7 +35,7 @@ The schema related to Workflow is:
    ## Request -

    Query Parameters

    +

    Query Parameters

    Returned all SCIM resources for this endpoint. diff --git a/products/idn/api/img/authentication/oauth-client-credentials-form-data.png b/docs/api/img/authentication/oauth-client-credentials-form-data.png similarity index 100% rename from products/idn/api/img/authentication/oauth-client-credentials-form-data.png rename to docs/api/img/authentication/oauth-client-credentials-form-data.png diff --git a/products/idn/api/img/authorization/authorization-dropdown.png b/docs/api/img/authorization/authorization-dropdown.png similarity index 100% rename from products/idn/api/img/authorization/authorization-dropdown.png rename to docs/api/img/authorization/authorization-dropdown.png diff --git a/products/idn/api/img/button.svg b/docs/api/img/button.svg similarity index 100% rename from products/idn/api/img/button.svg rename to docs/api/img/button.svg diff --git a/products/idn/api/img/diff-changes.png b/docs/api/img/diff-changes.png similarity index 100% rename from products/idn/api/img/diff-changes.png rename to docs/api/img/diff-changes.png diff --git a/products/idn/api/img/http-client-identity-now.png b/docs/api/img/http-client-identity-now.png similarity index 100% rename from products/idn/api/img/http-client-identity-now.png rename to docs/api/img/http-client-identity-now.png diff --git a/products/idn/api/img/pull-changes.png b/docs/api/img/pull-changes.png similarity index 100% rename from products/idn/api/img/pull-changes.png rename to docs/api/img/pull-changes.png diff --git a/products/idn/api/img/user-web-app-identity-now.png b/docs/api/img/user-web-app-identity-now.png similarity index 100% rename from products/idn/api/img/user-web-app-identity-now.png rename to docs/api/img/user-web-app-identity-now.png diff --git a/products/nerm/api/authentication.md b/docs/api/nerm/authentication.md similarity index 84% rename from products/nerm/api/authentication.md rename to docs/api/nerm/authentication.md index f263e5f2e..5c6fa232e 100644 --- a/products/nerm/api/authentication.md +++ b/docs/api/nerm/authentication.md @@ -6,8 +6,8 @@ sidebar_label: Authentication sidebar_position: 2 sidebar_class_name: authentication keywords: ['authentication'] -description: A guide on how to use API credentials to authenticate to NERM APIs. -slug: /api/authentication +description: Authenticate to the NERM APIs. +slug: /api/nerm/authentication tags: ['Authentication'] --- diff --git a/products/nerm/api/getting-started.md b/docs/api/nerm/getting-started.md similarity index 93% rename from products/nerm/api/getting-started.md rename to docs/api/nerm/getting-started.md index 673a17ddd..9d0445681 100644 --- a/products/nerm/api/getting-started.md +++ b/docs/api/nerm/getting-started.md @@ -6,8 +6,8 @@ sidebar_label: Getting Started sidebar_position: 1 sidebar_class_name: gettingStarted keywords: ['getting started'] -description: This is this place to get started with NERM APIs. -slug: /api/getting-started +description: Start using the NERM APIs. +slug: /api/nerm/getting-started tags: ['Getting Started'] --- diff --git a/products/nerm/api/pagination-metadata-filtering.md b/docs/api/nerm/pagination-metadata-filtering.md similarity index 98% rename from products/nerm/api/pagination-metadata-filtering.md rename to docs/api/nerm/pagination-metadata-filtering.md index afd34afc7..0c302394b 100644 --- a/products/nerm/api/pagination-metadata-filtering.md +++ b/docs/api/nerm/pagination-metadata-filtering.md @@ -6,8 +6,8 @@ sidebar_label: Pagination, Metadata and Filtering sidebar_position: 3 sidebar_class_name: paginationMetadataFiltering keywords: ['pagination metadata filtering'] -description: Many endpoints in the NERM API support a generic syntax for paginating and filtering, and sorting the results. -slug: /api/pagination-metadata-filtering +description: NERM API pagination, metadata, and filtering. +slug: /api/nerm/pagination-metadata-filtering tags: ['Pagination Metadata Filtering'] --- diff --git a/docs/api/nerm/v1/create-approval-action.api.mdx b/docs/api/nerm/v1/create-approval-action.api.mdx index 3817e942a..4cdfbfbb9 100644 --- a/docs/api/nerm/v1/create-approval-action.api.mdx +++ b/docs/api/nerm/v1/create-approval-action.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create an approval action

    @@ -32,7 +30,7 @@ Create an approval action. The following supporting objects will need to be crea ## Request -

    Body

    required
      workflow_action object
    +

    Body

    required
      workflow_action object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-ask-security-question-action.api.mdx b/docs/api/nerm/v1/create-ask-security-question-action.api.mdx index d09f1dda8..2c095ef79 100644 --- a/docs/api/nerm/v1/create-ask-security-question-action.api.mdx +++ b/docs/api/nerm/v1/create-ask-security-question-action.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create ask security question action

    @@ -32,7 +30,7 @@ Create an ask security question action ## Request -

    Body

    required
      workflow_action object
    +

    Body

    required
      workflow_action object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-auto-assign-action.api.mdx b/docs/api/nerm/v1/create-auto-assign-action.api.mdx index 907aa21b4..aca11b600 100644 --- a/docs/api/nerm/v1/create-auto-assign-action.api.mdx +++ b/docs/api/nerm/v1/create-auto-assign-action.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create an auto assign action

    @@ -32,7 +30,7 @@ Create an auto assign action. The following supporting objects will need to be c ## Request -

    Body

    required
      workflow_action object
    +

    Body

    required
      workflow_action object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-automated-workflow.api.mdx b/docs/api/nerm/v1/create-automated-workflow.api.mdx index 79b610996..90cfdf877 100644 --- a/docs/api/nerm/v1/create-automated-workflow.api.mdx +++ b/docs/api/nerm/v1/create-automated-workflow.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create an automated workflow

    @@ -36,7 +34,7 @@ Create an automated workflow The ProfileTypeRule this workflow will be working with. -
  • Array [
    • `, `==`, `before`, `include?`, `absent?`, `after`]"} schema={{"type":"string","enum":["<",">","==","before","include?","absent?","after"],"required":true,"description":"The operator used by the condition rule.","example":">"}}>
  • ]
    • +
  • Array [
    • `, `==`, `before`, `include?`, `absent?`, `after`]"} schema={{"type":"string","enum":["<",">","==","before","include?","absent?","after"],"required":true,"description":"The operator used by the condition rule.","example":">"}}>
  • ]
    • Expected response to a valid request diff --git a/docs/api/nerm/v1/create-batch-update-action.api.mdx b/docs/api/nerm/v1/create-batch-update-action.api.mdx index 74b3075cf..cf3511305 100644 --- a/docs/api/nerm/v1/create-batch-update-action.api.mdx +++ b/docs/api/nerm/v1/create-batch-update-action.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a batch update action

    @@ -32,7 +30,7 @@ Create a batch update action ## Request -

    Body

    required
      workflow_action object
    +

    Body

    required
      workflow_action object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-batch-workflow.api.mdx b/docs/api/nerm/v1/create-batch-workflow.api.mdx index d755b2ee9..d8e7b7aa0 100644 --- a/docs/api/nerm/v1/create-batch-workflow.api.mdx +++ b/docs/api/nerm/v1/create-batch-workflow.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a batch workflow

    @@ -32,7 +30,7 @@ Create a batch workflow ## Request -

    Body

    required
      workflow object
      options object
    +

    Body

    required
      workflow object
      options object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-close-session-action.api.mdx b/docs/api/nerm/v1/create-close-session-action.api.mdx index 8651ca64a..457c03fa5 100644 --- a/docs/api/nerm/v1/create-close-session-action.api.mdx +++ b/docs/api/nerm/v1/create-close-session-action.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a close session action

    @@ -32,7 +30,7 @@ Create a close session action ## Request -

    Body

    required
      workflow_action object
    +

    Body

    required
      workflow_action object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-contributors-action.api.mdx b/docs/api/nerm/v1/create-contributors-action.api.mdx index 44fd26496..3c78f66f6 100644 --- a/docs/api/nerm/v1/create-contributors-action.api.mdx +++ b/docs/api/nerm/v1/create-contributors-action.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a contributors action

    @@ -32,7 +30,7 @@ Create a contributors action. The following supporting objects will need to be c ## Request -

    Body

    required
      workflow_action object
    +

    Body

    required
      workflow_action object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-create-profile-action.api.mdx b/docs/api/nerm/v1/create-create-profile-action.api.mdx index 6e4416872..75c2dc971 100644 --- a/docs/api/nerm/v1/create-create-profile-action.api.mdx +++ b/docs/api/nerm/v1/create-create-profile-action.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a create profile action

    @@ -32,7 +30,7 @@ Create a create profile action ## Request -

    Body

    required
      workflow_action object
    +

    Body

    required
      workflow_action object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-create-workflow.api.mdx b/docs/api/nerm/v1/create-create-workflow.api.mdx index dd3582867..5a8b01dd6 100644 --- a/docs/api/nerm/v1/create-create-workflow.api.mdx +++ b/docs/api/nerm/v1/create-create-workflow.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a create workflow

    @@ -32,7 +30,7 @@ Create a create workflow ## Request -

    Body

    required
      workflow object
    +

    Body

    required
      workflow object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-duplicate-prevention-action.api.mdx b/docs/api/nerm/v1/create-duplicate-prevention-action.api.mdx index 56e4faa50..5afd1d41d 100644 --- a/docs/api/nerm/v1/create-duplicate-prevention-action.api.mdx +++ b/docs/api/nerm/v1/create-duplicate-prevention-action.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a duplicate prevention action

    @@ -32,7 +30,7 @@ Create a duplicate prevention action. The following supporting objects will need ## Request -

    Body

    required
      workflow_action object
    +

    Body

    required
      workflow_action object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-email-verification-action.api.mdx b/docs/api/nerm/v1/create-email-verification-action.api.mdx index e17969ac5..796bfd277 100644 --- a/docs/api/nerm/v1/create-email-verification-action.api.mdx +++ b/docs/api/nerm/v1/create-email-verification-action.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create an email verification action

    @@ -32,7 +30,7 @@ Create an email verification action ## Request -

    Body

    required
      workflow_action object
    +

    Body

    required
      workflow_action object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-form-attribute.api.mdx b/docs/api/nerm/v1/create-form-attribute.api.mdx index 51bb4389d..9ed35eea0 100644 --- a/docs/api/nerm/v1/create-form-attribute.api.mdx +++ b/docs/api/nerm/v1/create-form-attribute.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a form attribute

    @@ -32,7 +30,7 @@ This endpoint can create a form attribute ## Request -

    Body

    required
      form_attribute object
    +

    Body

    required
      form_attribute object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-form.api.mdx b/docs/api/nerm/v1/create-form.api.mdx index bd6f74898..7cd924bc6 100644 --- a/docs/api/nerm/v1/create-form.api.mdx +++ b/docs/api/nerm/v1/create-form.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a form

    @@ -32,7 +30,7 @@ This endpoint can create a form ## Request -

    Body

    required
      form object
    +

    Body

    required
      form object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-fulfillment-action.api.mdx b/docs/api/nerm/v1/create-fulfillment-action.api.mdx index 7417670de..8deeb6442 100644 --- a/docs/api/nerm/v1/create-fulfillment-action.api.mdx +++ b/docs/api/nerm/v1/create-fulfillment-action.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a fulfillment action

    @@ -32,7 +30,7 @@ Create a fulfillment action. The following supporting objects will need to be cr ## Request -

    Body

    required
      workflow_action object
    +

    Body

    required
      workflow_action object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-identity-proofing-action.api.mdx b/docs/api/nerm/v1/create-identity-proofing-action.api.mdx index c145b4e68..223ed3f38 100644 --- a/docs/api/nerm/v1/create-identity-proofing-action.api.mdx +++ b/docs/api/nerm/v1/create-identity-proofing-action.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create an identity proofing action

    @@ -32,7 +30,7 @@ Create an identity proofing action. The following supporting objects will need t ## Request -

    Body

    required
      workflow_action object
    +

    Body

    required
      workflow_action object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-invitation-action.api.mdx b/docs/api/nerm/v1/create-invitation-action.api.mdx index 2add7e890..b2096934e 100644 --- a/docs/api/nerm/v1/create-invitation-action.api.mdx +++ b/docs/api/nerm/v1/create-invitation-action.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create an invitation action

    @@ -32,7 +30,7 @@ Create an invitation action. The following supporting objects will need to be cr ## Request -

    Body

    required
      workflow_action object
      configuration_attributes object
      workflow_action_email_attributes object
    +

    Body

    required
      workflow_action object
      configuration_attributes object
      workflow_action_email_attributes object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-ldap-action.api.mdx b/docs/api/nerm/v1/create-ldap-action.api.mdx index 0211d40e4..e249d7cbd 100644 --- a/docs/api/nerm/v1/create-ldap-action.api.mdx +++ b/docs/api/nerm/v1/create-ldap-action.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a ldap action

    @@ -32,7 +30,7 @@ Create a ldap action. The following supporting objects will need to be created a ## Request -

    Body

    required
      workflow_action object
      ldap_action_user_roles_attributes object
      workflow_action_value_builders_attributes object
      workflow_action_directory_groups_attributes object
    +

    Body

    required
      workflow_action object
      ldap_action_user_roles_attributes object
      workflow_action_value_builders_attributes object
      workflow_action_directory_groups_attributes object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-login-workflow.api.mdx b/docs/api/nerm/v1/create-login-workflow.api.mdx index 97329bd46..7d3b3dabd 100644 --- a/docs/api/nerm/v1/create-login-workflow.api.mdx +++ b/docs/api/nerm/v1/create-login-workflow.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a login workflow

    @@ -32,7 +30,7 @@ Create a login workflow ## Request -

    Body

    required
      workflow object
      options object
      = 1`"} schema={{"type":"integer","format":"int32","minimum":1,"description":"Used for login/password reset for when the password will expire.","example":1}}>
    +

    Body

    required
      workflow object
      options object
      = 1`"} schema={{"type":"integer","format":"int32","minimum":1,"description":"Used for login/password reset for when the password will expire.","example":1}}>
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-notification-action.api.mdx b/docs/api/nerm/v1/create-notification-action.api.mdx index 61c8ae186..b31c1174a 100644 --- a/docs/api/nerm/v1/create-notification-action.api.mdx +++ b/docs/api/nerm/v1/create-notification-action.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a notification action

    @@ -32,7 +30,7 @@ Create a notification action ## Request -

    Body

    required
      workflow_action object
      workflow_action_email_attributes object
    +

    Body

    required
      workflow_action object
      workflow_action_email_attributes object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-password-reset-action.api.mdx b/docs/api/nerm/v1/create-password-reset-action.api.mdx index af9164beb..dc9373863 100644 --- a/docs/api/nerm/v1/create-password-reset-action.api.mdx +++ b/docs/api/nerm/v1/create-password-reset-action.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a password reset action

    @@ -32,7 +30,7 @@ Create a password reset action ## Request -

    Body

    required
      workflow_action object
    +

    Body

    required
      workflow_action object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-password-update-workflow.api.mdx b/docs/api/nerm/v1/create-password-update-workflow.api.mdx index 51dd4c72f..6646d9623 100644 --- a/docs/api/nerm/v1/create-password-update-workflow.api.mdx +++ b/docs/api/nerm/v1/create-password-update-workflow.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a password reset workflow

    @@ -32,7 +30,7 @@ Create a password reset workflow ## Request -

    Body

    required
      workflow object
      options object
      = 1`"} schema={{"type":"integer","format":"int32","minimum":1,"description":"Used for login/password reset for when the password will expire.","example":1}}>
    +

    Body

    required
      workflow object
      options object
      = 1`"} schema={{"type":"integer","format":"int32","minimum":1,"description":"Used for login/password reset for when the password will expire.","example":1}}>
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-permission.api.mdx b/docs/api/nerm/v1/create-permission.api.mdx index 31db9d2ea..bff3d2d53 100644 --- a/docs/api/nerm/v1/create-permission.api.mdx +++ b/docs/api/nerm/v1/create-permission.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a permission

    @@ -32,7 +30,7 @@ This endpoint can create permissions for Lifecycle, Consolidation, and Collabora ## Request -

    Body

    required
      permission object
    +

    Body

    required
      permission object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-profile-check-action.api.mdx b/docs/api/nerm/v1/create-profile-check-action.api.mdx index f6b14af59..1bcb03e66 100644 --- a/docs/api/nerm/v1/create-profile-check-action.api.mdx +++ b/docs/api/nerm/v1/create-profile-check-action.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a profile check action

    @@ -32,7 +30,7 @@ Create a profile check action ## Request -

    Body

    required
      workflow_action object
    +

    Body

    required
      workflow_action object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-profile-page.api.mdx b/docs/api/nerm/v1/create-profile-page.api.mdx index f44e1d754..bf572bd5b 100644 --- a/docs/api/nerm/v1/create-profile-page.api.mdx +++ b/docs/api/nerm/v1/create-profile-page.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a profile page

    @@ -32,7 +30,7 @@ Create a profile page ## Request -

    Body

    required
      page object
    +

    Body

    required
      page object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-profile-select-action.api.mdx b/docs/api/nerm/v1/create-profile-select-action.api.mdx index e754c1b0b..d30e086fb 100644 --- a/docs/api/nerm/v1/create-profile-select-action.api.mdx +++ b/docs/api/nerm/v1/create-profile-select-action.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a profile select action

    @@ -32,7 +30,7 @@ Create a profile select action ## Request -

    Body

    required
      workflow_action object
    +

    Body

    required
      workflow_action object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-profile-type-role.api.mdx b/docs/api/nerm/v1/create-profile-type-role.api.mdx index 932f11853..9721f78bc 100644 --- a/docs/api/nerm/v1/create-profile-type-role.api.mdx +++ b/docs/api/nerm/v1/create-profile-type-role.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a profile type role

    @@ -32,7 +30,7 @@ This endpoint can create a profile type role. NOTE- The ability to toggle Allow/ ## Request -

    Body

    required
      form object
    +

    Body

    required
      form object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-registration-workflow.api.mdx b/docs/api/nerm/v1/create-registration-workflow.api.mdx index e4306564d..79fcc6566 100644 --- a/docs/api/nerm/v1/create-registration-workflow.api.mdx +++ b/docs/api/nerm/v1/create-registration-workflow.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a registration workflow

    @@ -32,7 +30,7 @@ Create a registration workflow ## Request -

    Body

    required
      workflow object
    +

    Body

    required
      workflow object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-request-action.api.mdx b/docs/api/nerm/v1/create-request-action.api.mdx index 16af1644a..2a98e8d15 100644 --- a/docs/api/nerm/v1/create-request-action.api.mdx +++ b/docs/api/nerm/v1/create-request-action.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a request action

    @@ -32,7 +30,7 @@ Create a request action ## Request -

    Body

    required
      workflow_action object
    +

    Body

    required
      workflow_action object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-rest-api-action.api.mdx b/docs/api/nerm/v1/create-rest-api-action.api.mdx index 1823853cb..a8232d4ec 100644 --- a/docs/api/nerm/v1/create-rest-api-action.api.mdx +++ b/docs/api/nerm/v1/create-rest-api-action.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a REST API action

    @@ -32,7 +30,7 @@ Create a REST API action. The following supporting objects will need to be creat ## Request -

    Body

    required
      workflow_action object
    +

    Body

    required
      workflow_action object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-review-action.api.mdx b/docs/api/nerm/v1/create-review-action.api.mdx index 574672963..14485957e 100644 --- a/docs/api/nerm/v1/create-review-action.api.mdx +++ b/docs/api/nerm/v1/create-review-action.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a review action

    @@ -32,7 +30,7 @@ Create a review action. The following supporting objects will need to be created ## Request -

    Body

    required
      workflow_action object
    +

    Body

    required
      workflow_action object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-run-workflow-action.api.mdx b/docs/api/nerm/v1/create-run-workflow-action.api.mdx index 9c19f634a..0c1d9fec6 100644 --- a/docs/api/nerm/v1/create-run-workflow-action.api.mdx +++ b/docs/api/nerm/v1/create-run-workflow-action.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a run workflow action

    @@ -32,7 +30,7 @@ Create a run workflow action. The following supporting objects will need to be c ## Request -

    Body

    required
      workflow_action object
      configuration_attributes object
    +

    Body

    required
      workflow_action object
      configuration_attributes object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-set-attributes-action.api.mdx b/docs/api/nerm/v1/create-set-attributes-action.api.mdx index bde99a101..7fd63b135 100644 --- a/docs/api/nerm/v1/create-set-attributes-action.api.mdx +++ b/docs/api/nerm/v1/create-set-attributes-action.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a set attributes action

    @@ -32,7 +30,7 @@ Create a set attributes action. The following supporting objects will need to be ## Request -

    Body

    required
      workflow_action object
    +

    Body

    required
      workflow_action object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-set-security-question-action.api.mdx b/docs/api/nerm/v1/create-set-security-question-action.api.mdx index 8b3635cfc..1f82789eb 100644 --- a/docs/api/nerm/v1/create-set-security-question-action.api.mdx +++ b/docs/api/nerm/v1/create-set-security-question-action.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create set security question action

    @@ -32,7 +30,7 @@ Create a set security question action ## Request -

    Body

    required
      workflow_action object
    +

    Body

    required
      workflow_action object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-soap-api-action.api.mdx b/docs/api/nerm/v1/create-soap-api-action.api.mdx index 5d74ffea2..e6c9f3e1c 100644 --- a/docs/api/nerm/v1/create-soap-api-action.api.mdx +++ b/docs/api/nerm/v1/create-soap-api-action.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a SOAP API action

    @@ -32,7 +30,7 @@ Create a SOAP API action. The following supporting objects will need to be creat ## Request -

    Body

    required
      workflow_action object
    +

    Body

    required
      workflow_action object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-status-change-action.api.mdx b/docs/api/nerm/v1/create-status-change-action.api.mdx index 055773608..083a66e3a 100644 --- a/docs/api/nerm/v1/create-status-change-action.api.mdx +++ b/docs/api/nerm/v1/create-status-change-action.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a status change action

    @@ -32,7 +30,7 @@ Create a status change action ## Request -

    Body

    required
      workflow_action object
    +

    Body

    required
      workflow_action object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-synced-attribute.api.mdx b/docs/api/nerm/v1/create-synced-attribute.api.mdx index fac47d64b..3830afe5e 100644 --- a/docs/api/nerm/v1/create-synced-attribute.api.mdx +++ b/docs/api/nerm/v1/create-synced-attribute.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a synced attribute

    @@ -32,7 +30,7 @@ Create synced attribute ## Request -

    Body

    required
    +

    Body

    required
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-unassign-action.api.mdx b/docs/api/nerm/v1/create-unassign-action.api.mdx index 7c84d454c..510482fba 100644 --- a/docs/api/nerm/v1/create-unassign-action.api.mdx +++ b/docs/api/nerm/v1/create-unassign-action.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create an unassign action

    @@ -32,7 +30,7 @@ Create an unassign action. The following supporting objects will need to be crea ## Request -

    Body

    required
      workflow_action object
    +

    Body

    required
      workflow_action object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-update-profile-action.api.mdx b/docs/api/nerm/v1/create-update-profile-action.api.mdx index 43a57ab8c..1856f22ac 100644 --- a/docs/api/nerm/v1/create-update-profile-action.api.mdx +++ b/docs/api/nerm/v1/create-update-profile-action.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create an update profile action

    @@ -32,7 +30,7 @@ Create an update profile action ## Request -

    Body

    required
      workflow_action object
    +

    Body

    required
      workflow_action object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-update-workflow.api.mdx b/docs/api/nerm/v1/create-update-workflow.api.mdx index a72cfa8bd..d150c704f 100644 --- a/docs/api/nerm/v1/create-update-workflow.api.mdx +++ b/docs/api/nerm/v1/create-update-workflow.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create an update workflow

    @@ -32,7 +30,7 @@ Create an update workflow ## Request -

    Body

    required
      workflow object
    +

    Body

    required
      workflow object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-user-profiles.api.mdx b/docs/api/nerm/v1/create-user-profiles.api.mdx index 848f0845b..b116d1846 100644 --- a/docs/api/nerm/v1/create-user-profiles.api.mdx +++ b/docs/api/nerm/v1/create-user-profiles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create multiple user-profile contributor relationships

    @@ -32,7 +30,7 @@ Create multiple user-profile contributor relationships ## Request -

    Body

    required
      user_profiles object[]
    • Array [
    • ]
    +

    Body

    required
      user_profiles object[]
    • Array [
    • ]
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-username-password-action.api.mdx b/docs/api/nerm/v1/create-username-password-action.api.mdx index 537275127..d0b899d52 100644 --- a/docs/api/nerm/v1/create-username-password-action.api.mdx +++ b/docs/api/nerm/v1/create-username-password-action.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a username password action

    @@ -32,7 +30,7 @@ Create a username password action ## Request -

    Body

    required
      workflow_action object
    +

    Body

    required
      workflow_action object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/create-workflow-page.api.mdx b/docs/api/nerm/v1/create-workflow-page.api.mdx index 75275a50a..20ad1d93f 100644 --- a/docs/api/nerm/v1/create-workflow-page.api.mdx +++ b/docs/api/nerm/v1/create-workflow-page.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a workflow page

    @@ -32,7 +30,7 @@ Create a workflow page ## Request -

    Body

    required
      page object
    +

    Body

    required
      page object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/delete-attribute-option.api.mdx b/docs/api/nerm/v1/delete-attribute-option.api.mdx index 4215bc8de..dccbe9f89 100644 --- a/docs/api/nerm/v1/delete-attribute-option.api.mdx +++ b/docs/api/nerm/v1/delete-attribute-option.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete a option based attribute value by id

    @@ -32,7 +30,7 @@ Delete a option based attribute value by id ## Request -

    Path Parameters

    +

    Path Parameters

    Confirmation of a deleted object diff --git a/docs/api/nerm/v1/delete-profile-type.api.mdx b/docs/api/nerm/v1/delete-profile-type.api.mdx index 517b8af6b..2e76b38c0 100644 --- a/docs/api/nerm/v1/delete-profile-type.api.mdx +++ b/docs/api/nerm/v1/delete-profile-type.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete profile type

    @@ -32,7 +30,7 @@ Delete a profile type. All profiles of that type must first be destroyed before ## Request -

    Path Parameters

    +

    Path Parameters

    Info about the operation diff --git a/docs/api/nerm/v1/delete-profile.api.mdx b/docs/api/nerm/v1/delete-profile.api.mdx index 6793db228..f8647b023 100644 --- a/docs/api/nerm/v1/delete-profile.api.mdx +++ b/docs/api/nerm/v1/delete-profile.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete a single profile

    @@ -32,7 +30,7 @@ Delete a single profile ## Request -

    Path Parameters

    +

    Path Parameters

    The Profile was successfully deleted. diff --git a/docs/api/nerm/v1/delete-profiles.api.mdx b/docs/api/nerm/v1/delete-profiles.api.mdx index cd3e1b84a..974701c20 100644 --- a/docs/api/nerm/v1/delete-profiles.api.mdx +++ b/docs/api/nerm/v1/delete-profiles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete multiple profiles

    @@ -32,7 +30,7 @@ Delete multiple profiles ## Request -

    Body

    required
      profiles object[]
    • Array [
    • ]
    +

    Body

    required
      profiles object[]
    • Array [
    • ]
    Expected response to a valid request diff --git a/docs/api/nerm/v1/delete-role-profile.api.mdx b/docs/api/nerm/v1/delete-role-profile.api.mdx index 82ce5d1e5..a0ea6e6d1 100644 --- a/docs/api/nerm/v1/delete-role-profile.api.mdx +++ b/docs/api/nerm/v1/delete-role-profile.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete a role profile assignment

    @@ -32,7 +30,7 @@ Delete a role profile assignment ## Request -

    Path Parameters

    +

    Path Parameters

    Role profile was destroyed diff --git a/docs/api/nerm/v1/delete-synced-attribute.api.mdx b/docs/api/nerm/v1/delete-synced-attribute.api.mdx index 3b8413bc6..940440bc7 100644 --- a/docs/api/nerm/v1/delete-synced-attribute.api.mdx +++ b/docs/api/nerm/v1/delete-synced-attribute.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete synced attribute

    @@ -32,7 +30,7 @@ Delete a synced attribute. ## Request -

    Path Parameters

    +

    Path Parameters

    Info about the operation diff --git a/docs/api/nerm/v1/delete-user-profile.api.mdx b/docs/api/nerm/v1/delete-user-profile.api.mdx index 65aa93db6..3e262ca10 100644 --- a/docs/api/nerm/v1/delete-user-profile.api.mdx +++ b/docs/api/nerm/v1/delete-user-profile.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete a user profile assignment

    @@ -32,7 +30,7 @@ Delete a user profile assignment ## Request -

    Path Parameters

    +

    Path Parameters

    User profile was destroyed diff --git a/docs/api/nerm/v1/delete-user-profiles.api.mdx b/docs/api/nerm/v1/delete-user-profiles.api.mdx index e9af3de65..979c6d459 100644 --- a/docs/api/nerm/v1/delete-user-profiles.api.mdx +++ b/docs/api/nerm/v1/delete-user-profiles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete multiple user-profile contributor relationships

    @@ -32,7 +30,7 @@ Delete multiple user-profile contributor relationships ## Request -

    Body

    required
      user_profiles object[]
    • Array [
    • ]
    +

    Body

    required
      user_profiles object[]
    • Array [
    • ]
    Expected response to a valid request diff --git a/docs/api/nerm/v1/delete-user-role.api.mdx b/docs/api/nerm/v1/delete-user-role.api.mdx index f7a182da8..e3e7271af 100644 --- a/docs/api/nerm/v1/delete-user-role.api.mdx +++ b/docs/api/nerm/v1/delete-user-role.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete a user role assignment

    @@ -32,7 +30,7 @@ Delete a user role assignment ## Request -

    Path Parameters

    +

    Path Parameters

    User role was destroyed diff --git a/docs/api/nerm/v1/delete-user.api.mdx b/docs/api/nerm/v1/delete-user.api.mdx index b18964ed4..ec046908f 100644 --- a/docs/api/nerm/v1/delete-user.api.mdx +++ b/docs/api/nerm/v1/delete-user.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete a user

    @@ -32,7 +30,7 @@ Delete a user ## Request -

    Path Parameters

    +

    Path Parameters

    Info about the operation diff --git a/docs/api/nerm/v1/get-advanced-search.api.mdx b/docs/api/nerm/v1/get-advanced-search.api.mdx index c1ef06ff1..e78615f32 100644 --- a/docs/api/nerm/v1/get-advanced-search.api.mdx +++ b/docs/api/nerm/v1/get-advanced-search.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get saved advanced search queries

    @@ -32,7 +30,7 @@ Get saved advanced search queries ## Request -
    +
    Expected response to a valid request diff --git a/docs/api/nerm/v1/get-attribute-option.api.mdx b/docs/api/nerm/v1/get-attribute-option.api.mdx index 4a798afdb..64c3b243f 100644 --- a/docs/api/nerm/v1/get-attribute-option.api.mdx +++ b/docs/api/nerm/v1/get-attribute-option.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Find option based attribute value by id

    @@ -32,7 +30,7 @@ Info for a specific option based attribute value ## Request -

    Path Parameters

    +

    Path Parameters

    Expected response to a valid request diff --git a/docs/api/nerm/v1/get-attribute-options.api.mdx b/docs/api/nerm/v1/get-attribute-options.api.mdx index 75a1acb14..50ed6477f 100644 --- a/docs/api/nerm/v1/get-attribute-options.api.mdx +++ b/docs/api/nerm/v1/get-attribute-options.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get option based attribute values

    @@ -32,7 +30,7 @@ Get option based attribute values ## Request -

    Query Parameters

    +

    Query Parameters

    Expected response to a valid request diff --git a/docs/api/nerm/v1/get-attribute.api.mdx b/docs/api/nerm/v1/get-attribute.api.mdx index 466a258a4..cb30ea3cf 100644 --- a/docs/api/nerm/v1/get-attribute.api.mdx +++ b/docs/api/nerm/v1/get-attribute.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Find attribute data by id

    @@ -32,11 +30,11 @@ Info for a specific attribute ## Request -

    Path Parameters

    +

    Path Parameters

    Expected response to a valid request -
    Schema
      ne_attribute object
      = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
    +
    Schema
      ne_attribute object
      = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
    Bad Request - unable to complete. diff --git a/docs/api/nerm/v1/get-attributes.api.mdx b/docs/api/nerm/v1/get-attributes.api.mdx index 02303d186..b0a7a1c2c 100644 --- a/docs/api/nerm/v1/get-attributes.api.mdx +++ b/docs/api/nerm/v1/get-attributes.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get attribute data in bulk

    @@ -32,11 +30,11 @@ This endpoint can retrieve attribute data in bulk from Lifecycle or you can sear ## Request -

    Query Parameters

    +

    Query Parameters

    Expected response to a valid request -
    Schema
      ne_attributes object[]
    • Array [
      • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
    • ]
      • _metadata object
    +
    Schema
      ne_attributes object[]
    • Array [
      • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
    • ]
      • _metadata object
    Bad Request - unable to complete. diff --git a/docs/api/nerm/v1/get-identity-proofing-results.api.mdx b/docs/api/nerm/v1/get-identity-proofing-results.api.mdx index 27c5de06c..58467a108 100644 --- a/docs/api/nerm/v1/get-identity-proofing-results.api.mdx +++ b/docs/api/nerm/v1/get-identity-proofing-results.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get identity proofing result data in bulk

    @@ -32,8 +30,8 @@ This endpoint can retrieve identity proofing result data in bulk from Lifecycle ## Request -

    Query Parameters

    +

    Query Parameters

    Expected response to a valid request -
    Schema
      identity_proofing_results object[]
    • Array [
      • proofing_attributes object
    • ]
      • _metadata object
    \ No newline at end of file +
    Schema
      identity_proofing_results object[]
    • Array [
      • proofing_attributes object
    • ]
      • _metadata object
    \ No newline at end of file diff --git a/docs/api/nerm/v1/get-job-status.api.mdx b/docs/api/nerm/v1/get-job-status.api.mdx index b1bd1f965..634cad4cb 100644 --- a/docs/api/nerm/v1/get-job-status.api.mdx +++ b/docs/api/nerm/v1/get-job-status.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get the status of a bulk job

    @@ -32,7 +30,7 @@ Get the status of a bulk job ## Request -

    Query Parameters

    +

    Query Parameters

    Expected response to a valid request diff --git a/docs/api/nerm/v1/get-profile-avatar.api.mdx b/docs/api/nerm/v1/get-profile-avatar.api.mdx index 618d20f28..13206ad35 100644 --- a/docs/api/nerm/v1/get-profile-avatar.api.mdx +++ b/docs/api/nerm/v1/get-profile-avatar.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Retrieves the URL of the profile avatar

    @@ -32,7 +30,7 @@ Retrieves the URL of the profile avatar ## Request -

    Path Parameters

    +

    Path Parameters

    Expected response to a valid request diff --git a/docs/api/nerm/v1/get-profile-type-attributes.api.mdx b/docs/api/nerm/v1/get-profile-type-attributes.api.mdx index d2d2f2a2a..bca3de8e2 100644 --- a/docs/api/nerm/v1/get-profile-type-attributes.api.mdx +++ b/docs/api/nerm/v1/get-profile-type-attributes.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    profile_types/ne_attributes synced status

    @@ -32,7 +30,7 @@ Get ne attributes and synced attribute relationship to profile type. ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Expected response to a valid request diff --git a/docs/api/nerm/v1/get-profile-type.api.mdx b/docs/api/nerm/v1/get-profile-type.api.mdx index 45636f5b8..0a922d4b3 100644 --- a/docs/api/nerm/v1/get-profile-type.api.mdx +++ b/docs/api/nerm/v1/get-profile-type.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Find profile type by id

    @@ -32,7 +30,7 @@ Find profile type by id ## Request -

    Path Parameters

    +

    Path Parameters

    Expected response to a valid request diff --git a/docs/api/nerm/v1/get-profile-types.api.mdx b/docs/api/nerm/v1/get-profile-types.api.mdx index 26ddd8f76..5678310b5 100644 --- a/docs/api/nerm/v1/get-profile-types.api.mdx +++ b/docs/api/nerm/v1/get-profile-types.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get profile types

    @@ -32,7 +30,7 @@ Get option based attribute values ## Request -

    Query Parameters

    +

    Query Parameters

    Expected response to a valid request diff --git a/docs/api/nerm/v1/get-profile-upload.api.mdx b/docs/api/nerm/v1/get-profile-upload.api.mdx index 759010756..36695f068 100644 --- a/docs/api/nerm/v1/get-profile-upload.api.mdx +++ b/docs/api/nerm/v1/get-profile-upload.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Retrieves the URL of an attachment attribute value from a profile

    @@ -32,7 +30,7 @@ Retrieves the URL of an attachment attribute value from a profile ## Request -

    Path Parameters

    +

    Path Parameters

    Expected response to a valid request diff --git a/docs/api/nerm/v1/get-profile.api.mdx b/docs/api/nerm/v1/get-profile.api.mdx index 0f368407e..e0dcbdf84 100644 --- a/docs/api/nerm/v1/get-profile.api.mdx +++ b/docs/api/nerm/v1/get-profile.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Find profile by id

    @@ -32,7 +30,7 @@ Find profile by id ## Request -

    Path Parameters

    +

    Path Parameters

    Expected response to a valid request diff --git a/docs/api/nerm/v1/get-profiles.api.mdx b/docs/api/nerm/v1/get-profiles.api.mdx index f5d44a7ad..05b64c7b3 100644 --- a/docs/api/nerm/v1/get-profiles.api.mdx +++ b/docs/api/nerm/v1/get-profiles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get profiles

    @@ -32,7 +30,7 @@ Get profiles ## Request -

    Query Parameters

    +

    Query Parameters

    Expected response to a valid request diff --git a/docs/api/nerm/v1/get-risk-level.api.mdx b/docs/api/nerm/v1/get-risk-level.api.mdx index 1ea09738d..6ea7912af 100644 --- a/docs/api/nerm/v1/get-risk-level.api.mdx +++ b/docs/api/nerm/v1/get-risk-level.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Find risk level data by id

    @@ -32,7 +30,7 @@ Find risk level data by id ## Request -

    Path Parameters

    +

    Path Parameters

    Expected response to a valid request diff --git a/docs/api/nerm/v1/get-risk-levels.api.mdx b/docs/api/nerm/v1/get-risk-levels.api.mdx index bd68778bb..71d5a5e08 100644 --- a/docs/api/nerm/v1/get-risk-levels.api.mdx +++ b/docs/api/nerm/v1/get-risk-levels.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get risk level data in bulk

    @@ -32,7 +30,7 @@ This endpoint can retrieve risk level data in bulk from Lifecycle ## Request -

    Query Parameters

    +

    Query Parameters

    Expected response to a valid request diff --git a/docs/api/nerm/v1/get-risk-score.api.mdx b/docs/api/nerm/v1/get-risk-score.api.mdx index 56b48c00e..461de540c 100644 --- a/docs/api/nerm/v1/get-risk-score.api.mdx +++ b/docs/api/nerm/v1/get-risk-score.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Find risk score data by id

    @@ -32,7 +30,7 @@ Find risk score data by id ## Request -

    Path Parameters

    +

    Path Parameters

    Expected response to a valid request diff --git a/docs/api/nerm/v1/get-risk-scores.api.mdx b/docs/api/nerm/v1/get-risk-scores.api.mdx index 85a34c332..9ff98d131 100644 --- a/docs/api/nerm/v1/get-risk-scores.api.mdx +++ b/docs/api/nerm/v1/get-risk-scores.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get risk score data in bulk

    @@ -32,7 +30,7 @@ This endpoint can retrieve risk score data in bulk from Lifecycle ## Request -

    Query Parameters

    +

    Query Parameters

    Expected response to a valid request diff --git a/docs/api/nerm/v1/get-role-profile.api.mdx b/docs/api/nerm/v1/get-role-profile.api.mdx index 548685bf3..feb4eea4d 100644 --- a/docs/api/nerm/v1/get-role-profile.api.mdx +++ b/docs/api/nerm/v1/get-role-profile.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Find role-profile contributor relationship by id

    @@ -32,7 +30,7 @@ Find role-profile contributor relationship by id ## Request -

    Path Parameters

    +

    Path Parameters

    Expected response to a valid request diff --git a/docs/api/nerm/v1/get-role-profiles.api.mdx b/docs/api/nerm/v1/get-role-profiles.api.mdx index fa9a9501c..3c6ae9295 100644 --- a/docs/api/nerm/v1/get-role-profiles.api.mdx +++ b/docs/api/nerm/v1/get-role-profiles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get role-profile contributor relationships

    @@ -32,7 +30,7 @@ Get role-profile contributor relationships ## Request -

    Query Parameters

    +

    Query Parameters

    Expected response to a valid request diff --git a/docs/api/nerm/v1/get-role.api.mdx b/docs/api/nerm/v1/get-role.api.mdx index 829a41a81..d379e1e08 100644 --- a/docs/api/nerm/v1/get-role.api.mdx +++ b/docs/api/nerm/v1/get-role.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Find role by id

    @@ -32,7 +30,7 @@ Info for a specific user role ## Request -

    Path Parameters

    +

    Path Parameters

    Expected response to a valid request diff --git a/docs/api/nerm/v1/get-roles.api.mdx b/docs/api/nerm/v1/get-roles.api.mdx index 2fa923cde..f06632bdb 100644 --- a/docs/api/nerm/v1/get-roles.api.mdx +++ b/docs/api/nerm/v1/get-roles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get roles

    @@ -32,7 +30,7 @@ This endpoint can retrieve roles from NERM. Optionally you can provide parameter ## Request -

    Query Parameters

    +

    Query Parameters

    Expected response to a valid request diff --git a/docs/api/nerm/v1/get-user-avatar.api.mdx b/docs/api/nerm/v1/get-user-avatar.api.mdx index 3786a4199..326cee959 100644 --- a/docs/api/nerm/v1/get-user-avatar.api.mdx +++ b/docs/api/nerm/v1/get-user-avatar.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Retrieves the URL of the user avatar

    @@ -32,7 +30,7 @@ Retrieves the URL of the user avatar ## Request -

    Path Parameters

    +

    Path Parameters

    Expected response to a valid request diff --git a/docs/api/nerm/v1/get-user-manager.api.mdx b/docs/api/nerm/v1/get-user-manager.api.mdx index 6b8c440f7..507f8d6cc 100644 --- a/docs/api/nerm/v1/get-user-manager.api.mdx +++ b/docs/api/nerm/v1/get-user-manager.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Find user-manager relationship by id

    @@ -32,7 +30,7 @@ Info for a specific user-manager relationship ## Request -

    Path Parameters

    +

    Path Parameters

    Expected response to a valid request diff --git a/docs/api/nerm/v1/get-user-managers.api.mdx b/docs/api/nerm/v1/get-user-managers.api.mdx index dc70b4aae..5fd02cd76 100644 --- a/docs/api/nerm/v1/get-user-managers.api.mdx +++ b/docs/api/nerm/v1/get-user-managers.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get user-manager relationships

    @@ -32,7 +30,7 @@ This endpoint can retrieve user-manager relationships from Lifecycle or you can ## Request -

    Query Parameters

    +

    Query Parameters

    Expected response to a valid request diff --git a/docs/api/nerm/v1/get-user-profile.api.mdx b/docs/api/nerm/v1/get-user-profile.api.mdx index 945906ca3..0fa2e3015 100644 --- a/docs/api/nerm/v1/get-user-profile.api.mdx +++ b/docs/api/nerm/v1/get-user-profile.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Find user-profile contributor relationship by id

    @@ -32,7 +30,7 @@ Find user-profile contributor relationship by id ## Request -

    Path Parameters

    +

    Path Parameters

    Expected response to a valid request diff --git a/docs/api/nerm/v1/get-user-profiles.api.mdx b/docs/api/nerm/v1/get-user-profiles.api.mdx index c4dec9a70..14adc4a7e 100644 --- a/docs/api/nerm/v1/get-user-profiles.api.mdx +++ b/docs/api/nerm/v1/get-user-profiles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get user-profile contributor relationships

    @@ -32,7 +30,7 @@ Get user-profile contributor relationships ## Request -

    Query Parameters

    +

    Query Parameters

    Expected response to a valid request diff --git a/docs/api/nerm/v1/get-user-role.api.mdx b/docs/api/nerm/v1/get-user-role.api.mdx index e7060cd42..c63826269 100644 --- a/docs/api/nerm/v1/get-user-role.api.mdx +++ b/docs/api/nerm/v1/get-user-role.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Find user role pairing by id

    @@ -32,7 +30,7 @@ Info for a specific user role pairing ## Request -

    Path Parameters

    +

    Path Parameters

    Expected response to a valid request diff --git a/docs/api/nerm/v1/get-user-roles.api.mdx b/docs/api/nerm/v1/get-user-roles.api.mdx index fc7726c69..726dec08e 100644 --- a/docs/api/nerm/v1/get-user-roles.api.mdx +++ b/docs/api/nerm/v1/get-user-roles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get user role pairings

    @@ -32,7 +30,7 @@ This endpoint can retrieve user role pairings from Lifecycle or you can search f ## Request -

    Query Parameters

    +

    Query Parameters

    Expected response to a valid request diff --git a/docs/api/nerm/v1/get-user.api.mdx b/docs/api/nerm/v1/get-user.api.mdx index 80c4ddf59..d9cda2001 100644 --- a/docs/api/nerm/v1/get-user.api.mdx +++ b/docs/api/nerm/v1/get-user.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Find user by id

    @@ -32,11 +30,11 @@ Info for a specific user ## Request -

    Path Parameters

    +

    Path Parameters

    Expected response to a valid request -
    Schema
      user object
      = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readonly":true}}>
    +
    Schema
      user object
      = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readonly":true}}>
    Bad Request - unable to complete. diff --git a/docs/api/nerm/v1/get-users.api.mdx b/docs/api/nerm/v1/get-users.api.mdx index c95d63684..e61389291 100644 --- a/docs/api/nerm/v1/get-users.api.mdx +++ b/docs/api/nerm/v1/get-users.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get users

    @@ -32,11 +30,11 @@ This endpoint can retrieve users from Lifecycle or you can search for users usin ## Request -

    Query Parameters

    +

    Query Parameters

    Expected response to a valid request -
    Schema
      users object[]
    • Array [
      • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readonly":true}}>
    • ]
      • _metadata object
    +
    Schema
      users object[]
    • Array [
      • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readonly":true}}>
    • ]
      • _metadata object
    Bad Request - unable to complete. diff --git a/docs/api/nerm/v1/get-workflow-actions.api.mdx b/docs/api/nerm/v1/get-workflow-actions.api.mdx index 2cf891a07..818f92782 100644 --- a/docs/api/nerm/v1/get-workflow-actions.api.mdx +++ b/docs/api/nerm/v1/get-workflow-actions.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Workflow Actions

    @@ -32,7 +30,7 @@ This endpoint can retrieve workflow actions ## Request -

    Query Parameters

    +

    Query Parameters

    Expected response to a valid request diff --git a/docs/api/nerm/v1/get-workflow-session-upload.api.mdx b/docs/api/nerm/v1/get-workflow-session-upload.api.mdx index 17b9f950b..4034a2886 100644 --- a/docs/api/nerm/v1/get-workflow-session-upload.api.mdx +++ b/docs/api/nerm/v1/get-workflow-session-upload.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Retrieves the URL of an attachment attribute value from a workflow session

    @@ -32,7 +30,7 @@ Retrieves the URL of an attachment attribute value from a workflow session ## Request -

    Path Parameters

    +

    Path Parameters

    Expected response to a valid request diff --git a/docs/api/nerm/v1/get-workflow-session.api.mdx b/docs/api/nerm/v1/get-workflow-session.api.mdx index 61d9f3fb3..0a9e1bb91 100644 --- a/docs/api/nerm/v1/get-workflow-session.api.mdx +++ b/docs/api/nerm/v1/get-workflow-session.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Find workflow session by id

    @@ -32,7 +30,7 @@ Find workflow session by id ## Request -

    Path Parameters

    +

    Path Parameters

    Expected response to a valid request diff --git a/docs/api/nerm/v1/get-workflow-sessions.api.mdx b/docs/api/nerm/v1/get-workflow-sessions.api.mdx index 478ce92dd..235d64ac0 100644 --- a/docs/api/nerm/v1/get-workflow-sessions.api.mdx +++ b/docs/api/nerm/v1/get-workflow-sessions.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get workflow sessions

    @@ -32,7 +30,7 @@ Get workflow sessions ## Request -

    Query Parameters

    +

    Query Parameters

    Expected response to a valid request diff --git a/docs/api/nerm/v1/patch-advanced-search.api.mdx b/docs/api/nerm/v1/patch-advanced-search.api.mdx index 3933b1289..d57f5968b 100644 --- a/docs/api/nerm/v1/patch-advanced-search.api.mdx +++ b/docs/api/nerm/v1/patch-advanced-search.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update a saved advanced search query

    @@ -32,7 +30,7 @@ Update a saved advanced search query ## Request -

    Path Parameters

    Body

    required
      advanced_search object
      condition_rules_attributes object[]
    • Array [
      • anyOf`, `<`, `start_with?`, `end_with?`, `include?`]"} schema={{"type":"string","required":true,"enum":["==","!=",">","<","start_with?","end_with?","include?"]}}>`, `<`, `after`, `before`]"} schema={{"type":"string","enum":[">","<","after","before"]}}>`]"} schema={{"type":"string","required":true,"enum":["Today",""]}}>`, `<`]"} schema={{"type":"string","enum":["==",">","<"]}}>
    • ]
    +

    Path Parameters

    Body

    required
      advanced_search object
      condition_rules_attributes object[]
    • Array [
      • anyOf`, `<`, `start_with?`, `end_with?`, `include?`]"} schema={{"type":"string","required":true,"enum":["==","!=",">","<","start_with?","end_with?","include?"]}}>`, `<`, `after`, `before`]"} schema={{"type":"string","enum":[">","<","after","before"]}}>`]"} schema={{"type":"string","required":true,"enum":["Today",""]}}>`, `<`]"} schema={{"type":"string","enum":["==",">","<"]}}>
    • ]
    Expected response to a valid request diff --git a/docs/api/nerm/v1/patch-attribute-option.api.mdx b/docs/api/nerm/v1/patch-attribute-option.api.mdx index fb3b55c58..ca740175b 100644 --- a/docs/api/nerm/v1/patch-attribute-option.api.mdx +++ b/docs/api/nerm/v1/patch-attribute-option.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update a option based attribute value by id

    @@ -32,7 +30,7 @@ Update a option based attribute value by id ## Request -

    Path Parameters

    Body

    required
      ne_attribute_option object
    +

    Path Parameters

    Body

    required
      ne_attribute_option object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/patch-attribute-options.api.mdx b/docs/api/nerm/v1/patch-attribute-options.api.mdx index a315e23c4..50f794f17 100644 --- a/docs/api/nerm/v1/patch-attribute-options.api.mdx +++ b/docs/api/nerm/v1/patch-attribute-options.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update multiple option based attribute values

    @@ -32,7 +30,7 @@ Update multiple option based attribute values ## Request -

    Body

    required
      ne_attribute_options object[]
    • Array [
    • ]
    +

    Body

    required
      ne_attribute_options object[]
    • Array [
    • ]
    Expected response to a valid request diff --git a/docs/api/nerm/v1/patch-profile-type.api.mdx b/docs/api/nerm/v1/patch-profile-type.api.mdx index 70b28e660..45a86160c 100644 --- a/docs/api/nerm/v1/patch-profile-type.api.mdx +++ b/docs/api/nerm/v1/patch-profile-type.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update a profile type by id

    @@ -32,7 +30,7 @@ Update a profile type by id ## Request -

    Path Parameters

    Body

    required
      profile_type object
      profile_type_dup_attributes object[]
    • Array [
      • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"description":"The uid of the properties that are used for duplication protection.","example":"attribute-uid"}}>
    • ]
      • profile_type_namings object[]
    • Array [
      • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"description":"The UID of the profile type naming.","example":"profile-type-name"}}>
    • ]
    +

    Path Parameters

    Body

    required
      profile_type object
      profile_type_dup_attributes object[]
    • Array [
      • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"description":"The uid of the properties that are used for duplication protection.","example":"attribute-uid"}}>
    • ]
      • profile_type_namings object[]
    • Array [
      • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"description":"The UID of the profile type naming.","example":"profile-type-name"}}>
    • ]
    Expected response to a valid request diff --git a/docs/api/nerm/v1/patch-profile.api.mdx b/docs/api/nerm/v1/patch-profile.api.mdx index 2dcf335d1..8434b1c13 100644 --- a/docs/api/nerm/v1/patch-profile.api.mdx +++ b/docs/api/nerm/v1/patch-profile.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update a profile by id

    @@ -32,7 +30,7 @@ Update a profile by id ## Request -

    Path Parameters

    Body

    required
      profile object
      attributes object
    +

    Path Parameters

    Body

    required
      profile object
      attributes object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/patch-profiles.api.mdx b/docs/api/nerm/v1/patch-profiles.api.mdx index ae048df22..a3cd1c1bc 100644 --- a/docs/api/nerm/v1/patch-profiles.api.mdx +++ b/docs/api/nerm/v1/patch-profiles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update multiple profiles

    @@ -32,7 +30,7 @@ Update multiple profiles ## Request -

    Body

    required
      profiles object[]
    • Array [
      • attributes object
    • ]
    +

    Body

    required
      profiles object[]
    • Array [
      • attributes object
    • ]
    Expected response to a valid request diff --git a/docs/api/nerm/v1/patch-role-profile.api.mdx b/docs/api/nerm/v1/patch-role-profile.api.mdx index 4767dbec7..c53374871 100644 --- a/docs/api/nerm/v1/patch-role-profile.api.mdx +++ b/docs/api/nerm/v1/patch-role-profile.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update a role-profile contributor relationship by id

    @@ -32,7 +30,7 @@ Update a role-profile contributor relationship by id ## Request -

    Path Parameters

    Body

    required
      role_profile object
    +

    Path Parameters

    Body

    required
      role_profile object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/patch-role-profiles.api.mdx b/docs/api/nerm/v1/patch-role-profiles.api.mdx index 3fe8075a3..5dce5ac55 100644 --- a/docs/api/nerm/v1/patch-role-profiles.api.mdx +++ b/docs/api/nerm/v1/patch-role-profiles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update multiple role-profile contributor relationships

    @@ -32,7 +30,7 @@ Update multiple role-profile contributor relationships ## Request -

    Body

    required
      role_profiles object[]
    • Array [
    • ]
    +

    Body

    required
      role_profiles object[]
    • Array [
    • ]
    Expected response to a valid request diff --git a/docs/api/nerm/v1/patch-role.api.mdx b/docs/api/nerm/v1/patch-role.api.mdx index 9bbb1d752..9e0a280d3 100644 --- a/docs/api/nerm/v1/patch-role.api.mdx +++ b/docs/api/nerm/v1/patch-role.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update an existing role

    @@ -32,7 +30,7 @@ Update an existing role ## Request -

    Path Parameters

    Body

    required
      role object
    +

    Path Parameters

    Body

    required
      role object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/patch-roles.api.mdx b/docs/api/nerm/v1/patch-roles.api.mdx index 83e417b95..3690e5785 100644 --- a/docs/api/nerm/v1/patch-roles.api.mdx +++ b/docs/api/nerm/v1/patch-roles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update multiple roles

    @@ -32,7 +30,7 @@ Update multiple users ## Request -

    Body

    required
      roles object[]
    • Array [
    • ]
    +

    Body

    required
      roles object[]
    • Array [
    • ]
    Expected response to a valid request diff --git a/docs/api/nerm/v1/patch-user-manager.api.mdx b/docs/api/nerm/v1/patch-user-manager.api.mdx index 99570fae0..1ddccc0fe 100644 --- a/docs/api/nerm/v1/patch-user-manager.api.mdx +++ b/docs/api/nerm/v1/patch-user-manager.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update a user-manager relationship by id

    @@ -32,7 +30,7 @@ Update a user-manager relationship by id ## Request -

    Path Parameters

    Body

    required
      user_manager object
    +

    Path Parameters

    Body

    required
      user_manager object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/patch-user-managers.api.mdx b/docs/api/nerm/v1/patch-user-managers.api.mdx index dc05bdc49..9c19b7e53 100644 --- a/docs/api/nerm/v1/patch-user-managers.api.mdx +++ b/docs/api/nerm/v1/patch-user-managers.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update multiple user-manager relationships

    @@ -32,7 +30,7 @@ Update multiple user-manager relationships ## Request -

    Body

    required
      user_managers object[]
    • Array [
    • ]
    +

    Body

    required
      user_managers object[]
    • Array [
    • ]
    Expected response to a valid request diff --git a/docs/api/nerm/v1/patch-user-profile.api.mdx b/docs/api/nerm/v1/patch-user-profile.api.mdx index e81bf34fb..ac9f00959 100644 --- a/docs/api/nerm/v1/patch-user-profile.api.mdx +++ b/docs/api/nerm/v1/patch-user-profile.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update a user-profile contributor relationship by id

    @@ -32,7 +30,7 @@ Update a user-profile contributor relationship by id ## Request -

    Path Parameters

    Body

    required
      user_profile object
    +

    Path Parameters

    Body

    required
      user_profile object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/patch-user-profiles.api.mdx b/docs/api/nerm/v1/patch-user-profiles.api.mdx index 29090a4b1..8ad2093f6 100644 --- a/docs/api/nerm/v1/patch-user-profiles.api.mdx +++ b/docs/api/nerm/v1/patch-user-profiles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update multiple user-profile contributor relationships

    @@ -32,7 +30,7 @@ Update multiple user-profile contributor relationships ## Request -

    Body

    required
      user_profiles object[]
    • Array [
    • ]
    +

    Body

    required
      user_profiles object[]
    • Array [
    • ]
    Expected response to a valid request diff --git a/docs/api/nerm/v1/patch-user-role.api.mdx b/docs/api/nerm/v1/patch-user-role.api.mdx index e5f12d8b9..937b30fa5 100644 --- a/docs/api/nerm/v1/patch-user-role.api.mdx +++ b/docs/api/nerm/v1/patch-user-role.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update a user role pairing by id

    @@ -32,7 +30,7 @@ Update a user role pairing by id ## Request -

    Path Parameters

    Body

    required
      user_role object
    +

    Path Parameters

    Body

    required
      user_role object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/patch-user-roles.api.mdx b/docs/api/nerm/v1/patch-user-roles.api.mdx index 7e036d732..9c43a73b6 100644 --- a/docs/api/nerm/v1/patch-user-roles.api.mdx +++ b/docs/api/nerm/v1/patch-user-roles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update multiple user role pairings

    @@ -32,7 +30,7 @@ Update multiple user role pairings ## Request -

    Body

    required
      user_roles object[]
    • Array [
    • ]
    +

    Body

    required
      user_roles object[]
    • Array [
    • ]
    Expected response to a valid request diff --git a/docs/api/nerm/v1/patch-user.api.mdx b/docs/api/nerm/v1/patch-user.api.mdx index d0857596c..631dc7b4f 100644 --- a/docs/api/nerm/v1/patch-user.api.mdx +++ b/docs/api/nerm/v1/patch-user.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update a user by id

    @@ -32,11 +30,11 @@ Update a user by id ## Request -

    Path Parameters

    Body

    required
      user object
    +

    Path Parameters

    Body

    required
      user object
    Expected response to a valid request -
    Schema
      user object
      = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readonly":true}}>
    +
    Schema
      user object
      = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readonly":true}}>
    Bad Request - unable to complete. diff --git a/docs/api/nerm/v1/patch-users.api.mdx b/docs/api/nerm/v1/patch-users.api.mdx index a1449f60b..65bdf6158 100644 --- a/docs/api/nerm/v1/patch-users.api.mdx +++ b/docs/api/nerm/v1/patch-users.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update multiple users

    @@ -32,7 +30,7 @@ Update multiple users ## Request -

    Body

    required
      users object[]
    • Array [
    • ]
    +

    Body

    required
      users object[]
    • Array [
    • ]
    Expected response to a valid request diff --git a/docs/api/nerm/v1/patch-workflow-session.api.mdx b/docs/api/nerm/v1/patch-workflow-session.api.mdx index e8c6f7663..b17e42106 100644 --- a/docs/api/nerm/v1/patch-workflow-session.api.mdx +++ b/docs/api/nerm/v1/patch-workflow-session.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update a workflow session by id

    @@ -32,7 +30,7 @@ Update a workflow session by id ## Request -

    Path Parameters

    Query Parameters

    Body

    required
      workflow_session object
      attributes object
    +

    Path Parameters

    Query Parameters

    Body

    required
      workflow_session object
      attributes object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/post-advanced-search.api.mdx b/docs/api/nerm/v1/post-advanced-search.api.mdx index 238158092..614e49916 100644 --- a/docs/api/nerm/v1/post-advanced-search.api.mdx +++ b/docs/api/nerm/v1/post-advanced-search.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Save an advanced search query for later use

    @@ -32,7 +30,7 @@ Save an advanced search query for later use ## Request -

    Body

    required
      advanced_search object
      condition_rules_attributes object[]
    • Array [
      • anyOf`, `<`, `start_with?`, `end_with?`, `include?`]"} schema={{"type":"string","required":true,"enum":["==","!=",">","<","start_with?","end_with?","include?"]}}>`, `<`, `after`, `before`]"} schema={{"type":"string","enum":[">","<","after","before"]}}>`]"} schema={{"type":"string","required":true,"enum":["Today",""]}}>`, `<`]"} schema={{"type":"string","enum":["==",">","<"]}}>
    • ]
    +

    Body

    required
      advanced_search object
      condition_rules_attributes object[]
    • Array [
      • anyOf`, `<`, `start_with?`, `end_with?`, `include?`]"} schema={{"type":"string","required":true,"enum":["==","!=",">","<","start_with?","end_with?","include?"]}}>`, `<`, `after`, `before`]"} schema={{"type":"string","enum":[">","<","after","before"]}}>`]"} schema={{"type":"string","required":true,"enum":["Today",""]}}>`, `<`]"} schema={{"type":"string","enum":["==",">","<"]}}>
    • ]
    Expected response to a valid request diff --git a/docs/api/nerm/v1/post-attribute-option.api.mdx b/docs/api/nerm/v1/post-attribute-option.api.mdx index 1a9936dc5..d7b9bcb7e 100644 --- a/docs/api/nerm/v1/post-attribute-option.api.mdx +++ b/docs/api/nerm/v1/post-attribute-option.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Add a value to an option based attribute

    @@ -32,7 +30,7 @@ Add a value to an option based attribute ## Request -

    Body

    required
      ne_attribute_option object
    +

    Body

    required
      ne_attribute_option object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/post-attribute-options.api.mdx b/docs/api/nerm/v1/post-attribute-options.api.mdx index 32fc167c5..e12e06429 100644 --- a/docs/api/nerm/v1/post-attribute-options.api.mdx +++ b/docs/api/nerm/v1/post-attribute-options.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create multiple new option based attribute values

    @@ -32,7 +30,7 @@ Create multiple new option based attribute values ## Request -

    Body

    required
      ne_attribute_options object[]
    • Array [
    • ]
    +

    Body

    required
      ne_attribute_options object[]
    • Array [
    • ]
    Expected response to a valid request diff --git a/docs/api/nerm/v1/post-profile-avatar.api.mdx b/docs/api/nerm/v1/post-profile-avatar.api.mdx index f16d74659..c7fdca8ba 100644 --- a/docs/api/nerm/v1/post-profile-avatar.api.mdx +++ b/docs/api/nerm/v1/post-profile-avatar.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Uploads a new profile avatar

    @@ -32,7 +30,7 @@ Uploads a new profile avatar ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    Expected response to a valid request diff --git a/docs/api/nerm/v1/post-profile-type.api.mdx b/docs/api/nerm/v1/post-profile-type.api.mdx index c9392e6bd..999b43fac 100644 --- a/docs/api/nerm/v1/post-profile-type.api.mdx +++ b/docs/api/nerm/v1/post-profile-type.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a profile type

    @@ -32,7 +30,7 @@ Create a profile type ## Request -

    Body

    required
      profile_type object
      profile_type_dup_attributes object[]
    • Array [
      • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"description":"The uid of the properties that are used for duplication protection.","example":"attribute-uid"}}>
    • ]
      • profile_type_namings object[]
    • Array [
      • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"description":"The UID of the profile type naming.","example":"profile-type-name"}}>
    • ]
    +

    Body

    required
      profile_type object
      profile_type_dup_attributes object[]
    • Array [
      • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"description":"The uid of the properties that are used for duplication protection.","example":"attribute-uid"}}>
    • ]
      • profile_type_namings object[]
    • Array [
      • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"description":"The UID of the profile type naming.","example":"profile-type-name"}}>
    • ]
    Expected response to a valid request diff --git a/docs/api/nerm/v1/post-profile-upload.api.mdx b/docs/api/nerm/v1/post-profile-upload.api.mdx index a82ef2b4b..643c599ef 100644 --- a/docs/api/nerm/v1/post-profile-upload.api.mdx +++ b/docs/api/nerm/v1/post-profile-upload.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Uploads a new attachment attribute value to a profile

    @@ -32,7 +30,7 @@ Uploads a new attachment attribute value to a profile ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    Expected response to a valid request diff --git a/docs/api/nerm/v1/post-profile.api.mdx b/docs/api/nerm/v1/post-profile.api.mdx index ed36d39b0..861219fe7 100644 --- a/docs/api/nerm/v1/post-profile.api.mdx +++ b/docs/api/nerm/v1/post-profile.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a profile

    @@ -32,7 +30,7 @@ Create a profile ## Request -

    Body

    required
      profile object
      attributes object
    +

    Body

    required
      profile object
      attributes object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/post-profiles.api.mdx b/docs/api/nerm/v1/post-profiles.api.mdx index 758a21cf6..61c9a80ea 100644 --- a/docs/api/nerm/v1/post-profiles.api.mdx +++ b/docs/api/nerm/v1/post-profiles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create multiple profiles

    @@ -32,7 +30,7 @@ Create multiple profiles ## Request -

    Body

    required
      profiles object[]
    • Array [
      • attributes object
    • ]
    +

    Body

    required
      profiles object[]
    • Array [
      • attributes object
    • ]
    Expected response to a valid request diff --git a/docs/api/nerm/v1/post-role-profile.api.mdx b/docs/api/nerm/v1/post-role-profile.api.mdx index c9978177f..dbe480c97 100644 --- a/docs/api/nerm/v1/post-role-profile.api.mdx +++ b/docs/api/nerm/v1/post-role-profile.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a role-profile contributor relationship

    @@ -32,7 +30,7 @@ Create a role-profile contributor relationship ## Request -

    Body

    required
      role_profile object
    +

    Body

    required
      role_profile object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/post-role-profiles.api.mdx b/docs/api/nerm/v1/post-role-profiles.api.mdx index 36290c799..54d58e093 100644 --- a/docs/api/nerm/v1/post-role-profiles.api.mdx +++ b/docs/api/nerm/v1/post-role-profiles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create multiple role-profile contributor relationships

    @@ -32,7 +30,7 @@ Create multiple role-profile contributor relationships ## Request -

    Body

    required
      role_profiles object[]
    • Array [
    • ]
    +

    Body

    required
      role_profiles object[]
    • Array [
    • ]
    Expected response to a valid request diff --git a/docs/api/nerm/v1/post-role.api.mdx b/docs/api/nerm/v1/post-role.api.mdx index 7dc1c8944..5f139a638 100644 --- a/docs/api/nerm/v1/post-role.api.mdx +++ b/docs/api/nerm/v1/post-role.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a new role

    @@ -32,7 +30,7 @@ Create a new role ## Request -

    Body

    required
      role object
      = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"example":"sponsors_role"}}>
    +

    Body

    required
      role object
      = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"example":"sponsors_role"}}>
    Expected response to a valid request diff --git a/docs/api/nerm/v1/post-roles.api.mdx b/docs/api/nerm/v1/post-roles.api.mdx index c2c794562..3535b837c 100644 --- a/docs/api/nerm/v1/post-roles.api.mdx +++ b/docs/api/nerm/v1/post-roles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create multiple new roles

    @@ -32,7 +30,7 @@ Create multiple new users ## Request -

    Body

    required
      roles object[]
    • Array [
      • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"example":"sponsors_role"}}>
    • ]
    +

    Body

    required
      roles object[]
    • Array [
      • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"example":"sponsors_role"}}>
    • ]
    Expected response to a valid request diff --git a/docs/api/nerm/v1/post-user-avatar.api.mdx b/docs/api/nerm/v1/post-user-avatar.api.mdx index 4f25f91e3..57ce91a8f 100644 --- a/docs/api/nerm/v1/post-user-avatar.api.mdx +++ b/docs/api/nerm/v1/post-user-avatar.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Uploads a new user avatar

    @@ -32,7 +30,7 @@ Uploads a new user avatar ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    Expected response to a valid request diff --git a/docs/api/nerm/v1/post-user-manager.api.mdx b/docs/api/nerm/v1/post-user-manager.api.mdx index 29b732e07..de5f28570 100644 --- a/docs/api/nerm/v1/post-user-manager.api.mdx +++ b/docs/api/nerm/v1/post-user-manager.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a new user-manager relationship

    @@ -32,7 +30,7 @@ Create a new user-manager relationship ## Request -

    Body

    required
      user_manager object
    +

    Body

    required
      user_manager object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/post-user-managers.api.mdx b/docs/api/nerm/v1/post-user-managers.api.mdx index 6b1356b47..51ef9f291 100644 --- a/docs/api/nerm/v1/post-user-managers.api.mdx +++ b/docs/api/nerm/v1/post-user-managers.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create multiple new user-manager relationships

    @@ -32,7 +30,7 @@ Create multiple new user-manager relationships ## Request -

    Body

    required
      user_managers object[]
    • Array [
    • ]
    +

    Body

    required
      user_managers object[]
    • Array [
    • ]
    Expected response to a valid request diff --git a/docs/api/nerm/v1/post-user-profile.api.mdx b/docs/api/nerm/v1/post-user-profile.api.mdx index 8043b805e..f7d332161 100644 --- a/docs/api/nerm/v1/post-user-profile.api.mdx +++ b/docs/api/nerm/v1/post-user-profile.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a user-profile contributor relationship

    @@ -32,7 +30,7 @@ Create a user-profile contributor relationship ## Request -

    Body

    required
      user_profile object
    +

    Body

    required
      user_profile object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/post-user-role.api.mdx b/docs/api/nerm/v1/post-user-role.api.mdx index 0267ffb0e..20e069647 100644 --- a/docs/api/nerm/v1/post-user-role.api.mdx +++ b/docs/api/nerm/v1/post-user-role.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Assign a new role to a user

    @@ -32,7 +30,7 @@ Assign a new role to a user ## Request -

    Body

    required
      user_role object
    +

    Body

    required
      user_role object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/post-user-roles.api.mdx b/docs/api/nerm/v1/post-user-roles.api.mdx index 00b0199b1..6c60d36cc 100644 --- a/docs/api/nerm/v1/post-user-roles.api.mdx +++ b/docs/api/nerm/v1/post-user-roles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create multiple new user role pairings

    @@ -32,7 +30,7 @@ Create multiple new user role pairings ## Request -

    Body

    required
      user_roles object[]
    • Array [
    • ]
    +

    Body

    required
      user_roles object[]
    • Array [
    • ]
    Expected response to a valid request diff --git a/docs/api/nerm/v1/post-user.api.mdx b/docs/api/nerm/v1/post-user.api.mdx index 9a77fa620..e0626464a 100644 --- a/docs/api/nerm/v1/post-user.api.mdx +++ b/docs/api/nerm/v1/post-user.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a new user

    @@ -32,11 +30,11 @@ Create a new user ## Request -

    Body

    required
      user object
    +

    Body

    required
      user object
    Expected response to a valid request -
    Schema
      user object
      = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readonly":true}}>
    +
    Schema
      user object
      = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readonly":true}}>
    Bad Request - unable to complete. diff --git a/docs/api/nerm/v1/post-users.api.mdx b/docs/api/nerm/v1/post-users.api.mdx index b6628c098..79b8693fa 100644 --- a/docs/api/nerm/v1/post-users.api.mdx +++ b/docs/api/nerm/v1/post-users.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create multiple new users

    @@ -32,7 +30,7 @@ Create multiple new users ## Request -

    Body

    required
      users object[]
    • Array [
    • ]
    +

    Body

    required
      users object[]
    • Array [
    • ]
    Expected response to a valid request diff --git a/docs/api/nerm/v1/post-workflow-session-upload.api.mdx b/docs/api/nerm/v1/post-workflow-session-upload.api.mdx index 9ae2b972a..8b77410d7 100644 --- a/docs/api/nerm/v1/post-workflow-session-upload.api.mdx +++ b/docs/api/nerm/v1/post-workflow-session-upload.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Uploads a new attachment attribute value to a workflow session

    @@ -32,7 +30,7 @@ Uploads a new attachment attribute value to a workflow session ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    Expected response to a valid request diff --git a/docs/api/nerm/v1/post-workflow-session.api.mdx b/docs/api/nerm/v1/post-workflow-session.api.mdx index 2814c9ddf..359e75aa4 100644 --- a/docs/api/nerm/v1/post-workflow-session.api.mdx +++ b/docs/api/nerm/v1/post-workflow-session.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a workflow session

    @@ -32,7 +30,7 @@ Create a workflow session ## Request -

    Query Parameters

    Body

    required
      workflow_session object
      attributes object
    +

    Query Parameters

    Body

    required
      workflow_session object
      attributes object
    Expected response to a valid request diff --git a/docs/api/nerm/v1/run-advanced-search.api.mdx b/docs/api/nerm/v1/run-advanced-search.api.mdx index a9f848a3f..e5bd8b574 100644 --- a/docs/api/nerm/v1/run-advanced-search.api.mdx +++ b/docs/api/nerm/v1/run-advanced-search.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Run an advanced search for profiles, without saving the query

    @@ -32,7 +30,7 @@ Run an advanced search for profiles, without saving the query ## Request -

    Query Parameters

    Body

    required
      advanced_search object
      condition_rules_attributes object[]
    • Array [
      • anyOf`, `<`, `start_with?`, `end_with?`, `include?`]"} schema={{"type":"string","required":true,"enum":["==","!=",">","<","start_with?","end_with?","include?"]}}>`, `<`, `after`, `before`]"} schema={{"type":"string","enum":[">","<","after","before"]}}>`]"} schema={{"type":"string","required":true,"enum":["Today",""]}}>`, `<`]"} schema={{"type":"string","enum":["==",">","<"]}}>
    • ]
    +

    Query Parameters

    Body

    required
      advanced_search object
      condition_rules_attributes object[]
    • Array [
      • anyOf`, `<`, `start_with?`, `end_with?`, `include?`]"} schema={{"type":"string","required":true,"enum":["==","!=",">","<","start_with?","end_with?","include?"]}}>`, `<`, `after`, `before`]"} schema={{"type":"string","enum":[">","<","after","before"]}}>`]"} schema={{"type":"string","required":true,"enum":["Today",""]}}>`, `<`]"} schema={{"type":"string","enum":["==",">","<"]}}>
    • ]
    Expected response to a valid request diff --git a/docs/api/nerm/v1/run-advanced-searchby-id.api.mdx b/docs/api/nerm/v1/run-advanced-searchby-id.api.mdx index 7cdc1dcc5..34780a2bd 100644 --- a/docs/api/nerm/v1/run-advanced-searchby-id.api.mdx +++ b/docs/api/nerm/v1/run-advanced-searchby-id.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Run a saved advanced search query

    @@ -32,7 +30,7 @@ Run a saved advanced search query ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Expected response to a valid request diff --git a/docs/api/non-employee.md b/docs/api/non-employee.md new file mode 100644 index 000000000..307bda5bd --- /dev/null +++ b/docs/api/non-employee.md @@ -0,0 +1,31 @@ +--- +id: non-employee +title: NERM API Specifications +pagination_label: NERM API Specifications +sidebar_label: NERM API Specifications +sidebar_position: 1 +sidebar_class_name: nermApiSpecifications +keywords: ['api', 'specifications'] +description: NERM API specifications. +slug: /api/nerm +tags: ['API Specifications'] +--- + +## Overview + +[Non-Employee Risk Management (NERM)](https://documentation.sailpoint.com/ne-admin/help/) is an add-on to Identity Security Cloud (ISC) that helps organizations track non-employees such as contractors, partners, and vendors, and their lifecycles within the organization. + +The Non-Employee Risk Management (NERM) APIs provide developers with a way to interact with the NERM add-on and extend it. Developers can leverage these APIs to customize their platform experiences and build new solutions and integrations that meet their needs. + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + +## Discuss + +The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions. + +To learn more about the NERM APIs and discuss them with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/tag/nerm). \ No newline at end of file diff --git a/products/idn/api/patch-requests.md b/docs/api/patch-requests.md similarity index 86% rename from products/idn/api/patch-requests.md rename to docs/api/patch-requests.md index db5f3b1f9..ecef7b668 100644 --- a/products/idn/api/patch-requests.md +++ b/docs/api/patch-requests.md @@ -6,17 +6,17 @@ sidebar_label: Patch Requests sidebar_position: 8 sidebar_class_name: patchRequests keywords: ['patch'] -description: Read this guide to learn how to send PATCH requests to SailPoint's IdentityNow APIs. +description: Send PATCH ISC API requests. tags: ['patch', 'guide'] --- ## PATCH requests -You can use the IdentityNow APIs to update existing resources. Many of the APIs offer multiple ways to do so: +You can use the Identity Security Cloud APIs to update existing resources. Many of the APIs offer multiple ways to do so: -- You can send a **PUT** request to replace the existing resource with a new one. For example, if you wanted to update one of John Doe's source accounts, you could use the [Put Account](https://developer.sailpoint.com/idn/api/v3/put-account) endpoint to replace John Doe's existing source account with a new one. This is a viable way to update a resource, but it requires you to update the entire resource each time. +- You can send a **PUT** request to replace the existing resource with a new one. For example, if you wanted to update one of John Doe's source accounts, you could use the [Put Account](https://developer.sailpoint.com/docs/api/v3/put-account) endpoint to replace John Doe's existing source account with a new one. This is a viable way to update a resource, but it requires you to update the entire resource each time. -- You can send a **PATCH** request to make a specific change to the resource. For example, if you wanted to update John Doe's account's associated "city" attribute, you could use the [Patch Account](https://developer.sailpoint.com/idn/api/v3/update-account) endpoint to replace his existing "city" with a new one, all without affecting any of the other source account details. This can be very helpful when you want to make specific updates to resources, but it requires some knowledge of the types of changes, or "operations", that are possible, the specific paths of the fields you want to update, and some understanding of the basic data types. +- You can send a **PATCH** request to make a specific change to the resource. For example, if you wanted to update John Doe's account's associated "city" attribute, you could use the [Patch Account](https://developer.sailpoint.com/docs/api/v3/update-account) endpoint to replace his existing "city" with a new one, all without affecting any of the other source account details. This can be very helpful when you want to make specific updates to resources, but it requires some knowledge of the types of changes, or "operations", that are possible, the specific paths of the fields you want to update, and some understanding of the basic data types. This guide will focus on the partial update method, PATCH requests. Read this guide to learn how to start sending PATCH requests. @@ -24,17 +24,17 @@ This guide will focus on the partial update method, PATCH requests. Read this gu To use PATCH to update a resource, you first need to know the resource ID. -Not all resource IDs are available in the IdentityNow UI, so you may need to use the API to find the ID for the resource you want to update. +Not all resource IDs are available in the Identity Security Cloud UI, so you may need to use the API to find the ID for the resource you want to update. -For example, account IDs aren't avilable in the IdentityNow UI. If you want to use the [Patch Account](https://developer.sailpoint.com/idn/api/v3/update-account) endpoint to make a change to a specific account, you first need to find out the account's ID. +For example, account IDs aren't avilable in the Identity Security Cloud UI. If you want to use the [Patch Account](https://developer.sailpoint.com/docs/api/v3/update-account) endpoint to make a change to a specific account, you first need to find out the account's ID. -You can use the [List Accounts](https://developer.sailpoint.com/idn/api/v3/list-accounts) endpoint to view all the accounts in your tenant, along with their details, such as their identities. You can find your account and its ID in this list. +You can use the [List Accounts](https://developer.sailpoint.com/docs/api/v3/list-accounts) endpoint to view all the accounts in your tenant, along with their details, such as their identities. You can find your account and its ID in this list. ## Get the resource details Once you know the resource ID, you can use a GET request to get that resource's details. To successfully use a PATCH request to make changes to a resource, you need to know which paths you can update, what values they have, and the structure of those paths. -For example, once you know the ID for the source you want to update with a PATCH request, you can use the [Get Source by ID](https://developer.sailpoint.com/idn/api/v3/get-source) endpoint to view only that source and its details. +For example, once you know the ID for the source you want to update with a PATCH request, you can use the [Get Source by ID](https://developer.sailpoint.com/docs/api/v3/get-source) endpoint to view only that source and its details. In this example, the API returns a source, "ubuntu", along with all its details. This JSON response shows the resource's structure and its different paths: @@ -181,7 +181,7 @@ PATCH https://{tenant}.api.identitynow.com/v3/sources/:id This example request uses a "replace" operation to replace the source's existing description with a new value, "new description". This example shows the parts involved in sending a PATCH request. You must specify an operation to apply to the target resource, a path to apply the operation to, and the change you want to make, often in the form of a value or a "from" location for "copy" and "move" operations. -You can find this example in the [Patch Source](https://developer.sailpoint.com/idn/api/v3/update-source) specification. The API specifications have examples on the right side of the page that you can copy and use to get started. You can tab between the different examples to see a variety of pre-built requests you can use. +You can find this example in the [Patch Source](https://developer.sailpoint.com/docs/api/v3/update-source) specification. The API specifications have examples on the right side of the page that you can copy and use to get started. You can tab between the different examples to see a variety of pre-built requests you can use. A PATCH request can be more complex as well - the values can be simple or vast and detailed. You can use a PATCH request to apply multiple operations, with a path for each, or you can apply the same type of operation to multiple paths. The PATCH request will always have the same essential structure though. @@ -239,7 +239,7 @@ These are the available PATCH operations: The "add" operation adds a value to the target location. For more information about the "add" operation and how it behaves in different scenarios, refer to the [JSON PATCH documentation](https://datatracker.ietf.org/doc/html/rfc6902). -This example uses the [Patch Source Schema](https://developer.sailpoint.com/idn/api/v3/update-source-schema) endpoint to add a new "office" attribute to the end of a source schema's array of attributes: +This example uses the [Patch Source Schema](https://developer.sailpoint.com/docs/api/v3/update-source-schema) endpoint to add a new "office" attribute to the end of a source schema's array of attributes: ```json [ @@ -268,7 +268,7 @@ You can use "0" to add a value to the beginning of the array. You can use "1" to The "remove" operation removes a value from the target location. The target location must exist for the operation to be successful. -This example uses the [Patch Source](https://developer.sailpoint.com/idn/api/v3/update-source) endpoint to remove an existing filter string from a source's connector: +This example uses the [Patch Source](https://developer.sailpoint.com/docs/api/v3/update-source) endpoint to remove an existing filter string from a source's connector: ```json [ @@ -285,7 +285,7 @@ This example uses the [Patch Source](https://developer.sailpoint.com/idn/api/v3/ If there is an array of values, you must specify the position within the array to remove that value. -This example uses the [Patch Source](https://developer.sailpoint.com/idn/api/v3/update-source) endpoint to remove the first feature from a source's list of features. +This example uses the [Patch Source](https://developer.sailpoint.com/docs/api/v3/update-source) endpoint to remove the first feature from a source's list of features. The source has three features, "ENABLE", "PROVISIONING", AND "UNLOCK". @@ -304,7 +304,7 @@ This request will remove the the first value from the list, "ENABLE". The "replace" operation replaces the value at the target location with a new value. The operation object must contain a "value" member whose content specifies the replacement value, and the target location must exist for the operation to be successful. This operation is the equivalent of a "remove" followed by an "add". -This example uses the [Patch Source](https://developer.sailpoint.com/idn/api/v3/update-source) endpoint to replace a source's existing features with new ones: +This example uses the [Patch Source](https://developer.sailpoint.com/docs/api/v3/update-source) endpoint to replace a source's existing features with new ones: ```json [ @@ -322,7 +322,7 @@ This example uses the [Patch Source](https://developer.sailpoint.com/idn/api/v3/ ] ``` -You can also replace a value within an array. This example uses the [Patch Source](https://developer.sailpoint.com/idn/api/v3/update-source) endpoint to replace the first value in the array with the specified value: +You can also replace a value within an array. This example uses the [Patch Source](https://developer.sailpoint.com/docs/api/v3/update-source) endpoint to replace the first value in the array with the specified value: ```json [ @@ -340,7 +340,7 @@ This request removes the first feature ("PASSWORD") in the list and adds the "CU The "move" operation removes the operation from a specified location and adds it to the target location. This operation object must contain a "from" member whose content specifies the location to remove the value from, and the "from" location must exist for the operation to be successful. -This example uses the [Patch Source Schema](https://developer.sailpoint.com/idn/api/v3/update-source-schema) endpoint to move an attribute from the beginning to the end of the schema's array of attributes: +This example uses the [Patch Source Schema](https://developer.sailpoint.com/docs/api/v3/update-source-schema) endpoint to move an attribute from the beginning to the end of the schema's array of attributes: ```json [ @@ -356,7 +356,7 @@ This example uses the [Patch Source Schema](https://developer.sailpoint.com/idn/ The "copy" operation copies the value from a specified location to the target location. The operation object must contain a "from" member whose content specifies the location to copy the value from, and the "from" location must exist for the operation to be successful. -This example uses the [Patch Source Schema](https://developer.sailpoint.com/idn/api/v3/update-source-schema) endpoint to copies an attribute from the beginning and duplicates it at the end of the schema's array of attributes: +This example uses the [Patch Source Schema](https://developer.sailpoint.com/docs/api/v3/update-source-schema) endpoint to copies an attribute from the beginning and duplicates it at the end of the schema's array of attributes: ```json [ @@ -374,7 +374,7 @@ The "test" operation is unique in that it does not apply changes to the resource The "test" operation allows you to check that a resource has the values you expect it to have, and then you can make changes to those values from there with another PATCH request. -This example uses the [Patch Source](https://developer.sailpoint.com/idn/api/v3/update-source) endpoint to test a source's existing features to make sure they match the specified values.: +This example uses the [Patch Source](https://developer.sailpoint.com/docs/api/v3/update-source) endpoint to test a source's existing features to make sure they match the specified values.: ```json [ @@ -455,7 +455,7 @@ PATCH https://{tenant}.api.identitynow.com/v3/sources/:id ] ``` -However, you cannot make changes to all paths. Use the API specifications for the PATCH endpoint you want to use to find out which paths you can make changes to. The API specifications will list the paths, or fields, that are immutable, if there are any. For example, the [Patch Source](https://developer.sailpoint.com/idn/api/v3/update-source) specification lists paths like `id` and `type` as being immutable. Trying to use modify these paths results in a 400 error. +However, you cannot make changes to all paths. Use the API specifications for the PATCH endpoint you want to use to find out which paths you can make changes to. The API specifications will list the paths, or fields, that are immutable, if there are any. For example, the [Patch Source](https://developer.sailpoint.com/docs/api/v3/update-source) specification lists paths like `id` and `type` as being immutable. Trying to use modify these paths results in a 400 error. The paths are often nested within other paths, like within the "connectorAttributes" path from the earlier example source's details: @@ -616,7 +616,7 @@ PATCH https://{tenant}.api.identitynow.com//v3/sources/:sourceId/schemas/:schema ] ``` -This request uses the [PATCH Source Schema](https://developer.sailpoint.com/idn/api/v3/update-source-schema) endpoint to add a new attribute, along with its details, to the end of the array of a source's schema's attributes. +This request uses the [PATCH Source Schema](https://developer.sailpoint.com/docs/api/v3/update-source-schema) endpoint to add a new attribute, along with its details, to the end of the array of a source's schema's attributes. This example uses the "-" after the path to indicate that the value will be added to the end of the array. When you are adding a new value to an array of values, you can specify the position within the array where you want to add the new value. In this example, using the "-" expression at the end of the path specifies that the new attribute will be added to the end of the array of attributes. @@ -626,7 +626,7 @@ You can use "0" to add a value to the beginning of the array. You can use "1" to The "move" and "copy" operations allow you to remove or copy information from one path and add it to another path without your needing to specify the value, which could be an extensive array of information. To use the "move" and "copy" operations, you must specify a "from", a JSON Pointer representing the location you are moving or copying the value from. -This example request uses the [PATCH Source schema](https://developer.sailpoint.com/idn/api/v3/update-source-schema) endpoint to move an attribute, along with its details, from the beginning to the end of a source schema's array of attributes: +This example request uses the [PATCH Source schema](https://developer.sailpoint.com/docs/api/v3/update-source-schema) endpoint to move an attribute, along with its details, from the beginning to the end of a source schema's array of attributes: ```text PATCH https://{tenant}.api.identitynow.com//v3/sources/:sourceId/schemas/:schemaId @@ -660,6 +660,6 @@ When the request is successful, the API will return the updated resource. ## Get started -Now you can use PATCH requests partially update resources. For more information about PATCH requests, refer to this [documentation](https://datatracker.ietf.org/doc/html/rfc6902). For more information about the IdentityNow PATCH endpoints and which paths can be changed for each one, refer to their API specifications. +Now you can use PATCH requests partially update resources. For more information about PATCH requests, refer to this [documentation](https://datatracker.ietf.org/doc/html/rfc6902). For more information about the Identity Security Cloud PATCH endpoints and which paths can be changed for each one, refer to their API specifications. Use this guide to get started, and if you have questions, don't hesitate to reach out on the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss! \ No newline at end of file diff --git a/products/idn/api/postman-collections.md b/docs/api/postman-collections.md similarity index 58% rename from products/idn/api/postman-collections.md rename to docs/api/postman-collections.md index 02e8a093c..1e22d2efb 100644 --- a/products/idn/api/postman-collections.md +++ b/docs/api/postman-collections.md @@ -6,36 +6,35 @@ sidebar_label: Postman Collections sidebar_position: 7 sidebar_class_name: postmanCollections keywords: ['postman'] -description: How to run the APIs in Postman. +description: Run ISC APIs in Postman. tags: ['postman'] --- import GitHubPublicFileComponent from '@site/src/components/GitHubLink'; -[Postman](https://www.postman.com/) is a platform you can use to design, build, test, and iterate your APIs. Postman users and teams can create public workspaces they can use to make it easy to access their API collections and environments and get started. SailPoint maintains a [public workspace for the IdentityNow API collections](https://www.postman.com/sailpoint/workspace/identitynow). You can use this workspace to access all the IDN API collections and stay up to date. +[Postman](https://www.postman.com/) is a platform you can use to design, build, test, and iterate your APIs. Postman users and teams can create public workspaces they can use to make it easy to access their API collections and environments and get started. SailPoint maintains a [public workspace for the Identity Security Cloud API collections](https://www.postman.com/sailpoint/workspace/identitynow). You can use this workspace to access all the ISC API collections and stay up to date. ## Run in Postman -Each IDN API version is broken out into a separate collection within the workspace. The following table lists the available IDN API collections. To import a collection into your workspace, select the 'Run in Postman' button for your desired version. Doing so forks the collection into your workspace. +Each ISC API version is broken out into a separate collection within the workspace. The following table lists the available ISC API collections. To import a collection into your workspace, select the 'Run in Postman' button for your desired version. Doing so forks the collection into your workspace. | API | Postman Collection | |------|----------------------------| -| V3 API | | -| Beta API | | -| V2 API | | -| cc/private API | | +| V3 API | [![Run in Postman](./img/button.svg)](https://god.gw.postman.com/run-collection/23226990-3721beea-5615-44b4-9459-e858a0ca7aed?action=collection%2Ffork&collection-url=entityId%3D23226990-3721beea-5615-44b4-9459-e858a0ca7aed%26entityType%3Dcollection%26workspaceId%3D80af54be-a333-4712-af5e-41aa9eccbdd0) | +| Beta API | [![Run in Postman](./img/button.svg)](https://god.gw.postman.com/run-collection/23226990-3b87172a-cd55-40a2-9ace-1560a1158a4e?action=collection%2Ffork&collection-url=entityId%3D23226990-3b87172a-cd55-40a2-9ace-1560a1158a4e%26entityType%3Dcollection%26workspaceId%3D80af54be-a333-4712-af5e-41aa9eccbdd0) | +| NERM API | [![Run in Postman](./img/button.svg)](https://god.gw.postman.com/run-collection/23226990-20d718e3-b9b3-43ad-850c-637b00864ae2?action=collection%2Ffork&collection-url=entityId%3D23226990-20d718e3-b9b3-43ad-850c-637b00864ae2%26entityType%3Dcollection%26workspaceId%3D80af54be-a333-4712-af5e-41aa9eccbdd0) | | SaaS Connectivity | [![Run in Postman](./img/button.svg)](https://god.gw.postman.com/run-collection/23226990-a0b5c429-d8dd-4fe2-a4a2-eb7ff85322ef?action=collection%2Ffork&collection-url=entityId%3D23226990-a0b5c429-d8dd-4fe2-a4a2-eb7ff85322ef%26entityType%3Dcollection%26workspaceId%3D80af54be-a333-4712-af5e-41aa9eccbdd0) | You can also fork a collection by selecting the ellipses to the right of the collection and selecting 'Create a fork.' -When you fork the collection, even if you check the 'Watch original collection' checkbox to get notifications when there are changes to the collection because of limitations of Postman, to get the most recent version of changes to the collection, you will need to click the link to fork the most up to date collection. +When you fork the collection, when you check the 'Watch original collection' checkbox to get notifications when there are changes to the collection, you will be notified by email whenever a collection changes. ## Update your collections -SailPoint is often making improvements to the IDN API collections. To keep your workspace in sync with updates to one of SailPoint's public collections, you will need to visit the [sailpoint workspace](https://www.postman.com/sailpoint/workspace/identitynow) and create a fork of the most recently published version or click the links above to fork the most recent version. +SailPoint is often making improvements to the ISC API collections. To keep your workspace in sync with updates to one of SailPoint's public collections, you can right click on the forked collection and select "pull changes". sometimes this process will fail because of the size of our collection and limitations of the Postman tool. In that case, in order to update, you will need to visit the [sailpoint workspace](https://www.postman.com/sailpoint/workspace/identitynow) and create a fork of the most recently published version or click the links above to fork the most recent version. ## Configure your environment @@ -48,7 +47,7 @@ To send API requests in Postman, you must authenticate to the APIs. To authentic | Environment Variable | Required | Description | | ----------- | ----------- | ----------- | -| tenant | Yes | Your IDN tenant, typically your company's name | +| tenant | Yes | Your ISC tenant, typically your company's name | | clientId | Yes | The client ID for the API client or personal access token | | clientSecret | Yes | The client secret for the API client or personal access token | | domain | No | This optional field is only necessary for those who have a domain in their API URL that isn't "identitynow". | diff --git a/products/idn/api/rate-limit.md b/docs/api/rate-limit.md similarity index 80% rename from products/idn/api/rate-limit.md rename to docs/api/rate-limit.md index dbcabdff8..3070c8a73 100644 --- a/products/idn/api/rate-limit.md +++ b/docs/api/rate-limit.md @@ -6,7 +6,7 @@ sidebar_label: Rate Limiting sidebar_position: 6 sidebar_class_name: rateLimit keywords: ['rate limit'] -description: There is a rate limit of 100 requests per access_token per 10 seconds for V3 API calls through the API gateway. +description: ISC API rate limits. tags: ['Rate Limit'] --- diff --git a/products/idn/api/standard-collection-parameters.md b/docs/api/standard-collection-parameters.md similarity index 93% rename from products/idn/api/standard-collection-parameters.md rename to docs/api/standard-collection-parameters.md index 9d4b29d87..6c809e2f7 100644 --- a/products/idn/api/standard-collection-parameters.md +++ b/docs/api/standard-collection-parameters.md @@ -6,11 +6,11 @@ sidebar_label: Standard Collection Parameters sidebar_position: 5 sidebar_class_name: standardCollectionParameters keywords: ['standard collection parameters'] -description: Many endpoints in the IdentityNow API support a generic syntax for paginating, filtering and sorting the results. +description: ISC API pagination, filtering, and sorting. tags: ['Standard Collection Parameters'] --- -Many endpoints in the IdentityNow API support a generic syntax for paginating, filtering and sorting the results. A collection endpoint has the following characteristics: +Many endpoints in the Identity Security Cloud API support a generic syntax for paginating, filtering and sorting the results. A collection endpoint has the following characteristics: - The HTTP verb is always GET. - The last component in the URL is a plural noun (ex. `/v3/public-identities`). @@ -22,7 +22,7 @@ Use the following optional query parameters to achieve pagination: | Name | Description | Default | Constraints | | --- | --- | --- | --- | -| `limit` | Integer specifying the maximum number of records to return in a single API call. If it is not specified, a default limit is used. | `250` | Maxiumum of 250 records per page | +| `limit` | Integer specifying the maximum number of records to return in a single API call. If it is not specified, a default limit is used. | `250` for list endpoints, `10000` for search endpoint | Maxiumum of 250 records per page for list endpoints, 10000 records per page for the [Search endpoint](https://developer.sailpoint.com/docs/api/v3/search) | | `offset` | Integer specifying the offset of the first result from the beginning of the collection. The **offset** value is record-based, not page-based, and the index starts at 0. For example, **offset=0** and **limit=20** returns records 0-19, but **offset=1** and **limit=20** returns records 1-20. | `0` | Between 0 and the last record index. | | `count` | Boolean indicating whether a total count is returned, factoring in any filter parameters, in the **X-Total-Count** response header. The value is the total size of the collection that would be returned if **limit** and **offset** were ignored. For example, if the total number of records is 1000, then count=true would return 1000 in the **X-Total-Count** header. Because requesting a total count can have performance impact, do not send **count=true** if that value is not being used. | `false` | Must be `true` or `false` | @@ -34,7 +34,7 @@ Examples: ## Paginating Search Queries -The [search API](https://developer.sailpoint.com/idn/api/v3/search) in IdentityNow leverages [Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro.html) functionality, which returns a maximum of 10,000 records by default. However, you can page more than 10,000 records by using the "searchAfter" property. +The [search API](https://developer.sailpoint.com/docs/api/v3/search) in Identity Security Cloud leverages [Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro.html) functionality, which returns a maximum of 10,000 records by default. However, you can page more than 10,000 records by using the "searchAfter" property. The `searchAfter` capability provides the ability to page on sorted field values, instead of offset paging. For example, if you sort by ID and page 100 records at a time, you can take the 1st page of 100 records, pass the last ID from that record set into your next search, and the next search will return the next 100 records after that ID. You continue that pattern of using the last value passed into `searchAfter` until the end of the result set. This allows you to page past the 10,000 record limit until you reach the final record. diff --git a/docs/api/v3/approve-access-request.api.mdx b/docs/api/v3/approve-access-request.api.mdx index ee7150713..587720155 100644 --- a/docs/api/v3/approve-access-request.api.mdx +++ b/docs/api/v3/approve-access-request.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Approves an access request approval.

    @@ -40,7 +38,7 @@ Reviewer's comment. Author of the comment -
    +
    Accepted - Returned if the request was successfully accepted into the system. @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -88,7 +86,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -104,4 +102,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/approve-approval-item.api.mdx b/docs/api/v3/approve-approval-item.api.mdx index ae648d247..ab295009d 100644 --- a/docs/api/v3/approve-approval-item.api.mdx +++ b/docs/api/v3/approve-approval-item.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Approve an Approval Item

    @@ -32,7 +30,7 @@ This API approves an Approval Item. Either an admin, or the owning/current user ## Request -

    Path Parameters

    +

    Path Parameters

    A work items details object. @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -88,7 +86,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -104,4 +102,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/approve-approval-items-in-bulk.api.mdx b/docs/api/v3/approve-approval-items-in-bulk.api.mdx index 943039c0c..0408073af 100644 --- a/docs/api/v3/approve-approval-items-in-bulk.api.mdx +++ b/docs/api/v3/approve-approval-items-in-bulk.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Bulk approve Approval Items

    @@ -32,7 +30,7 @@ This API bulk approves Approval Items. Either an admin, or the owning/current us ## Request -

    Path Parameters

    +

    Path Parameters

    A work items details object. @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -88,7 +86,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -104,4 +102,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/approve-non-employee-request.api.mdx b/docs/api/v3/approve-non-employee-request.api.mdx index 1d27ccc94..2720087eb 100644 --- a/docs/api/v3/approve-non-employee-request.api.mdx +++ b/docs/api/v3/approve-non-employee-request.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Approve a Non-Employee Request

    @@ -32,7 +30,7 @@ Approves a non-employee approval request and notifies the next approver. The cur ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    Non-Employee approval item object. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/cancel-access-request.api.mdx b/docs/api/v3/cancel-access-request.api.mdx index 949f66a05..c69f0e7d9 100644 --- a/docs/api/v3/cancel-access-request.api.mdx +++ b/docs/api/v3/cancel-access-request.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Cancel Access Request

    @@ -33,7 +31,7 @@ Any token with ORG_ADMIN authority or token of the user who originally requested ## Request -

    Body

    required
    +

    Body

    required
    Accepted - Returned if the request was successfully accepted into the system. @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -81,7 +79,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -97,4 +95,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/cancel-report.api.mdx b/docs/api/v3/cancel-report.api.mdx index ae8955cae..d56f5126a 100644 --- a/docs/api/v3/cancel-report.api.mdx +++ b/docs/api/v3/cancel-report.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Cancel Report

    @@ -32,7 +30,7 @@ Cancels a running report. ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/complete-campaign.api.mdx b/docs/api/v3/complete-campaign.api.mdx index 550acacf9..7611e85b8 100644 --- a/docs/api/v3/complete-campaign.api.mdx +++ b/docs/api/v3/complete-campaign.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Complete a Campaign

    @@ -48,7 +46,7 @@ Requires roles of CERT_ADMIN and ORG_ADMIN Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE -
    +
    Accepted - Returned if the request was successfully accepted into the system. @@ -84,7 +82,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -96,7 +94,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -112,4 +110,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/complete-work-item.api.mdx b/docs/api/v3/complete-work-item.api.mdx index 2dc602a2b..2501dce44 100644 --- a/docs/api/v3/complete-work-item.api.mdx +++ b/docs/api/v3/complete-work-item.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Complete a Work Item

    @@ -32,7 +30,7 @@ This API completes a work item. Either an admin, or the owning/current user must ## Request -

    Path Parameters

    +

    Path Parameters

    A WorkItems object @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -88,7 +86,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -104,4 +102,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/create-access-profile.api.mdx b/docs/api/v3/create-access-profile.api.mdx index a2e75ca5b..9361dd14a 100644 --- a/docs/api/v3/create-access-profile.api.mdx +++ b/docs/api/v3/create-access-profile.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create an Access Profile

    @@ -70,7 +68,7 @@ Array of child criteria. Required if the operation is AND or OR, otherwise it mu Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. -
  • Array [
  • ]
  • ]
    • +
  • Array [
  • ]
  • ]
    • Access Profile created @@ -138,7 +136,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -154,4 +152,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/create-access-request.api.mdx b/docs/api/v3/create-access-request.api.mdx index 2762203bd..7afa130c8 100644 --- a/docs/api/v3/create-access-request.api.mdx +++ b/docs/api/v3/create-access-request.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Submit an Access Request

    @@ -76,7 +74,7 @@ Arbitrary key-value pairs. They will never be processed by the IdentityNow syste Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. -
    +
    Accepted - Returned if the request was successfully accepted into the system. @@ -112,7 +110,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -128,4 +126,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/create-account.api.mdx b/docs/api/v3/create-account.api.mdx index e0a42557d..9bed75a06 100644 --- a/docs/api/v3/create-account.api.mdx +++ b/docs/api/v3/create-account.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create Account

    @@ -39,7 +37,7 @@ A token with ORG_ADMIN authority is required to call this API. The schema attribute values for the account -
    +
    Async task details @@ -71,7 +69,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -87,4 +85,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/create-auth-org-network-config.api.mdx b/docs/api/v3/create-auth-org-network-config.api.mdx index 29c99b32e..4bb43db2e 100644 --- a/docs/api/v3/create-auth-org-network-config.api.mdx +++ b/docs/api/v3/create-auth-org-network-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create security network configuration.

    @@ -40,7 +38,7 @@ ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. -
    +
    Network configuration for the tenant. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -84,7 +82,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -100,4 +98,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/create-branding-item.api.mdx b/docs/api/v3/create-branding-item.api.mdx index 9b55c0d71..3e964282a 100644 --- a/docs/api/v3/create-branding-item.api.mdx +++ b/docs/api/v3/create-branding-item.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a branding item

    @@ -33,7 +31,7 @@ A token with API, ORG_ADMIN authority is required to call this API. ## Request -

    Body

    required
    +

    Body

    required
    Branding item created @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -81,4 +79,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/create-campaign-filter.api.mdx b/docs/api/v3/create-campaign-filter.api.mdx index 937bb038c..5ffb4a9de 100644 --- a/docs/api/v3/create-campaign-filter.api.mdx +++ b/docs/api/v3/create-campaign-filter.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a Campaign Filter

    @@ -36,7 +34,7 @@ Create a campaign Filter based on filter details and criteria. List of criteria. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Created successfully. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -88,4 +86,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/create-campaign-template.api.mdx b/docs/api/v3/create-campaign-template.api.mdx index f896ceaa9..bd530fe0e 100644 --- a/docs/api/v3/create-campaign-template.api.mdx +++ b/docs/api/v3/create-campaign-template.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a Campaign Template

    @@ -80,7 +78,7 @@ This determines who remediation tasks will be assigned to. Remediation tasks are A list of sources in the campaign that contain \"orphan entitlements\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Created successfully. @@ -160,7 +158,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -176,4 +174,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/create-campaign.api.mdx b/docs/api/v3/create-campaign.api.mdx index fe32dda13..2f8166e1d 100644 --- a/docs/api/v3/create-campaign.api.mdx +++ b/docs/api/v3/create-campaign.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a campaign

    @@ -76,7 +74,7 @@ This determines who remediation tasks will be assigned to. Remediation tasks are A list of sources in the campaign that contain \"orphan entitlements\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Indicates that the campaign requested was successfully created and returns its representation. @@ -152,7 +150,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -168,4 +166,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/create-custom-connector.api.mdx b/docs/api/v3/create-custom-connector.api.mdx index 3ec130201..9d765a6e2 100644 --- a/docs/api/v3/create-custom-connector.api.mdx +++ b/docs/api/v3/create-custom-connector.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create custom connector

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Body

    required
    +

    Body

    required
    A Connector Dto object @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -81,7 +79,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -97,4 +95,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/create-lifecycle-state.api.mdx b/docs/api/v3/create-lifecycle-state.api.mdx index 3c1ca561b..818d435f2 100644 --- a/docs/api/v3/create-lifecycle-state.api.mdx +++ b/docs/api/v3/create-lifecycle-state.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create Lifecycle State

    @@ -41,7 +39,7 @@ Lifecycle State This is used for representing email configuration for a lifecycle state -
    accountActions object[]
  • Array [
  • ]
    • +
    accountActions object[]
  • Array [
  • ]
    • Created LifecycleState object. @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/create-non-employee-record.api.mdx b/docs/api/v3/create-non-employee-record.api.mdx index 569c0add1..4ceec5bf9 100644 --- a/docs/api/v3/create-non-employee-record.api.mdx +++ b/docs/api/v3/create-non-employee-record.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create Non-Employee Record

    @@ -41,7 +39,7 @@ Non-Employee record creation request body. Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported. -
    +
    Created non-employee record. @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/create-non-employee-request.api.mdx b/docs/api/v3/create-non-employee-request.api.mdx index 2c926d167..3348f467c 100644 --- a/docs/api/v3/create-non-employee-request.api.mdx +++ b/docs/api/v3/create-non-employee-request.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create Non-Employee Request

    @@ -40,7 +38,7 @@ Non-Employee creation request body Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported. -
    +
    Non-Employee request creation object @@ -84,7 +82,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -100,4 +98,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/create-non-employee-source-schema-attributes.api.mdx b/docs/api/v3/create-non-employee-source-schema-attributes.api.mdx index b7a405287..98d89a46c 100644 --- a/docs/api/v3/create-non-employee-source-schema-attributes.api.mdx +++ b/docs/api/v3/create-non-employee-source-schema-attributes.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a new Schema Attribute for Non-Employee Source

    @@ -33,7 +31,7 @@ Requires role context of `idn:nesr:create` ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    Schema Attribute created. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -81,4 +79,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/create-non-employee-source.api.mdx b/docs/api/v3/create-non-employee-source.api.mdx index ba0731f8d..f89ccbfe1 100644 --- a/docs/api/v3/create-non-employee-source.api.mdx +++ b/docs/api/v3/create-non-employee-source.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create Non-Employee Source

    @@ -56,7 +54,7 @@ List of approvers. List of account managers. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Created non-employee source. @@ -96,7 +94,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -112,4 +110,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/create-oauth-client.api.mdx b/docs/api/v3/create-oauth-client.api.mdx index 2835b9a48..cb65a8845 100644 --- a/docs/api/v3/create-oauth-client.api.mdx +++ b/docs/api/v3/create-oauth-client.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create OAuth Client

    @@ -32,7 +30,7 @@ This creates an OAuth client. ## Request -

    Body

    required
    +

    Body

    required
    Request succeeded. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/create-password-org-config.api.mdx b/docs/api/v3/create-password-org-config.api.mdx index be98d2c2c..007084394 100644 --- a/docs/api/v3/create-password-org-config.api.mdx +++ b/docs/api/v3/create-password-org-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create Password Org Config

    @@ -34,7 +32,7 @@ Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config: ## Request -

    Body

    required
      = 1` and `<= 60`"} schema={{"type":"integer","format":"int32","description":"The duration of \"digit token\" in minutes. The default value is 5.","minimum":1,"maximum":60,"default":5,"example":10}}>= 6` and `<= 18`"} schema={{"type":"integer","format":"int32","description":"The length of \"digit token\". The default value is 6.","minimum":6,"maximum":18,"default":6,"example":9}}>
    +

    Body

    required
      = 1` and `<= 60`"} schema={{"type":"integer","format":"int32","description":"The duration of \"digit token\" in minutes. The default value is 5.","minimum":1,"maximum":60,"default":5,"example":10}}>= 6` and `<= 18`"} schema={{"type":"integer","format":"int32","description":"The length of \"digit token\". The default value is 6.","minimum":6,"maximum":18,"default":6,"example":9}}>
    Reference to the password org config. @@ -66,7 +64,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -82,4 +80,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/create-password-sync-group.api.mdx b/docs/api/v3/create-password-sync-group.api.mdx index cfc7aa3c1..325593c5e 100644 --- a/docs/api/v3/create-password-sync-group.api.mdx +++ b/docs/api/v3/create-password-sync-group.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create Password Sync Group

    @@ -32,7 +30,7 @@ This API creates a password sync group based on the specifications provided. A t ## Request -

    Body

    required
    +

    Body

    required
    Reference to the password sync group. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/create-personal-access-token.api.mdx b/docs/api/v3/create-personal-access-token.api.mdx index f435e84c1..4da00f52f 100644 --- a/docs/api/v3/create-personal-access-token.api.mdx +++ b/docs/api/v3/create-personal-access-token.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create Personal Access Token

    @@ -36,7 +34,7 @@ This creates a personal access token. Name and scope of personal access token. -
    +
    Created. Note - this is the only time Personal Access Tokens' secret attribute will be displayed. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -88,4 +86,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/create-provisioning-policy.api.mdx b/docs/api/v3/create-provisioning-policy.api.mdx index e326581e8..8e0bd9368 100644 --- a/docs/api/v3/create-provisioning-policy.api.mdx +++ b/docs/api/v3/create-provisioning-policy.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create Provisioning Policy

    @@ -35,7 +33,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    Body

    required
      fields object[]
    • Array [
    • ]
    +

    Path Parameters

    Body

    required
      fields object[]
    • Array [
    • ]
    Created ProvisioningPolicyDto object @@ -67,7 +65,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -79,7 +77,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -95,4 +93,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/create-role.api.mdx b/docs/api/v3/create-role.api.mdx index eb5365d34..c1e45c465 100644 --- a/docs/api/v3/create-role.api.mdx +++ b/docs/api/v3/create-role.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a Role

    @@ -91,7 +89,7 @@ Revocation request configuration for this object. List describing the steps in approving the revocation request -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Role created @@ -179,7 +177,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -195,4 +193,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/create-saved-search.api.mdx b/docs/api/v3/create-saved-search.api.mdx index 2c1dce0f9..6b6348417 100644 --- a/docs/api/v3/create-saved-search.api.mdx +++ b/docs/api/v3/create-saved-search.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a saved search

    @@ -69,7 +67,7 @@ The lower bound of the range. The upper bound of the range. -
    +
    The persisted saved search. @@ -138,7 +136,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -154,4 +152,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/create-scheduled-search.api.mdx b/docs/api/v3/create-scheduled-search.api.mdx index c5f7c32e9..960cbaeee 100644 --- a/docs/api/v3/create-scheduled-search.api.mdx +++ b/docs/api/v3/create-scheduled-search.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create a new scheduled search

    @@ -63,7 +61,7 @@ The hours selected. A list of identities that should receive the scheduled search report via email. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • The persisted scheduled search. @@ -125,7 +123,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -137,7 +135,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -153,4 +151,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/create-segment.api.mdx b/docs/api/v3/create-segment.api.mdx index 901a12ad9..2c99c60ed 100644 --- a/docs/api/v3/create-segment.api.mdx +++ b/docs/api/v3/create-segment.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create Segment

    @@ -42,7 +40,7 @@ The owner of this object. List of expressions -
  • Array [
    • value objectnullable
  • ]
    • +
  • Array [
    • value objectnullable
  • ]
    • Segment created @@ -82,7 +80,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -98,4 +96,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/create-service-desk-integration.api.mdx b/docs/api/v3/create-service-desk-integration.api.mdx index 932ac4a71..4a1a29c8f 100644 --- a/docs/api/v3/create-service-desk-integration.api.mdx +++ b/docs/api/v3/create-service-desk-integration.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create new Service Desk integration

    @@ -64,7 +62,7 @@ Service Desk integration's attributes. Validation constraints enforced by the im Before Provisioning Rule. -
    +
    details of the created integration @@ -124,7 +122,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -136,7 +134,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -152,4 +150,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/create-sod-policy.api.mdx b/docs/api/v3/create-sod-policy.api.mdx index 9bfb8f405..06fb3e017 100644 --- a/docs/api/v3/create-sod-policy.api.mdx +++ b/docs/api/v3/create-sod-policy.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create SOD policy

    @@ -57,7 +55,7 @@ List of criteria. There is a min of 1 and max of 50 items in the list. List of criteria. There is a min of 1 and max of 50 items in the list. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • SOD policy created @@ -113,7 +111,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -129,4 +127,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/create-source-schema.api.mdx b/docs/api/v3/create-source-schema.api.mdx index 6f1cebb75..39342362e 100644 --- a/docs/api/v3/create-source-schema.api.mdx +++ b/docs/api/v3/create-source-schema.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create Schema on a Source

    @@ -41,7 +39,7 @@ The attribute definitions which form the schema. A reference to the schema on the source to the attribute values map to. -
  • ]
    • +
  • ]
    • The Schema was successfully created on the specified Source. @@ -81,7 +79,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -97,4 +95,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/create-source.api.mdx b/docs/api/v3/create-source.api.mdx index b672ba124..ad9fe13e3 100644 --- a/docs/api/v3/create-source.api.mdx +++ b/docs/api/v3/create-source.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Creates a source in IdentityNow.

    @@ -75,7 +73,7 @@ List of references to the associated PasswordPolicy objects. Reference to Management Workgroup for this Source -
    +
    Created Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design. @@ -149,7 +147,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -165,4 +163,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/create-transform.api.mdx b/docs/api/v3/create-transform.api.mdx index ab579f5ad..7be30e827 100644 --- a/docs/api/v3/create-transform.api.mdx +++ b/docs/api/v3/create-transform.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Create transform

    @@ -268,7 +266,7 @@ This is an optional attribute that can explicitly define the input data which wi This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. -
    +
    Indicates the transform was successfully created and returns its representation. @@ -532,7 +530,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -544,7 +542,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -560,4 +558,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-access-profile.api.mdx b/docs/api/v3/delete-access-profile.api.mdx index 203b3d329..25c8ccd41 100644 --- a/docs/api/v3/delete-access-profile.api.mdx +++ b/docs/api/v3/delete-access-profile.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete the specified Access Profile

    @@ -36,7 +34,7 @@ A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is requi ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-access-profiles-in-bulk.api.mdx b/docs/api/v3/delete-access-profiles-in-bulk.api.mdx index ea835b85a..84522f4a9 100644 --- a/docs/api/v3/delete-access-profiles-in-bulk.api.mdx +++ b/docs/api/v3/delete-access-profiles-in-bulk.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Access Profile(s)

    @@ -36,7 +34,7 @@ A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is requi ## Request -

    Body

    required
    +

    Body

    required
    Returned only if **bestEffortOnly** is **false**, and one or more Access Profiles are in use. @@ -88,7 +86,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -104,4 +102,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-account.api.mdx b/docs/api/v3/delete-account.api.mdx index 26e38c78a..42533700a 100644 --- a/docs/api/v3/delete-account.api.mdx +++ b/docs/api/v3/delete-account.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Account

    @@ -36,7 +34,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    Async task details. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-branding.api.mdx b/docs/api/v3/delete-branding.api.mdx index 246ddfcca..c506f78cc 100644 --- a/docs/api/v3/delete-branding.api.mdx +++ b/docs/api/v3/delete-branding.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete a branding item

    @@ -33,7 +31,7 @@ A token with API, ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-bulk-roles.api.mdx b/docs/api/v3/delete-bulk-roles.api.mdx index 2048b9712..95643bc5c 100644 --- a/docs/api/v3/delete-bulk-roles.api.mdx +++ b/docs/api/v3/delete-bulk-roles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Role(s)

    @@ -34,7 +32,7 @@ A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required ## Request -

    Body

    required
    +

    Body

    required
    Returns an object with the id of the task performing the delete operation. @@ -66,7 +64,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -82,4 +80,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-campaign-filters.api.mdx b/docs/api/v3/delete-campaign-filters.api.mdx index 905d8c8e8..6dd50c717 100644 --- a/docs/api/v3/delete-campaign-filters.api.mdx +++ b/docs/api/v3/delete-campaign-filters.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Deletes Campaign Filters

    @@ -40,7 +38,7 @@ A json list of IDs of campaign filters to delete. string -
  • ]
    • +
  • ]
    • No content - indicates the request was successful but there is no content to be returned in the response. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -84,7 +82,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -100,4 +98,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-campaign-template-schedule.api.mdx b/docs/api/v3/delete-campaign-template-schedule.api.mdx index 751b6fa10..56b3ed60b 100644 --- a/docs/api/v3/delete-campaign-template-schedule.api.mdx +++ b/docs/api/v3/delete-campaign-template-schedule.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Deletes a Campaign Template's Schedule

    @@ -32,7 +30,7 @@ Deletes the schedule for a campaign template. Returns a 404 if there is no sched ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-campaign-template.api.mdx b/docs/api/v3/delete-campaign-template.api.mdx index 5359829e0..72b1fd829 100644 --- a/docs/api/v3/delete-campaign-template.api.mdx +++ b/docs/api/v3/delete-campaign-template.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete a Campaign Template

    @@ -32,7 +30,7 @@ Deletes a campaign template by ID. ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-campaigns.api.mdx b/docs/api/v3/delete-campaigns.api.mdx index eea72ab3e..cfd428407 100644 --- a/docs/api/v3/delete-campaigns.api.mdx +++ b/docs/api/v3/delete-campaigns.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Deletes Campaigns

    @@ -36,7 +34,7 @@ Deletes campaigns whose Ids are specified in the provided list of campaign Ids. The ids of the campaigns to delete. -
    +
    Accepted - Returned if the request was successfully accepted into the system. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -84,7 +82,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -100,4 +98,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-custom-connector.api.mdx b/docs/api/v3/delete-custom-connector.api.mdx index e651c3f54..86c1c1fef 100644 --- a/docs/api/v3/delete-custom-connector.api.mdx +++ b/docs/api/v3/delete-custom-connector.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    deleteCustomConnector

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-identity-profile.api.mdx b/docs/api/v3/delete-identity-profile.api.mdx index 55cd35370..6ec178f02 100644 --- a/docs/api/v3/delete-identity-profile.api.mdx +++ b/docs/api/v3/delete-identity-profile.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete an Identity Profile

    @@ -38,7 +36,7 @@ The following rights are required to access this endpoint: idn:identity-profile: ## Request -

    Path Parameters

    +

    Path Parameters

    Accepted - Returns a TaskResult object referencing the bulk delete job created. @@ -70,7 +68,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -82,7 +80,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -98,4 +96,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-identity-profiles.api.mdx b/docs/api/v3/delete-identity-profiles.api.mdx index a56fa871b..0aadfbf5c 100644 --- a/docs/api/v3/delete-identity-profiles.api.mdx +++ b/docs/api/v3/delete-identity-profiles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Identity Profiles

    @@ -46,7 +44,7 @@ Identity Profile bulk delete request body. string -
  • ]
    • +
  • ]
    • Accepted - Returns a TaskResult object referencing the bulk delete job created. @@ -78,7 +76,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -94,4 +92,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-lifecycle-state.api.mdx b/docs/api/v3/delete-lifecycle-state.api.mdx index 7224ca9dd..525e56e73 100644 --- a/docs/api/v3/delete-lifecycle-state.api.mdx +++ b/docs/api/v3/delete-lifecycle-state.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Lifecycle State by ID

    @@ -33,7 +31,7 @@ A token with API, or ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    The request was successfully accepted into the system. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-non-employee-record.api.mdx b/docs/api/v3/delete-non-employee-record.api.mdx index 5b73f88e5..b2a7b99f1 100644 --- a/docs/api/v3/delete-non-employee-record.api.mdx +++ b/docs/api/v3/delete-non-employee-record.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Non-Employee Record

    @@ -33,7 +31,7 @@ Requires role context of `idn:nesr:delete` ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -81,4 +79,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-non-employee-records-in-bulk.api.mdx b/docs/api/v3/delete-non-employee-records-in-bulk.api.mdx index e817c93b8..b869e7a45 100644 --- a/docs/api/v3/delete-non-employee-records-in-bulk.api.mdx +++ b/docs/api/v3/delete-non-employee-records-in-bulk.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Multiple Non-Employee Records

    @@ -36,7 +34,7 @@ This request will delete multiple non-employee records based on the non-employee Non-Employee bulk delete request body. -
    +
    No content - indicates the request was successful but there is no content to be returned in the response. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-non-employee-request.api.mdx b/docs/api/v3/delete-non-employee-request.api.mdx index a54da01c1..c3a9c086d 100644 --- a/docs/api/v3/delete-non-employee-request.api.mdx +++ b/docs/api/v3/delete-non-employee-request.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Non-Employee Request

    @@ -33,7 +31,7 @@ Requires role context of `idn:nesr:delete` ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-non-employee-schema-attribute.api.mdx b/docs/api/v3/delete-non-employee-schema-attribute.api.mdx index a2bad1795..097a9dbef 100644 --- a/docs/api/v3/delete-non-employee-schema-attribute.api.mdx +++ b/docs/api/v3/delete-non-employee-schema-attribute.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete a Schema Attribute for Non-Employee Source

    @@ -34,7 +32,7 @@ Requires role context of `idn:nesr:delete` ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -66,7 +64,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -82,4 +80,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-non-employee-source-schema-attributes.api.mdx b/docs/api/v3/delete-non-employee-source-schema-attributes.api.mdx index 181c2551d..5c9b10245 100644 --- a/docs/api/v3/delete-non-employee-source-schema-attributes.api.mdx +++ b/docs/api/v3/delete-non-employee-source-schema-attributes.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete all custom schema attributes for Non-Employee Source

    @@ -32,7 +30,7 @@ This end-point deletes all custom schema attributes for a non-employee source. R ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-non-employee-source.api.mdx b/docs/api/v3/delete-non-employee-source.api.mdx index af957419f..531dccd19 100644 --- a/docs/api/v3/delete-non-employee-source.api.mdx +++ b/docs/api/v3/delete-non-employee-source.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Non-Employee Source

    @@ -32,7 +30,7 @@ This request will delete a non-employee source. Requires role context of `idn:ne ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-oauth-client.api.mdx b/docs/api/v3/delete-oauth-client.api.mdx index f17ae8256..0499dcd24 100644 --- a/docs/api/v3/delete-oauth-client.api.mdx +++ b/docs/api/v3/delete-oauth-client.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete OAuth Client

    @@ -32,7 +30,7 @@ This deletes an OAuth client. ## Request -

    Path Parameters

    +

    Path Parameters

    No content. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-password-sync-group.api.mdx b/docs/api/v3/delete-password-sync-group.api.mdx index b88774560..a179a5f74 100644 --- a/docs/api/v3/delete-password-sync-group.api.mdx +++ b/docs/api/v3/delete-password-sync-group.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Password Sync Group by ID

    @@ -32,7 +30,7 @@ This API deletes the specified password sync group. A token with ORG_ADMIN autho ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-personal-access-token.api.mdx b/docs/api/v3/delete-personal-access-token.api.mdx index be3a011b9..5fd6ac448 100644 --- a/docs/api/v3/delete-personal-access-token.api.mdx +++ b/docs/api/v3/delete-personal-access-token.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Personal Access Token

    @@ -32,7 +30,7 @@ This deletes a personal access token. ## Request -

    Path Parameters

    +

    Path Parameters

    No content. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-provisioning-policy.api.mdx b/docs/api/v3/delete-provisioning-policy.api.mdx index 0a5c5a8e4..60e5219ca 100644 --- a/docs/api/v3/delete-provisioning-policy.api.mdx +++ b/docs/api/v3/delete-provisioning-policy.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Provisioning Policy by UsageType

    @@ -33,7 +31,7 @@ A token with API, or ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-role.api.mdx b/docs/api/v3/delete-role.api.mdx index 83c476040..aabf4e057 100644 --- a/docs/api/v3/delete-role.api.mdx +++ b/docs/api/v3/delete-role.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete a Role

    @@ -33,7 +31,7 @@ A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -81,4 +79,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-saved-search.api.mdx b/docs/api/v3/delete-saved-search.api.mdx index e027fe15c..fdb64cabc 100644 --- a/docs/api/v3/delete-saved-search.api.mdx +++ b/docs/api/v3/delete-saved-search.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete document by ID

    @@ -33,7 +31,7 @@ Deletes the specified saved search. ## Request -

    Path Parameters

    +

    Path Parameters

    No Content - Indicates the request was successful but there is no content to be returned in the response. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-scheduled-search.api.mdx b/docs/api/v3/delete-scheduled-search.api.mdx index dab9f98fb..6a37a9627 100644 --- a/docs/api/v3/delete-scheduled-search.api.mdx +++ b/docs/api/v3/delete-scheduled-search.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete a Scheduled Search

    @@ -33,7 +31,7 @@ Deletes the specified scheduled search. ## Request -

    Path Parameters

    +

    Path Parameters

    No Content - Indicates the request was successful but there is no content to be returned in the response. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-segment.api.mdx b/docs/api/v3/delete-segment.api.mdx index 2a2934fe5..427b31930 100644 --- a/docs/api/v3/delete-segment.api.mdx +++ b/docs/api/v3/delete-segment.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Segment by ID

    @@ -34,7 +32,7 @@ A token with ORG_ADMIN or API authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    No content. @@ -66,7 +64,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -78,7 +76,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -94,4 +92,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-service-desk-integration.api.mdx b/docs/api/v3/delete-service-desk-integration.api.mdx index 6f02cc7be..e736eafeb 100644 --- a/docs/api/v3/delete-service-desk-integration.api.mdx +++ b/docs/api/v3/delete-service-desk-integration.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete a Service Desk integration

    @@ -32,7 +30,7 @@ Delete an existing Service Desk integration by ID. A token with Org Admin or Se ## Request -

    Path Parameters

    +

    Path Parameters

    Service Desk integration with the given ID successfully deleted @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-sod-policy-schedule.api.mdx b/docs/api/v3/delete-sod-policy-schedule.api.mdx index 3289abfcb..be80df6eb 100644 --- a/docs/api/v3/delete-sod-policy-schedule.api.mdx +++ b/docs/api/v3/delete-sod-policy-schedule.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete SOD policy schedule

    @@ -32,7 +30,7 @@ This deletes schedule for a specified SOD policy by ID. ## Request -

    Path Parameters

    +

    Path Parameters

    No content response. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-sod-policy.api.mdx b/docs/api/v3/delete-sod-policy.api.mdx index 6e312fd91..29807b521 100644 --- a/docs/api/v3/delete-sod-policy.api.mdx +++ b/docs/api/v3/delete-sod-policy.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete SOD policy by ID

    @@ -33,7 +31,7 @@ Requires role of ORG_ADMIN. ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    No content. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-source-schema.api.mdx b/docs/api/v3/delete-source-schema.api.mdx index ceb9ce910..4c498f04c 100644 --- a/docs/api/v3/delete-source-schema.api.mdx +++ b/docs/api/v3/delete-source-schema.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Source Schema by ID

    @@ -32,7 +30,7 @@ Delete Source Schema by ID ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-source.api.mdx b/docs/api/v3/delete-source.api.mdx index ac3bfbcbc..a93fb33de 100644 --- a/docs/api/v3/delete-source.api.mdx +++ b/docs/api/v3/delete-source.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Source by ID

    @@ -34,11 +32,11 @@ All of accounts on the source will be removed first, then the source will be del ## Request -

    Path Parameters

    +

    Path Parameters

    Accepted - Returned if the request was successfully accepted into the system. -
    Schema
     Response returned when deleting a source
    +
    Schema

    Response returned when deleting a source

    Client Error - Returned if the request body is invalid. @@ -66,7 +64,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -78,7 +76,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -94,4 +92,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-tagged-object.api.mdx b/docs/api/v3/delete-tagged-object.api.mdx index 39b45a716..d154ef762 100644 --- a/docs/api/v3/delete-tagged-object.api.mdx +++ b/docs/api/v3/delete-tagged-object.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete Tagged Object

    @@ -32,7 +30,7 @@ This deletes a tagged object for the specified type. ## Request -

    Path Parameters

    +

    Path Parameters

    No content. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-tags-to-many-object.api.mdx b/docs/api/v3/delete-tags-to-many-object.api.mdx index 478b8b98c..4f5ec119a 100644 --- a/docs/api/v3/delete-tags-to-many-object.api.mdx +++ b/docs/api/v3/delete-tags-to-many-object.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Remove Tags from Multiple Objects

    @@ -38,7 +36,7 @@ A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. -
      objectRefs object[]
    • Array [
    • ]
    +
      objectRefs object[]
    • Array [
    • ]
    No content - indicates the request was successful but there is no content to be returned in the response. @@ -70,7 +68,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -86,4 +84,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/delete-transform.api.mdx b/docs/api/v3/delete-transform.api.mdx index f98ee2ada..c06579d3c 100644 --- a/docs/api/v3/delete-transform.api.mdx +++ b/docs/api/v3/delete-transform.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Delete a transform

    @@ -33,7 +31,7 @@ A token with transform delete authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    No content - indicates the request was successful but there is no content to be returned in the response. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/disable-account.api.mdx b/docs/api/v3/disable-account.api.mdx index 8962d57ee..bd9dcc4f3 100644 --- a/docs/api/v3/disable-account.api.mdx +++ b/docs/api/v3/disable-account.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Disable Account

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    Async task details @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/enable-account.api.mdx b/docs/api/v3/enable-account.api.mdx index 35d4116e0..206195382 100644 --- a/docs/api/v3/enable-account.api.mdx +++ b/docs/api/v3/enable-account.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Enable Account

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    Async task details @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/execute-saved-search.api.mdx b/docs/api/v3/execute-saved-search.api.mdx index 8d400ab44..6982b23d6 100644 --- a/docs/api/v3/execute-saved-search.api.mdx +++ b/docs/api/v3/execute-saved-search.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Execute a saved search by ID

    @@ -50,7 +48,7 @@ A typed reference to the object. The email recipients of the scheduled search being tested. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Accepted - Returned if the request was successfully accepted into the system. @@ -82,7 +80,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -94,7 +92,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -110,4 +108,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/export-identity-profiles.api.mdx b/docs/api/v3/export-identity-profiles.api.mdx index ff34a8623..8730c3e2f 100644 --- a/docs/api/v3/export-identity-profiles.api.mdx +++ b/docs/api/v3/export-identity-profiles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Export Identity Profiles

    @@ -32,7 +30,7 @@ This exports existing identity profiles in the format specified by the sp-config ## Request -

    Query Parameters

    +

    Query Parameters

    List of export objects with identity profiles. @@ -84,7 +82,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -100,4 +98,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object
    \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

    \ No newline at end of file diff --git a/docs/api/v3/export-non-employee-records.api.mdx b/docs/api/v3/export-non-employee-records.api.mdx index c37840b82..21924e234 100644 --- a/docs/api/v3/export-non-employee-records.api.mdx +++ b/docs/api/v3/export-non-employee-records.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Exports Non-Employee Records to CSV

    @@ -32,7 +30,7 @@ This requests a CSV download for all non-employees from a provided source. Requi ## Request -

    Path Parameters

    +

    Path Parameters

    Exported CSV @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/export-non-employee-source-schema-template.api.mdx b/docs/api/v3/export-non-employee-source-schema-template.api.mdx index 3c1cff490..76cadd31d 100644 --- a/docs/api/v3/export-non-employee-source-schema-template.api.mdx +++ b/docs/api/v3/export-non-employee-source-schema-template.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Exports Source Schema Template

    @@ -32,7 +30,7 @@ This requests a download for the Source Schema Template for a provided source. R ## Request -

    Path Parameters

    +

    Path Parameters

    Exported Source Schema Template @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/forward-access-request.api.mdx b/docs/api/v3/forward-access-request.api.mdx index 5181c455e..442b4610d 100644 --- a/docs/api/v3/forward-access-request.api.mdx +++ b/docs/api/v3/forward-access-request.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Forwards an access request approval.

    @@ -36,7 +34,7 @@ This endpoint forwards an access request approval to a new owner. Only the owner Information about the forwarded approval. -
    +
    Accepted - Returned if the request was successfully accepted into the system. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -84,7 +82,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -100,4 +98,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-access-profile-entitlements.api.mdx b/docs/api/v3/get-access-profile-entitlements.api.mdx index 75d4da64f..a32464ced 100644 --- a/docs/api/v3/get-access-profile-entitlements.api.mdx +++ b/docs/api/v3/get-access-profile-entitlements.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Access Profile's Entitlements

    @@ -34,7 +32,7 @@ A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is requi ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    List of Entitlements @@ -70,7 +68,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -86,4 +84,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-access-profile.api.mdx b/docs/api/v3/get-access-profile.api.mdx index 6164355ac..21d29dbc7 100644 --- a/docs/api/v3/get-access-profile.api.mdx +++ b/docs/api/v3/get-access-profile.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get an Access Profile

    @@ -34,7 +32,7 @@ A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_ ## Request -

    Path Parameters

    +

    Path Parameters

    An AccessProfile @@ -102,7 +100,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -118,4 +116,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-access-request-approval-summary.api.mdx b/docs/api/v3/get-access-request-approval-summary.api.mdx index 8b5c20618..bf16462c5 100644 --- a/docs/api/v3/get-access-request-approval-summary.api.mdx +++ b/docs/api/v3/get-access-request-approval-summary.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get the number of access-requests-approvals

    @@ -32,7 +30,7 @@ This endpoint returns the number of pending, approved and rejected access reques ## Request -

    Query Parameters

    +

    Query Parameters

    Number of pending, approved, rejected access request approvals. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-access-request-config.api.mdx b/docs/api/v3/get-access-request-config.api.mdx index 8ca11443c..0c690c6b2 100644 --- a/docs/api/v3/get-access-request-config.api.mdx +++ b/docs/api/v3/get-access-request-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Access Request Configuration

    @@ -32,7 +30,7 @@ This endpoint returns the current access-request configuration. ## Request -
    +
    Access Request Configuration Details. @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-account-activity.api.mdx b/docs/api/v3/get-account-activity.api.mdx index b889f3ccc..7cf5b02f9 100644 --- a/docs/api/v3/get-account-activity.api.mdx +++ b/docs/api/v3/get-account-activity.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get an Account Activity

    @@ -32,7 +30,7 @@ This gets a single account activity by its id. ## Request -

    Path Parameters

    +

    Path Parameters

    An account activity object @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -92,7 +90,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -108,4 +106,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-account-entitlements.api.mdx b/docs/api/v3/get-account-entitlements.api.mdx index f849e3e38..e19ffa144 100644 --- a/docs/api/v3/get-account-entitlements.api.mdx +++ b/docs/api/v3/get-account-entitlements.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Account Entitlements

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    An array of account entitlements @@ -73,7 +71,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -85,7 +83,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -101,4 +99,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-account.api.mdx b/docs/api/v3/get-account.api.mdx index 7d2f40c5d..50bbbb10b 100644 --- a/docs/api/v3/get-account.api.mdx +++ b/docs/api/v3/get-account.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Account Details

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    Account object. @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -89,7 +87,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -105,4 +103,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-accounts-schema.api.mdx b/docs/api/v3/get-accounts-schema.api.mdx index c8f186872..c9f84d643 100644 --- a/docs/api/v3/get-accounts-schema.api.mdx +++ b/docs/api/v3/get-accounts-schema.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Downloads source accounts schema template

    @@ -33,7 +31,7 @@ This API downloads the CSV schema that defines the account attributes on a sourc ## Request -

    Path Parameters

    +

    Path Parameters

    Successfully downloaded the file @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-active-campaigns.api.mdx b/docs/api/v3/get-active-campaigns.api.mdx index 98a8c6fbf..80e91aaa4 100644 --- a/docs/api/v3/get-active-campaigns.api.mdx +++ b/docs/api/v3/get-active-campaigns.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Campaigns

    @@ -32,7 +30,7 @@ Gets campaigns and returns them in a list. Can provide increased level of detail ## Request -

    Query Parameters

    +

    Query Parameters

    A list of campaign objects. By default list of SLIM campaigns is returned. @@ -112,7 +110,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -128,4 +126,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-auth-org-network-config.api.mdx b/docs/api/v3/get-auth-org-network-config.api.mdx index 588b1ba5b..69b170bb6 100644 --- a/docs/api/v3/get-auth-org-network-config.api.mdx +++ b/docs/api/v3/get-auth-org-network-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get security network configuration.

    @@ -32,7 +30,7 @@ This API returns the details of an org's network auth configuration. Requires se ## Request -
    +
    Network configuration for the tenant's auth org. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-auth-user.api.mdx b/docs/api/v3/get-auth-user.api.mdx index f9f514763..a1bdbc4a0 100644 --- a/docs/api/v3/get-auth-user.api.mdx +++ b/docs/api/v3/get-auth-user.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Auth User Details

    @@ -32,7 +30,7 @@ Return the specified user's authentication system details. ## Request -

    Path Parameters

    +

    Path Parameters

    The specified user's authentication system details. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-branding-list.api.mdx b/docs/api/v3/get-branding-list.api.mdx index 5f1fb292a..87f198759 100644 --- a/docs/api/v3/get-branding-list.api.mdx +++ b/docs/api/v3/get-branding-list.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List of branding items

    @@ -34,7 +32,7 @@ A token with API, ORG_ADMIN authority is required to call this API. ## Request -
    +
    A list of branding items. @@ -66,7 +64,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -82,4 +80,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-branding.api.mdx b/docs/api/v3/get-branding.api.mdx index 5e5af016c..6d45967cc 100644 --- a/docs/api/v3/get-branding.api.mdx +++ b/docs/api/v3/get-branding.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get a branding item

    @@ -33,7 +31,7 @@ A token with API, ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    A branding item object @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-campaign-filter-by-id.api.mdx b/docs/api/v3/get-campaign-filter-by-id.api.mdx index 1df10e960..5a28dca4b 100644 --- a/docs/api/v3/get-campaign-filter-by-id.api.mdx +++ b/docs/api/v3/get-campaign-filter-by-id.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Campaign Filter by ID

    @@ -32,7 +30,7 @@ Retrieves information for an existing campaign filter using the filter's ID. ## Request -

    Path Parameters

    +

    Path Parameters

    A campaign filter object. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-campaign-reports-config.api.mdx b/docs/api/v3/get-campaign-reports-config.api.mdx index e660ff15d..ad7ca24cb 100644 --- a/docs/api/v3/get-campaign-reports-config.api.mdx +++ b/docs/api/v3/get-campaign-reports-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Campaign Reports Configuration

    @@ -33,7 +31,7 @@ Requires roles of CERT_ADMIN and ORG_ADMIN. ## Request -
    +
    Campaign Report Configuration @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -81,4 +79,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-campaign-reports.api.mdx b/docs/api/v3/get-campaign-reports.api.mdx index 684253ed1..40e125e2c 100644 --- a/docs/api/v3/get-campaign-reports.api.mdx +++ b/docs/api/v3/get-campaign-reports.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Campaign Reports

    @@ -33,7 +31,7 @@ Requires roles of CERT_ADMIN, DASHBOARD, ORG_ADMIN and REPORT_ADMIN ## Request -

    Path Parameters

    +

    Path Parameters

    Array of campaign report objects. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-campaign-template-schedule.api.mdx b/docs/api/v3/get-campaign-template-schedule.api.mdx index 839f01e5e..4e2521ae5 100644 --- a/docs/api/v3/get-campaign-template-schedule.api.mdx +++ b/docs/api/v3/get-campaign-template-schedule.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Gets a Campaign Template's Schedule

    @@ -32,7 +30,7 @@ Gets the schedule for a campaign template. Returns a 404 if there is no schedule ## Request -

    Path Parameters

    +

    Path Parameters

    The current schedule for the campaign template. See the PUT endpoint documentation for more examples. @@ -136,7 +134,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -148,7 +146,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -164,4 +162,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-campaign-template.api.mdx b/docs/api/v3/get-campaign-template.api.mdx index cf9f99249..d8075fb6f 100644 --- a/docs/api/v3/get-campaign-template.api.mdx +++ b/docs/api/v3/get-campaign-template.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get a Campaign Template

    @@ -32,7 +30,7 @@ Fetches a campaign template by ID. ## Request -

    Path Parameters

    +

    Path Parameters

    The data for the campaign matching the given ID. @@ -112,7 +110,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -124,7 +122,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -140,4 +138,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-campaign.api.mdx b/docs/api/v3/get-campaign.api.mdx index cf477a3a5..45b92f1fa 100644 --- a/docs/api/v3/get-campaign.api.mdx +++ b/docs/api/v3/get-campaign.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get a campaign

    @@ -32,7 +30,7 @@ Retrieves information for an existing campaign using the campaign's ID. Authoriz ## Request -

    Path Parameters

    +

    Path Parameters

    A campaign object @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-certification-task.api.mdx b/docs/api/v3/get-certification-task.api.mdx index fec48bbec..94ef56033 100644 --- a/docs/api/v3/get-certification-task.api.mdx +++ b/docs/api/v3/get-certification-task.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Certification Task by ID

    @@ -32,7 +30,7 @@ This API returns the certification task for the specified ID. A token with ORG_A ## Request -

    Path Parameters

    +

    Path Parameters

    A certification task @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -84,7 +82,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -100,4 +98,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-completed-work-items.api.mdx b/docs/api/v3/get-completed-work-items.api.mdx index 240479d52..a2d3df305 100644 --- a/docs/api/v3/get-completed-work-items.api.mdx +++ b/docs/api/v3/get-completed-work-items.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Completed Work Items

    @@ -32,7 +30,7 @@ This gets a collection of completed work items belonging to either the specified ## Request -

    Query Parameters

    +

    Query Parameters

    List of completed work items. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-connector-correlation-config.api.mdx b/docs/api/v3/get-connector-correlation-config.api.mdx index a515b790a..4b3b1704c 100644 --- a/docs/api/v3/get-connector-correlation-config.api.mdx +++ b/docs/api/v3/get-connector-correlation-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    getConnectorCorrelationConfig

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    The connector's correlation config @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -81,7 +79,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -97,4 +95,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-connector-source-config.api.mdx b/docs/api/v3/get-connector-source-config.api.mdx index 7ac4130f7..6dfbe465a 100644 --- a/docs/api/v3/get-connector-source-config.api.mdx +++ b/docs/api/v3/get-connector-source-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    getConnectorSourceConfig

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    The connector's source template @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -81,7 +79,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -97,4 +95,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-connector-source-template.api.mdx b/docs/api/v3/get-connector-source-template.api.mdx index 85f626513..1788240cd 100644 --- a/docs/api/v3/get-connector-source-template.api.mdx +++ b/docs/api/v3/get-connector-source-template.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    getConnectorSourceTemplate

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    The connector's source template @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -81,7 +79,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -97,4 +95,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-connector-translations.api.mdx b/docs/api/v3/get-connector-translations.api.mdx index 85d83489e..82bb27812 100644 --- a/docs/api/v3/get-connector-translations.api.mdx +++ b/docs/api/v3/get-connector-translations.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    getConnectorTranslations

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    The connector's translations @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -81,7 +79,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -97,4 +95,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-connector.api.mdx b/docs/api/v3/get-connector.api.mdx index d599e3dbe..1e3928eff 100644 --- a/docs/api/v3/get-connector.api.mdx +++ b/docs/api/v3/get-connector.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    getConnector

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    A Connector Dto object @@ -73,7 +71,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -85,7 +83,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -101,4 +99,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-count-completed-work-items.api.mdx b/docs/api/v3/get-count-completed-work-items.api.mdx index 029126bb2..7b0350f6b 100644 --- a/docs/api/v3/get-count-completed-work-items.api.mdx +++ b/docs/api/v3/get-count-completed-work-items.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Count Completed Work Items

    @@ -32,7 +30,7 @@ This gets a count of completed work items belonging to either the specified user ## Request -

    Query Parameters

    +

    Query Parameters

    List of work items @@ -52,7 +50,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-count-work-items.api.mdx b/docs/api/v3/get-count-work-items.api.mdx index a7b3697c8..1466913d6 100644 --- a/docs/api/v3/get-count-work-items.api.mdx +++ b/docs/api/v3/get-count-work-items.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Count Work Items

    @@ -32,7 +30,7 @@ This gets a count of work items belonging to either the specified user(admin req ## Request -

    Query Parameters

    +

    Query Parameters

    List of work items @@ -52,7 +50,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-custom-violation-report.api.mdx b/docs/api/v3/get-custom-violation-report.api.mdx index 8cc023fb2..01360e083 100644 --- a/docs/api/v3/get-custom-violation-report.api.mdx +++ b/docs/api/v3/get-custom-violation-report.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Download custom violation report

    @@ -32,7 +30,7 @@ This allows to download a specified named violation report for a given report re ## Request -

    Path Parameters

    +

    Path Parameters

    Returns the zip file with given custom name that contains the violation report file. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-default-identity-attribute-config.api.mdx b/docs/api/v3/get-default-identity-attribute-config.api.mdx index b56e46f60..665248467 100644 --- a/docs/api/v3/get-default-identity-attribute-config.api.mdx +++ b/docs/api/v3/get-default-identity-attribute-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get default Identity Attribute Config

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API to get the default ## Request -

    Path Parameters

    +

    Path Parameters

    An Identity Attribute Config object. @@ -73,7 +71,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -85,7 +83,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -101,4 +99,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-default-violation-report.api.mdx b/docs/api/v3/get-default-violation-report.api.mdx index 2e85263b3..bd6c3d299 100644 --- a/docs/api/v3/get-default-violation-report.api.mdx +++ b/docs/api/v3/get-default-violation-report.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Download violation report

    @@ -32,7 +30,7 @@ This allows to download a violation report for a given report reference. ## Request -

    Path Parameters

    +

    Path Parameters

    Returns the PolicyReport.zip that contains the violation report file. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-entitlements-schema.api.mdx b/docs/api/v3/get-entitlements-schema.api.mdx index 713e2d322..fafb0bbce 100644 --- a/docs/api/v3/get-entitlements-schema.api.mdx +++ b/docs/api/v3/get-entitlements-schema.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Downloads source entitlements schema template

    @@ -34,7 +32,7 @@ This API downloads the CSV schema that defines the entitlement attributes on a s ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Successfully downloaded the file @@ -66,7 +64,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -78,7 +76,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -94,4 +92,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-identity-access-summaries.api.mdx b/docs/api/v3/get-identity-access-summaries.api.mdx index e766d75bc..babb750f3 100644 --- a/docs/api/v3/get-identity-access-summaries.api.mdx +++ b/docs/api/v3/get-identity-access-summaries.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Access Summaries

    @@ -32,7 +30,7 @@ This API returns a list of access summaries for the specified identity campaign ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    List of access summaries @@ -168,7 +166,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -180,7 +178,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -196,4 +194,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-identity-certification-item-permissions.api.mdx b/docs/api/v3/get-identity-certification-item-permissions.api.mdx index a75b41035..8eefd47e7 100644 --- a/docs/api/v3/get-identity-certification-item-permissions.api.mdx +++ b/docs/api/v3/get-identity-certification-item-permissions.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Permissions for Entitlement Certification Item

    @@ -32,7 +30,7 @@ This API returns the permissions associated with an entitlement certification it ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    A list of permissions associated with the given itemId @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-identity-certification.api.mdx b/docs/api/v3/get-identity-certification.api.mdx index fae4583b6..e17b99497 100644 --- a/docs/api/v3/get-identity-certification.api.mdx +++ b/docs/api/v3/get-identity-certification.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Identity Certification by ID

    @@ -32,7 +30,7 @@ This API returns a single identity campaign certification by its ID. A token wit ## Request -

    Path Parameters

    +

    Path Parameters

    An identity campaign certification object @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-identity-decision-summary.api.mdx b/docs/api/v3/get-identity-decision-summary.api.mdx index f916fe7b3..09460a905 100644 --- a/docs/api/v3/get-identity-decision-summary.api.mdx +++ b/docs/api/v3/get-identity-decision-summary.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Summary of Certification Decisions

    @@ -32,7 +30,7 @@ This API returns a summary of the decisions made on an identity campaign certifi ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Summary of the decisions made @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-identity-profile.api.mdx b/docs/api/v3/get-identity-profile.api.mdx index 4f57dd115..e77e0a6ea 100644 --- a/docs/api/v3/get-identity-profile.api.mdx +++ b/docs/api/v3/get-identity-profile.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get single Identity Profile

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN or API authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    An Identity Profile object. @@ -81,7 +79,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -93,7 +91,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -109,4 +107,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-identity-summaries.api.mdx b/docs/api/v3/get-identity-summaries.api.mdx index c14a52bde..1d9e46cb0 100644 --- a/docs/api/v3/get-identity-summaries.api.mdx +++ b/docs/api/v3/get-identity-summaries.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Identity Summaries for Campaign Certification

    @@ -32,7 +30,7 @@ This API returns a list of the identity summaries for a specific identity campai ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    List of identity summaries @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-identity-summary.api.mdx b/docs/api/v3/get-identity-summary.api.mdx index 053b9a615..a6012ff97 100644 --- a/docs/api/v3/get-identity-summary.api.mdx +++ b/docs/api/v3/get-identity-summary.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Summary for Identity

    @@ -32,7 +30,7 @@ This API returns the summary for an identity on a specified identity campaign ce ## Request -

    Path Parameters

    +

    Path Parameters

    An identity summary @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-lifecycle-state.api.mdx b/docs/api/v3/get-lifecycle-state.api.mdx index 4af17db58..a1ab508ea 100644 --- a/docs/api/v3/get-lifecycle-state.api.mdx +++ b/docs/api/v3/get-lifecycle-state.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Retrieves Lifecycle State

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN or API authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    The requested LifecycleState was successfully retrieved. @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -81,7 +79,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -97,4 +95,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-non-employee-approval-summary.api.mdx b/docs/api/v3/get-non-employee-approval-summary.api.mdx index 8ff1a19b1..56599dadc 100644 --- a/docs/api/v3/get-non-employee-approval-summary.api.mdx +++ b/docs/api/v3/get-non-employee-approval-summary.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Summary of Non-Employee Approval Requests

    @@ -36,7 +34,7 @@ as the `requested-for` value. This will provide the approver with a summary of t ## Request -

    Path Parameters

    +

    Path Parameters

    summary of non-employee approval requests @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-non-employee-approval.api.mdx b/docs/api/v3/get-non-employee-approval.api.mdx index a5f47b20c..308a6db1b 100644 --- a/docs/api/v3/get-non-employee-approval.api.mdx +++ b/docs/api/v3/get-non-employee-approval.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get a non-employee approval item detail

    @@ -35,7 +33,7 @@ can get any approval. ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Non-Employee approval item object. @@ -83,7 +81,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -99,4 +97,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-non-employee-bulk-upload-status.api.mdx b/docs/api/v3/get-non-employee-bulk-upload-status.api.mdx index 372123080..5c81b1d0d 100644 --- a/docs/api/v3/get-non-employee-bulk-upload-status.api.mdx +++ b/docs/api/v3/get-non-employee-bulk-upload-status.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Obtain the status of bulk upload on the source

    @@ -34,7 +32,7 @@ Requires role context of `idn:nesr:read` ## Request -

    Path Parameters

    +

    Path Parameters

    Status of the newest bulk-upload job, if any. @@ -66,7 +64,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -82,4 +80,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-non-employee-record.api.mdx b/docs/api/v3/get-non-employee-record.api.mdx index 8dc4f5783..51a56b652 100644 --- a/docs/api/v3/get-non-employee-record.api.mdx +++ b/docs/api/v3/get-non-employee-record.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get a Non-Employee Record

    @@ -33,7 +31,7 @@ Requires role context of `idn:nesr:read` ## Request -

    Path Parameters

    +

    Path Parameters

    Non-Employee record object @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -85,4 +83,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-non-employee-request-summary.api.mdx b/docs/api/v3/get-non-employee-request-summary.api.mdx index 1980101b0..fe78b71ad 100644 --- a/docs/api/v3/get-non-employee-request-summary.api.mdx +++ b/docs/api/v3/get-non-employee-request-summary.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Summary of Non-Employee Requests

    @@ -36,7 +34,7 @@ provided as the `requested-for` value. This will provide the user with a summary ## Request -

    Path Parameters

    +

    Path Parameters

    Non-Employee request summary object. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-non-employee-request.api.mdx b/docs/api/v3/get-non-employee-request.api.mdx index 1bed62bc0..1add11b6a 100644 --- a/docs/api/v3/get-non-employee-request.api.mdx +++ b/docs/api/v3/get-non-employee-request.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get a Non-Employee Request

    @@ -36,7 +34,7 @@ can get the non-employee request for any user. ## Request -

    Path Parameters

    +

    Path Parameters

    Non-Employee request object. @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -92,7 +90,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -108,4 +106,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-non-employee-schema-attribute.api.mdx b/docs/api/v3/get-non-employee-schema-attribute.api.mdx index 64d9c26af..8b843d697 100644 --- a/docs/api/v3/get-non-employee-schema-attribute.api.mdx +++ b/docs/api/v3/get-non-employee-schema-attribute.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Schema Attribute Non-Employee Source

    @@ -32,7 +30,7 @@ This API gets a schema attribute by Id for the specified Non-Employee SourceId. ## Request -

    Path Parameters

    +

    Path Parameters

    The Schema Attribute @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-non-employee-source-schema-attributes.api.mdx b/docs/api/v3/get-non-employee-source-schema-attributes.api.mdx index 1f9e2e030..15ac8dbc4 100644 --- a/docs/api/v3/get-non-employee-source-schema-attributes.api.mdx +++ b/docs/api/v3/get-non-employee-source-schema-attributes.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Schema Attributes Non-Employee Source

    @@ -33,7 +31,7 @@ Requires role context of `idn:nesr:read` or the user must be an account manager ## Request -

    Path Parameters

    +

    Path Parameters

    A list of Schema Attributes @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-non-employee-source.api.mdx b/docs/api/v3/get-non-employee-source.api.mdx index 316b3f5ef..6f35a993a 100644 --- a/docs/api/v3/get-non-employee-source.api.mdx +++ b/docs/api/v3/get-non-employee-source.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get a Non-Employee Source

    @@ -36,7 +34,7 @@ request sources that they own. ## Request -

    Path Parameters

    +

    Path Parameters

    Non-Employee source object. @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-oauth-client.api.mdx b/docs/api/v3/get-oauth-client.api.mdx index 96417aeaa..8e5d6226e 100644 --- a/docs/api/v3/get-oauth-client.api.mdx +++ b/docs/api/v3/get-oauth-client.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get OAuth Client

    @@ -32,7 +30,7 @@ This gets details of an OAuth client. ## Request -

    Path Parameters

    +

    Path Parameters

    Request succeeded. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-password-change-status.api.mdx b/docs/api/v3/get-password-change-status.api.mdx index ba947e540..fba5df5cc 100644 --- a/docs/api/v3/get-password-change-status.api.mdx +++ b/docs/api/v3/get-password-change-status.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Password Change Request Status

    @@ -32,7 +30,7 @@ This API returns the status of a password change request. A token with identity ## Request -

    Path Parameters

    +

    Path Parameters

    Status of the password change request @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-password-dictionary.api.mdx b/docs/api/v3/get-password-dictionary.api.mdx index aca025921..b5f0dffdb 100644 --- a/docs/api/v3/get-password-dictionary.api.mdx +++ b/docs/api/v3/get-password-dictionary.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Password Dictionary

    @@ -61,7 +59,7 @@ qazxsws ## Request -
    +
    A password dictionary response @@ -97,7 +95,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -109,7 +107,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -125,4 +123,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-password-org-config.api.mdx b/docs/api/v3/get-password-org-config.api.mdx index 71df21783..a64c59e84 100644 --- a/docs/api/v3/get-password-org-config.api.mdx +++ b/docs/api/v3/get-password-org-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Password Org Config

    @@ -32,7 +30,7 @@ This API returns the password org config . Requires ORG_ADMIN, API role or autho ## Request -
    +
    Reference to the password org config. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-password-sync-group.api.mdx b/docs/api/v3/get-password-sync-group.api.mdx index 7e9ef874b..fa3a53fa8 100644 --- a/docs/api/v3/get-password-sync-group.api.mdx +++ b/docs/api/v3/get-password-sync-group.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Password Sync Group by ID

    @@ -32,7 +30,7 @@ This API returns the sync group for the specified ID. A token with ORG_ADMIN aut ## Request -

    Path Parameters

    +

    Path Parameters

    Reference to the password sync group. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-password-sync-groups.api.mdx b/docs/api/v3/get-password-sync-groups.api.mdx index 15f2793f6..9a41db762 100644 --- a/docs/api/v3/get-password-sync-groups.api.mdx +++ b/docs/api/v3/get-password-sync-groups.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Password Sync Group List

    @@ -32,7 +30,7 @@ This API returns a list of password sync groups. A token with ORG_ADMIN authorit ## Request -

    Query Parameters

    +

    Query Parameters

    A list of password sync groups. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-pending-certification-tasks.api.mdx b/docs/api/v3/get-pending-certification-tasks.api.mdx index 0a1b4a6f6..48e76de72 100644 --- a/docs/api/v3/get-pending-certification-tasks.api.mdx +++ b/docs/api/v3/get-pending-certification-tasks.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List of Pending Certification Tasks

    @@ -32,7 +30,7 @@ This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tas ## Request -

    Query Parameters

    +

    Query Parameters

    A list of pending certification tasks @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -84,7 +82,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -100,4 +98,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-provisioning-policy.api.mdx b/docs/api/v3/get-provisioning-policy.api.mdx index 2b865ef38..c0f5ec76c 100644 --- a/docs/api/v3/get-provisioning-policy.api.mdx +++ b/docs/api/v3/get-provisioning-policy.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Provisioning Policy by UsageType

    @@ -33,7 +31,7 @@ A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is requi ## Request -

    Path Parameters

    +

    Path Parameters

    The requested ProvisioningPolicyDto was successfully retrieved. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-public-identities.api.mdx b/docs/api/v3/get-public-identities.api.mdx index 1a7ae2f1f..bf986dae7 100644 --- a/docs/api/v3/get-public-identities.api.mdx +++ b/docs/api/v3/get-public-identities.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get a list of public identities

    @@ -32,7 +30,7 @@ Get a list of public identities ## Request -

    Query Parameters

    +

    Query Parameters

    A list of public identity objects. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -88,4 +86,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-public-identity-config.api.mdx b/docs/api/v3/get-public-identity-config.api.mdx index 336f1d2b8..b57a67a74 100644 --- a/docs/api/v3/get-public-identity-config.api.mdx +++ b/docs/api/v3/get-public-identity-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get the Public Identities Configuration

    @@ -32,7 +30,7 @@ Returns the publicly visible attributes of an identity available to request appr ## Request -
    +
    Request succeeded. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -88,4 +86,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-report-result.api.mdx b/docs/api/v3/get-report-result.api.mdx index f39548b80..a0c7ddb1a 100644 --- a/docs/api/v3/get-report-result.api.mdx +++ b/docs/api/v3/get-report-result.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Report Result

    @@ -32,11 +30,11 @@ Get the report results for a report that was run or is running. Returns empty re ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Details about report that was run or is running. -
    Schema
     Identities Details Report result.
    +
    Schema

    Identities Details Report result.

    Client Error - Returned if the request body is invalid. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-report.api.mdx b/docs/api/v3/get-report.api.mdx index e22c72fb3..0b9f2f362 100644 --- a/docs/api/v3/get-report.api.mdx +++ b/docs/api/v3/get-report.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Report File

    @@ -32,7 +30,7 @@ Gets a report in file format. ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Report file in selected format. CSV by default. @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -88,7 +86,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response objectFile Not Found - 404 Error The requested file was not found.\"\n }\n ]\n}"} language={"json"}>
    +
  • Array [
  • ]

    • An example of a 404 response object

    File Not Found - 404 Error The requested file was not found.\"\n }\n ]\n}"} language={"json"}>
    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. @@ -104,4 +102,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-role-assigned-identities.api.mdx b/docs/api/v3/get-role-assigned-identities.api.mdx index 4c6afc834..99d9a0b07 100644 --- a/docs/api/v3/get-role-assigned-identities.api.mdx +++ b/docs/api/v3/get-role-assigned-identities.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Identities assigned a Role

    @@ -32,7 +30,7 @@ List Identities assigned a Role ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    List of Identities assigned the Role @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-role.api.mdx b/docs/api/v3/get-role.api.mdx index f352f9c8b..e16c5189a 100644 --- a/docs/api/v3/get-role.api.mdx +++ b/docs/api/v3/get-role.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get a Role

    @@ -34,7 +32,7 @@ A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required ## Request -

    Path Parameters

    +

    Path Parameters

    List of all Roles @@ -122,7 +120,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -138,4 +136,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-saved-search.api.mdx b/docs/api/v3/get-saved-search.api.mdx index 125d1ebb2..401c61464 100644 --- a/docs/api/v3/get-saved-search.api.mdx +++ b/docs/api/v3/get-saved-search.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Return saved search by ID

    @@ -33,7 +31,7 @@ Returns the specified saved search. ## Request -

    Path Parameters

    +

    Path Parameters

    The requested saved search. @@ -102,7 +100,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -114,7 +112,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -130,4 +128,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-scheduled-search.api.mdx b/docs/api/v3/get-scheduled-search.api.mdx index f88ff36ec..a226ad493 100644 --- a/docs/api/v3/get-scheduled-search.api.mdx +++ b/docs/api/v3/get-scheduled-search.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get a Scheduled Search

    @@ -32,7 +30,7 @@ Returns the specified scheduled search. ## Request -

    Path Parameters

    +

    Path Parameters

    The requested scheduled search. @@ -94,7 +92,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -106,7 +104,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -122,4 +120,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-segment.api.mdx b/docs/api/v3/get-segment.api.mdx index 90d8a192f..2319916de 100644 --- a/docs/api/v3/get-segment.api.mdx +++ b/docs/api/v3/get-segment.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Segment by ID

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN or API authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    Segment @@ -73,7 +71,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -85,7 +83,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -101,4 +99,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-service-desk-integration-template.api.mdx b/docs/api/v3/get-service-desk-integration-template.api.mdx index 1e9acfeed..377103667 100644 --- a/docs/api/v3/get-service-desk-integration-template.api.mdx +++ b/docs/api/v3/get-service-desk-integration-template.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Service Desk integration template by scriptName.

    @@ -32,7 +30,7 @@ This API endpoint returns an existing Service Desk integration template by scrip ## Request -

    Path Parameters

    +

    Path Parameters

    Responds with the ServiceDeskIntegrationTemplateDto with the specified scriptName. @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -92,7 +90,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -108,4 +106,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-service-desk-integration-types.api.mdx b/docs/api/v3/get-service-desk-integration-types.api.mdx index c6fcd42ec..3368126f1 100644 --- a/docs/api/v3/get-service-desk-integration-types.api.mdx +++ b/docs/api/v3/get-service-desk-integration-types.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Service Desk Integration Types List.

    @@ -32,7 +30,7 @@ This API endpoint returns the current list of supported Service Desk integration ## Request -
    +
    Responds with an array of the currently supported Service Desk integration types. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-service-desk-integration.api.mdx b/docs/api/v3/get-service-desk-integration.api.mdx index a9d10e02b..7851fa6d3 100644 --- a/docs/api/v3/get-service-desk-integration.api.mdx +++ b/docs/api/v3/get-service-desk-integration.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get a Service Desk integration

    @@ -32,7 +30,7 @@ Get an existing Service Desk integration by ID. A token with Org Admin or Servi ## Request -

    Path Parameters

    +

    Path Parameters

    ServiceDeskIntegrationDto with the given ID @@ -92,7 +90,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -104,7 +102,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -120,4 +118,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-service-desk-integrations.api.mdx b/docs/api/v3/get-service-desk-integrations.api.mdx index b93e663c3..25a8b69f5 100644 --- a/docs/api/v3/get-service-desk-integrations.api.mdx +++ b/docs/api/v3/get-service-desk-integrations.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List existing Service Desk Integrations

    @@ -32,7 +30,7 @@ Get a list of ServiceDeskIntegrationDto for existing Service Desk Integrations. ## Request -

    Query Parameters

    +

    Query Parameters

    List of ServiceDeskIntegrationDto @@ -92,7 +90,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -104,7 +102,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -120,4 +118,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-sod-all-report-run-status.api.mdx b/docs/api/v3/get-sod-all-report-run-status.api.mdx index ef00135db..aa0b8907b 100644 --- a/docs/api/v3/get-sod-all-report-run-status.api.mdx +++ b/docs/api/v3/get-sod-all-report-run-status.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get multi-report run task status

    @@ -32,7 +30,7 @@ This endpoint gets the status for a violation report for all policy run. ## Request -
    +
    Status of the violation report run task for all policy run. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-sod-policy-schedule.api.mdx b/docs/api/v3/get-sod-policy-schedule.api.mdx index 1c3660ac0..beceee040 100644 --- a/docs/api/v3/get-sod-policy-schedule.api.mdx +++ b/docs/api/v3/get-sod-policy-schedule.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get SOD policy schedule

    @@ -32,7 +30,7 @@ This endpoint gets a specified SOD policy's schedule. ## Request -

    Path Parameters

    +

    Path Parameters

    SOD policy schedule. @@ -86,7 +84,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -102,4 +100,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-sod-policy.api.mdx b/docs/api/v3/get-sod-policy.api.mdx index 5a37b85b9..6b692afaf 100644 --- a/docs/api/v3/get-sod-policy.api.mdx +++ b/docs/api/v3/get-sod-policy.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get SOD policy by ID

    @@ -33,7 +31,7 @@ Requires role of ORG_ADMIN. ## Request -

    Path Parameters

    +

    Path Parameters

    SOD policy ID. @@ -89,7 +87,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -101,7 +99,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -117,4 +115,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-sod-violation-report-run-status.api.mdx b/docs/api/v3/get-sod-violation-report-run-status.api.mdx index 503f9003c..8b16ee7df 100644 --- a/docs/api/v3/get-sod-violation-report-run-status.api.mdx +++ b/docs/api/v3/get-sod-violation-report-run-status.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get violation report run status

    @@ -32,7 +30,7 @@ This gets the status for a violation report run task that has already been invok ## Request -

    Path Parameters

    +

    Path Parameters

    Status of the violation report run task. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-sod-violation-report-status.api.mdx b/docs/api/v3/get-sod-violation-report-status.api.mdx index 30b6d94cb..1aba37bf7 100644 --- a/docs/api/v3/get-sod-violation-report-status.api.mdx +++ b/docs/api/v3/get-sod-violation-report-status.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get SOD violation report status

    @@ -32,7 +30,7 @@ This gets the status for a violation report run task that has already been invok ## Request -

    Path Parameters

    +

    Path Parameters

    Status of the violation report run task. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-source-health.api.mdx b/docs/api/v3/get-source-health.api.mdx index 3ff60afc8..f1b5cd80e 100644 --- a/docs/api/v3/get-source-health.api.mdx +++ b/docs/api/v3/get-source-health.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Fetches source health by id

    @@ -32,7 +30,7 @@ This endpoint fetches source health by source's id ## Request -

    Path Parameters

    +

    Path Parameters

    Fetched source health successfully @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-source-schema.api.mdx b/docs/api/v3/get-source-schema.api.mdx index ec1bd2e6a..13326a09c 100644 --- a/docs/api/v3/get-source-schema.api.mdx +++ b/docs/api/v3/get-source-schema.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Source Schema by ID

    @@ -33,7 +31,7 @@ Get the Source Schema by ID in IdentityNow. ## Request -

    Path Parameters

    +

    Path Parameters

    The requested Schema was successfully retrieved. @@ -73,7 +71,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -85,7 +83,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -101,4 +99,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-source.api.mdx b/docs/api/v3/get-source.api.mdx index 4ef539129..e2049c24b 100644 --- a/docs/api/v3/get-source.api.mdx +++ b/docs/api/v3/get-source.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Source by ID

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required t ## Request -

    Path Parameters

    +

    Path Parameters

    A Source object @@ -107,7 +105,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -119,7 +117,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -135,4 +133,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-status-by-source-id.api.mdx b/docs/api/v3/get-status-by-source-id.api.mdx index 4ea3cf8f7..aeb6bc71c 100644 --- a/docs/api/v3/get-status-by-source-id.api.mdx +++ b/docs/api/v3/get-status-by-source-id.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Finds status of source usage

    @@ -32,7 +30,7 @@ This API returns the status of the source usage insights setup by IDN source ID. ## Request -

    Path Parameters

    +

    Path Parameters

    Status of the source usage insights setup by IDN source ID. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-status-check-details.api.mdx b/docs/api/v3/get-status-check-details.api.mdx index 0c435ba69..f4a3057cb 100644 --- a/docs/api/v3/get-status-check-details.api.mdx +++ b/docs/api/v3/get-status-check-details.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get the time check configuration

    @@ -32,7 +30,7 @@ Get the time check configuration of queued SDIM tickets. A token with Org Admin ## Request -
    +
    QueuedCheckConfigDetails containing the configured values @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-tagged-object.api.mdx b/docs/api/v3/get-tagged-object.api.mdx index 39161680f..40096b4a7 100644 --- a/docs/api/v3/get-tagged-object.api.mdx +++ b/docs/api/v3/get-tagged-object.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get Tagged Object

    @@ -32,7 +30,7 @@ This gets a tagged object for the specified type. ## Request -

    Path Parameters

    +

    Path Parameters

    Tagged object by type and ID. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-transform.api.mdx b/docs/api/v3/get-transform.api.mdx index 644657877..5dab020a4 100644 --- a/docs/api/v3/get-transform.api.mdx +++ b/docs/api/v3/get-transform.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Transform by ID

    @@ -33,7 +31,7 @@ A token with transform read authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    Transform with the given ID @@ -297,7 +295,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -309,7 +307,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -325,4 +323,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-usages-by-account-id.api.mdx b/docs/api/v3/get-usages-by-account-id.api.mdx index 1216d6d0a..ea9e0acf4 100644 --- a/docs/api/v3/get-usages-by-account-id.api.mdx +++ b/docs/api/v3/get-usages-by-account-id.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns account usage insights

    @@ -32,7 +30,7 @@ This API returns a summary of account usage insights for past 12 months. ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Summary of account usage insights for past 12 months. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-usages-by-source-id.api.mdx b/docs/api/v3/get-usages-by-source-id.api.mdx index 0a1036c33..d6d715e2f 100644 --- a/docs/api/v3/get-usages-by-source-id.api.mdx +++ b/docs/api/v3/get-usages-by-source-id.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Returns source usage insights

    @@ -32,7 +30,7 @@ This API returns a summary of source usage insights for past 12 months. ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    Summary of source usage insights for past 12 months. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-work-item.api.mdx b/docs/api/v3/get-work-item.api.mdx index f2027b59f..3bbacfa97 100644 --- a/docs/api/v3/get-work-item.api.mdx +++ b/docs/api/v3/get-work-item.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get a Work Item

    @@ -32,7 +30,7 @@ This gets the details of a Work Item belonging to either the specified user(admi ## Request -

    Path Parameters

    +

    Path Parameters

    The work item with the given ID. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/get-work-items-summary.api.mdx b/docs/api/v3/get-work-items-summary.api.mdx index 5519e3602..6af0ecc03 100644 --- a/docs/api/v3/get-work-items-summary.api.mdx +++ b/docs/api/v3/get-work-items-summary.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Work Items Summary

    @@ -32,7 +30,7 @@ This gets a summary of work items belonging to either the specified user(admin r ## Request -

    Query Parameters

    +

    Query Parameters

    List of work items @@ -52,7 +50,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/import-accounts-schema.api.mdx b/docs/api/v3/import-accounts-schema.api.mdx index 8f0508bb4..6a506def9 100644 --- a/docs/api/v3/import-accounts-schema.api.mdx +++ b/docs/api/v3/import-accounts-schema.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Uploads source accounts schema template

    @@ -38,7 +36,7 @@ Click **Admin** -\> **Connections** -\> **Sources** -\> **`{SourceName}`** -\> * ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    Successfully uploaded the file @@ -78,7 +76,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -94,4 +92,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/import-connector-file.api.mdx b/docs/api/v3/import-connector-file.api.mdx index 965ed8ece..a981807a1 100644 --- a/docs/api/v3/import-connector-file.api.mdx +++ b/docs/api/v3/import-connector-file.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Upload connector file to source

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    Uploaded the file successfully and sent all post-upload events @@ -107,7 +105,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -123,4 +121,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/import-entitlements-schema.api.mdx b/docs/api/v3/import-entitlements-schema.api.mdx index 7d7defb27..9afdf8513 100644 --- a/docs/api/v3/import-entitlements-schema.api.mdx +++ b/docs/api/v3/import-entitlements-schema.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Uploads source entitlements schema template

    @@ -38,7 +36,7 @@ Click **Admin** -\> **Connections** -\> **Sources** -\> **`{SourceName}`** -\> * ## Request -

    Path Parameters

    Query Parameters

    Body

    required
    +

    Path Parameters

    Query Parameters

    Body

    required
    Successfully uploaded the file @@ -78,7 +76,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -94,4 +92,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/import-identity-profiles.api.mdx b/docs/api/v3/import-identity-profiles.api.mdx index 73b1dee25..6edfd2f2f 100644 --- a/docs/api/v3/import-identity-profiles.api.mdx +++ b/docs/api/v3/import-identity-profiles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Import Identity Profiles

    @@ -56,7 +54,7 @@ The seaspray transformation definition. Arbitrary key-value pairs to store any metadata for the object -
  • ]
    • identityExceptionReportReference objectnullable
  • ]
    • +
  • ]
    • identityExceptionReportReference objectnullable
  • ]
    • The result of importing Identity Profiles. @@ -116,7 +114,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -132,4 +130,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/import-non-employee-records-in-bulk.api.mdx b/docs/api/v3/import-non-employee-records-in-bulk.api.mdx index 60335f881..a632c54a8 100644 --- a/docs/api/v3/import-non-employee-records-in-bulk.api.mdx +++ b/docs/api/v3/import-non-employee-records-in-bulk.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Imports, or Updates, Non-Employee Records

    @@ -32,7 +30,7 @@ This post will import, or update, Non-Employee records found in the CSV. Require ## Request -

    Path Parameters

    Body

    +

    Path Parameters

    Body

    The CSV was accepted to be bulk inserted now or at a later time. @@ -66,7 +64,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -78,7 +76,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -94,4 +92,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-access-profiles.api.mdx b/docs/api/v3/list-access-profiles.api.mdx index 407ec4c44..4e1c46197 100644 --- a/docs/api/v3/list-access-profiles.api.mdx +++ b/docs/api/v3/list-access-profiles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Access Profiles

    @@ -34,7 +32,7 @@ A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_ ## Request -

    Query Parameters

    +

    Query Parameters

    List of Access Profiles @@ -102,7 +100,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -118,4 +116,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-access-request-status.api.mdx b/docs/api/v3/list-access-request-status.api.mdx index 6676cb887..a51bf3c04 100644 --- a/docs/api/v3/list-access-request-status.api.mdx +++ b/docs/api/v3/list-access-request-status.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Access Request Status

    @@ -33,7 +31,7 @@ Any token with any authority can request their own status. A token with ORG_ADMI ## Request -

    Query Parameters

    +

    Query Parameters

    List of requested item status. @@ -169,7 +167,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -185,4 +183,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-account-activities.api.mdx b/docs/api/v3/list-account-activities.api.mdx index b5835a018..2c5b1d1bf 100644 --- a/docs/api/v3/list-account-activities.api.mdx +++ b/docs/api/v3/list-account-activities.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Account Activities

    @@ -32,7 +30,7 @@ This gets a collection of account activities that satisfy the given query parame ## Request -

    Query Parameters

    +

    Query Parameters

    List of account activities @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-accounts.api.mdx b/docs/api/v3/list-accounts.api.mdx index 1235d8232..1e71c9a16 100644 --- a/docs/api/v3/list-accounts.api.mdx +++ b/docs/api/v3/list-accounts.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Accounts List

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Query Parameters

    +

    Query Parameters

    List of account objects @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-campaign-filters.api.mdx b/docs/api/v3/list-campaign-filters.api.mdx index 75c569a28..857be7d09 100644 --- a/docs/api/v3/list-campaign-filters.api.mdx +++ b/docs/api/v3/list-campaign-filters.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Campaign Filters

    @@ -34,7 +32,7 @@ All Campaign Filters matching the query params ## Request -

    Query Parameters

    +

    Query Parameters

    List of campaign filter objects @@ -74,7 +72,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -90,4 +88,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-campaign-templates.api.mdx b/docs/api/v3/list-campaign-templates.api.mdx index c24be2a01..1b1908156 100644 --- a/docs/api/v3/list-campaign-templates.api.mdx +++ b/docs/api/v3/list-campaign-templates.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Campaign Templates

    @@ -34,7 +32,7 @@ All CampaignTemplates matching the query params ## Request -

    Query Parameters

    +

    Query Parameters

    List of campaign template objects @@ -114,7 +112,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -130,4 +128,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-certification-reviewers.api.mdx b/docs/api/v3/list-certification-reviewers.api.mdx index 4ae71bc3d..625b330c2 100644 --- a/docs/api/v3/list-certification-reviewers.api.mdx +++ b/docs/api/v3/list-certification-reviewers.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List of Reviewers for certification

    @@ -32,7 +30,7 @@ This API returns a list of reviewers for the certification. A token with ORG_ADM ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    A list of reviewers @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-completed-approvals.api.mdx b/docs/api/v3/list-completed-approvals.api.mdx index 1aa175cf2..97fadfdbb 100644 --- a/docs/api/v3/list-completed-approvals.api.mdx +++ b/docs/api/v3/list-completed-approvals.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Completed Access Request Approvals List

    @@ -32,7 +30,7 @@ This endpoint returns list of completed approvals. See *owner-id* query paramete ## Request -

    Query Parameters

    +

    Query Parameters

    List of Completed Approvals. @@ -152,7 +150,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -168,4 +166,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-identity-access-review-items.api.mdx b/docs/api/v3/list-identity-access-review-items.api.mdx index 7c5a01735..d954198b2 100644 --- a/docs/api/v3/list-identity-access-review-items.api.mdx +++ b/docs/api/v3/list-identity-access-review-items.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List of Access Review Items

    @@ -32,7 +30,7 @@ This API returns a list of access review items for an identity campaign certific ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    A list of access review items @@ -172,7 +170,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -184,7 +182,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -200,4 +198,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-identity-certifications.api.mdx b/docs/api/v3/list-identity-certifications.api.mdx index 6817b24b9..5714971d1 100644 --- a/docs/api/v3/list-identity-certifications.api.mdx +++ b/docs/api/v3/list-identity-certifications.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Identity Campaign Certifications by IDs

    @@ -32,7 +30,7 @@ This API returns a list of identity campaign certifications that satisfy the giv ## Request -

    Query Parameters

    +

    Query Parameters

    List of identity campaign certifications @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-identity-profiles.api.mdx b/docs/api/v3/list-identity-profiles.api.mdx index 1db803ca4..e7e9e2e91 100644 --- a/docs/api/v3/list-identity-profiles.api.mdx +++ b/docs/api/v3/list-identity-profiles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Identity Profiles List

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN or API authority is required to call this API to get a li ## Request -

    Query Parameters

    +

    Query Parameters

    List of identityProfiles. @@ -81,7 +79,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -97,4 +95,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-lifecycle-states.api.mdx b/docs/api/v3/list-lifecycle-states.api.mdx index 4376c17ed..e52f93b97 100644 --- a/docs/api/v3/list-lifecycle-states.api.mdx +++ b/docs/api/v3/list-lifecycle-states.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Lists LifecycleStates

    @@ -33,7 +31,7 @@ A token with API, or ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    List of LifecycleState objects @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -85,4 +83,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-non-employee-approvals.api.mdx b/docs/api/v3/list-non-employee-approvals.api.mdx index f226724e9..75423a656 100644 --- a/docs/api/v3/list-non-employee-approvals.api.mdx +++ b/docs/api/v3/list-non-employee-approvals.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get List of Non-Employee Approval Requests

    @@ -36,7 +34,7 @@ can list the approvals for any approver. ## Request -

    Query Parameters

    +

    Query Parameters

    List of approval items. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -88,4 +86,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-non-employee-records.api.mdx b/docs/api/v3/list-non-employee-records.api.mdx index 95621937d..75bc467b0 100644 --- a/docs/api/v3/list-non-employee-records.api.mdx +++ b/docs/api/v3/list-non-employee-records.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Non-Employee Records

    @@ -34,7 +32,7 @@ This gets a list of non-employee records. There are two contextual uses for this ## Request -

    Query Parameters

    +

    Query Parameters

    Non-Employee record objects @@ -70,7 +68,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -86,4 +84,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-non-employee-requests.api.mdx b/docs/api/v3/list-non-employee-requests.api.mdx index a15d65f0f..446b9f559 100644 --- a/docs/api/v3/list-non-employee-requests.api.mdx +++ b/docs/api/v3/list-non-employee-requests.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Non-Employee Requests

    @@ -36,7 +34,7 @@ provided as the `requested-for` value. This will provide the user with a list of ## Request -

    Query Parameters

    +

    Query Parameters

    List of non-employee request objects. @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-non-employee-sources.api.mdx b/docs/api/v3/list-non-employee-sources.api.mdx index eebe11ecd..913647674 100644 --- a/docs/api/v3/list-non-employee-sources.api.mdx +++ b/docs/api/v3/list-non-employee-sources.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Non-Employee Sources

    @@ -36,7 +34,7 @@ provided as the `requested-for` value. This will provide the user with a list of ## Request -

    Query Parameters

    +

    Query Parameters

    List of non-employee sources objects. @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-oauth-clients.api.mdx b/docs/api/v3/list-oauth-clients.api.mdx index c02b43fcd..e31081628 100644 --- a/docs/api/v3/list-oauth-clients.api.mdx +++ b/docs/api/v3/list-oauth-clients.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List OAuth Clients

    @@ -32,7 +30,7 @@ This gets a list of OAuth clients. ## Request -

    Query Parameters

    +

    Query Parameters

    List of OAuth clients. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-pending-approvals.api.mdx b/docs/api/v3/list-pending-approvals.api.mdx index 8c0c235d1..ebc0564ea 100644 --- a/docs/api/v3/list-pending-approvals.api.mdx +++ b/docs/api/v3/list-pending-approvals.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Pending Access Request Approvals List

    @@ -32,7 +30,7 @@ This endpoint returns a list of pending approvals. See "owner-id" query paramete ## Request -

    Query Parameters

    +

    Query Parameters

    List of Pending Approvals. @@ -132,7 +130,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -148,4 +146,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-personal-access-tokens.api.mdx b/docs/api/v3/list-personal-access-tokens.api.mdx index babf188d0..8708c9079 100644 --- a/docs/api/v3/list-personal-access-tokens.api.mdx +++ b/docs/api/v3/list-personal-access-tokens.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Personal Access Tokens

    @@ -32,7 +30,7 @@ This gets a collection of personal access tokens associated with the optional `o ## Request -

    Query Parameters

    +

    Query Parameters

    List of personal access tokens. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-provisioning-policies.api.mdx b/docs/api/v3/list-provisioning-policies.api.mdx index 61242e927..9dfb02374 100644 --- a/docs/api/v3/list-provisioning-policies.api.mdx +++ b/docs/api/v3/list-provisioning-policies.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Lists ProvisioningPolicies

    @@ -33,7 +31,7 @@ A token with API, or ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    List of ProvisioningPolicyDto objects @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-requestable-objects.api.mdx b/docs/api/v3/list-requestable-objects.api.mdx index 03eb7f1e0..f604a687d 100644 --- a/docs/api/v3/list-requestable-objects.api.mdx +++ b/docs/api/v3/list-requestable-objects.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Requestable Objects List

    @@ -33,7 +31,7 @@ Any authenticated token can call this endpoint to see their requestable access i ## Request -

    Query Parameters

    +

    Query Parameters

    List of requestable objects @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -81,4 +79,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-roles.api.mdx b/docs/api/v3/list-roles.api.mdx index 6b637f502..d4ef706cc 100644 --- a/docs/api/v3/list-roles.api.mdx +++ b/docs/api/v3/list-roles.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Roles

    @@ -34,7 +32,7 @@ A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required ## Request -

    Query Parameters

    +

    Query Parameters

    List of Roles @@ -122,7 +120,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -138,4 +136,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-saved-searches.api.mdx b/docs/api/v3/list-saved-searches.api.mdx index 50f5b28ed..63c2fa8a2 100644 --- a/docs/api/v3/list-saved-searches.api.mdx +++ b/docs/api/v3/list-saved-searches.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    A list of Saved Searches

    @@ -33,7 +31,7 @@ Returns a list of saved searches. ## Request -

    Query Parameters

    +

    Query Parameters

    The list of requested saved searches. @@ -106,7 +104,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -122,4 +120,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-scheduled-search.api.mdx b/docs/api/v3/list-scheduled-search.api.mdx index 8f8f766fe..d7a1464aa 100644 --- a/docs/api/v3/list-scheduled-search.api.mdx +++ b/docs/api/v3/list-scheduled-search.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List scheduled searches

    @@ -33,7 +31,7 @@ Returns a list of scheduled searches. ## Request -

    Query Parameters

    +

    Query Parameters

    The list of requested scheduled searches. @@ -99,7 +97,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -111,7 +109,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -127,4 +125,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-segments.api.mdx b/docs/api/v3/list-segments.api.mdx index 2b40fa6b1..b25175ef8 100644 --- a/docs/api/v3/list-segments.api.mdx +++ b/docs/api/v3/list-segments.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Segments

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN or API authority is required to call this API. ## Request -

    Query Parameters

    +

    Query Parameters

    List of all segments @@ -73,7 +71,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -89,4 +87,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-sod-policies.api.mdx b/docs/api/v3/list-sod-policies.api.mdx index 81fffde7f..b5c785584 100644 --- a/docs/api/v3/list-sod-policies.api.mdx +++ b/docs/api/v3/list-sod-policies.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List SOD policies

    @@ -33,7 +31,7 @@ Requires role of ORG_ADMIN ## Request -

    Query Parameters

    +

    Query Parameters

    List of all SOD policies. @@ -89,7 +87,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -105,4 +103,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-source-schemas.api.mdx b/docs/api/v3/list-source-schemas.api.mdx index 62acad1ea..bfcc96863 100644 --- a/docs/api/v3/list-source-schemas.api.mdx +++ b/docs/api/v3/list-source-schemas.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Schemas on a Source

    @@ -33,7 +31,7 @@ Lists the Schemas that exist on the specified Source in IdentityNow. ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    The Schemas were successfully retrieved. @@ -73,7 +71,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -85,7 +83,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -101,4 +99,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-sources.api.mdx b/docs/api/v3/list-sources.api.mdx index e6646b221..d394547a1 100644 --- a/docs/api/v3/list-sources.api.mdx +++ b/docs/api/v3/list-sources.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Lists all sources in IdentityNow.

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or ROLE_SUBADMIN authorit ## Request -

    Query Parameters

    +

    Query Parameters

    List of Source objects @@ -107,7 +105,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -119,7 +117,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -135,4 +133,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-tagged-objects-by-type.api.mdx b/docs/api/v3/list-tagged-objects-by-type.api.mdx index 2e1e05114..abb91d6f2 100644 --- a/docs/api/v3/list-tagged-objects-by-type.api.mdx +++ b/docs/api/v3/list-tagged-objects-by-type.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Tagged Objects by Type

    @@ -34,7 +32,7 @@ Any authenticated token may be used to call this API. ## Request -

    Path Parameters

    Query Parameters

    +

    Path Parameters

    Query Parameters

    List of all tagged objects for specified type. @@ -66,7 +64,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -82,4 +80,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-tagged-objects.api.mdx b/docs/api/v3/list-tagged-objects.api.mdx index 42d938dee..b3c528d8b 100644 --- a/docs/api/v3/list-tagged-objects.api.mdx +++ b/docs/api/v3/list-tagged-objects.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Tagged Objects

    @@ -34,7 +32,7 @@ Any authenticated token may be used to call this API. ## Request -

    Query Parameters

    +

    Query Parameters

    List of all tagged objects. @@ -66,7 +64,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -82,4 +80,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-transforms.api.mdx b/docs/api/v3/list-transforms.api.mdx index ad1f2c0e5..bb241ff0b 100644 --- a/docs/api/v3/list-transforms.api.mdx +++ b/docs/api/v3/list-transforms.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List transforms

    @@ -33,7 +31,7 @@ A token with transforms-list read authority is required to call this API. ## Request -

    Query Parameters

    +

    Query Parameters

    A list of transforms matching the given criteria. @@ -297,7 +295,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -309,7 +307,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -325,4 +323,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/list-work-items.api.mdx b/docs/api/v3/list-work-items.api.mdx index 52486ebf9..886c94faa 100644 --- a/docs/api/v3/list-work-items.api.mdx +++ b/docs/api/v3/list-work-items.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    List Work Items

    @@ -32,7 +30,7 @@ This gets a collection of work items belonging to either the specified user(admi ## Request -

    Query Parameters

    +

    Query Parameters

    List of work items @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/make-identity-decision.api.mdx b/docs/api/v3/make-identity-decision.api.mdx index 02cc4ed47..e990474c0 100644 --- a/docs/api/v3/make-identity-decision.api.mdx +++ b/docs/api/v3/make-identity-decision.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Decide on a Certification Item

    @@ -36,7 +34,7 @@ The API makes a decision to approve or revoke one or more identity campaign cert A non-empty array of decisions to be made. -
    +
    • Array [
      • recommendation objectnullable
    • ]
    An identity campaign certification object @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/move.api.mdx b/docs/api/v3/move.api.mdx index 4d2ee2b82..385e7a344 100644 --- a/docs/api/v3/move.api.mdx +++ b/docs/api/v3/move.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Reassign Certifications

    @@ -32,7 +30,7 @@ This API reassigns the specified certifications from one identity to another. A ## Request -

    Path Parameters

    Body

    required
      = 1`, `<= 250`"} schema={{"description":"List of certification IDs to reassign","type":"array","items":{"type":"string"},"minItems":1,"maxItems":250,"example":["af3859464779471211bb8424a563abc1","af3859464779471211bb8424a563abc2","af3859464779471211bb8424a563abc3"]}}>
      reassignTo object
    +

    Path Parameters

    Body

    required
      = 1`, `<= 250`"} schema={{"description":"List of certification IDs to reassign","type":"array","items":{"type":"string"},"minItems":1,"maxItems":250,"example":["af3859464779471211bb8424a563abc1","af3859464779471211bb8424a563abc2","af3859464779471211bb8424a563abc3"]}}>
      reassignTo object
    The reassign task that has been submitted. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -84,7 +82,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -100,4 +98,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/patch-access-profile.api.mdx b/docs/api/v3/patch-access-profile.api.mdx index 9a8806d63..d14f908da 100644 --- a/docs/api/v3/patch-access-profile.api.mdx +++ b/docs/api/v3/patch-access-profile.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Patch a specified Access Profile

    @@ -83,7 +81,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • Responds with the Access Profile as updated. @@ -151,7 +149,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -167,4 +165,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/patch-auth-org-network-config.api.mdx b/docs/api/v3/patch-auth-org-network-config.api.mdx index 788d55a1b..0d3337624 100644 --- a/docs/api/v3/patch-auth-org-network-config.api.mdx +++ b/docs/api/v3/patch-auth-org-network-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update security network configuration.

    @@ -62,7 +60,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • Updated Auth Org network configuration. @@ -94,7 +92,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -106,7 +104,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -122,4 +120,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/patch-auth-user.api.mdx b/docs/api/v3/patch-auth-user.api.mdx index c214f233d..4e1da06d6 100644 --- a/docs/api/v3/patch-auth-user.api.mdx +++ b/docs/api/v3/patch-auth-user.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Auth User Update

    @@ -60,7 +58,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • Auth user updated. @@ -92,7 +90,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -104,7 +102,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -120,4 +118,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/patch-campaign-template.api.mdx b/docs/api/v3/patch-campaign-template.api.mdx index 21c6c45ea..be2a0ad84 100644 --- a/docs/api/v3/patch-campaign-template.api.mdx +++ b/docs/api/v3/patch-campaign-template.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update a Campaign Template

    @@ -63,7 +61,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • Indicates the PATCH operation succeeded, and returns the template's new representation. @@ -143,7 +141,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -155,7 +153,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -171,4 +169,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/patch-non-employee-record.api.mdx b/docs/api/v3/patch-non-employee-record.api.mdx index 111bc0b6b..b46ec7c27 100644 --- a/docs/api/v3/patch-non-employee-record.api.mdx +++ b/docs/api/v3/patch-non-employee-record.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Patch Non-Employee Record

    @@ -60,7 +58,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • A patched non-employee record. @@ -96,7 +94,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -108,7 +106,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -124,4 +122,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/patch-non-employee-schema-attribute.api.mdx b/docs/api/v3/patch-non-employee-schema-attribute.api.mdx index de15758e6..11079867a 100644 --- a/docs/api/v3/patch-non-employee-schema-attribute.api.mdx +++ b/docs/api/v3/patch-non-employee-schema-attribute.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Patch a Schema Attribute for Non-Employee Source

    @@ -58,7 +56,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • The Schema Attribute was successfully patched. @@ -90,7 +88,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -102,7 +100,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -118,4 +116,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/patch-non-employee-source.api.mdx b/docs/api/v3/patch-non-employee-source.api.mdx index 1a0edc3f0..34c6d6a47 100644 --- a/docs/api/v3/patch-non-employee-source.api.mdx +++ b/docs/api/v3/patch-non-employee-source.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Patch a Non-Employee Source

    @@ -56,7 +54,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • A patched non-employee source object. @@ -96,7 +94,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -112,4 +110,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/patch-oauth-client.api.mdx b/docs/api/v3/patch-oauth-client.api.mdx index 6f0c36b4e..b780a3cb2 100644 --- a/docs/api/v3/patch-oauth-client.api.mdx +++ b/docs/api/v3/patch-oauth-client.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Patch OAuth Client

    @@ -72,7 +70,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • Indicates the PATCH operation succeeded, and returns the OAuth client's new representation. @@ -104,7 +102,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -116,7 +114,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -132,4 +130,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/patch-personal-access-token.api.mdx b/docs/api/v3/patch-personal-access-token.api.mdx index 259cfcfca..b91f44425 100644 --- a/docs/api/v3/patch-personal-access-token.api.mdx +++ b/docs/api/v3/patch-personal-access-token.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Patch Personal Access Token

    @@ -61,7 +59,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • Indicates the PATCH operation succeeded, and returns the PAT's new representation. @@ -97,7 +95,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -109,7 +107,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -125,4 +123,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/patch-role.api.mdx b/docs/api/v3/patch-role.api.mdx index 9c1ff6a6a..bd1001aec 100644 --- a/docs/api/v3/patch-role.api.mdx +++ b/docs/api/v3/patch-role.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Patch a specified Role

    @@ -56,7 +54,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • Responds with the Role as updated. @@ -144,7 +142,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -160,4 +158,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/patch-segment.api.mdx b/docs/api/v3/patch-segment.api.mdx index 0e26f6a72..0656ee091 100644 --- a/docs/api/v3/patch-segment.api.mdx +++ b/docs/api/v3/patch-segment.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Segment

    @@ -50,7 +48,7 @@ The following fields are patchable: object -
  • ]
    • +
  • ]
    • Indicates the PATCH operation succeeded, and returns the segment's new representation. @@ -90,7 +88,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -102,7 +100,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -118,4 +116,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/patch-service-desk-integration.api.mdx b/docs/api/v3/patch-service-desk-integration.api.mdx index 26ffc6bef..7c1c3e5e0 100644 --- a/docs/api/v3/patch-service-desk-integration.api.mdx +++ b/docs/api/v3/patch-service-desk-integration.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Service Desk Integration Update PATCH

    @@ -65,7 +63,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • ServiceDeskIntegrationDto as updated @@ -125,7 +123,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -137,7 +135,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -153,4 +151,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/patch-sod-policy.api.mdx b/docs/api/v3/patch-sod-policy.api.mdx index 922d5c1dd..9bb8d51ea 100644 --- a/docs/api/v3/patch-sod-policy.api.mdx +++ b/docs/api/v3/patch-sod-policy.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Patch SOD policy by ID

    @@ -72,7 +70,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • Indicates the PATCH operation succeeded, and returns the SOD policy's new representation. @@ -128,7 +126,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -140,7 +138,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -156,4 +154,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/put-account.api.mdx b/docs/api/v3/put-account.api.mdx index 6f2843dc8..5c368af23 100644 --- a/docs/api/v3/put-account.api.mdx +++ b/docs/api/v3/put-account.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Account

    @@ -39,7 +37,7 @@ A token with ORG_ADMIN authority is required to call this API. The schema attribute values for the account -
    +
    Async task details. @@ -71,7 +69,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -83,7 +81,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -99,4 +97,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/put-correlation-config.api.mdx b/docs/api/v3/put-correlation-config.api.mdx index 06ed4c65c..414676983 100644 --- a/docs/api/v3/put-correlation-config.api.mdx +++ b/docs/api/v3/put-correlation-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    putCorrelationConfig

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    The connector's update detail @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/put-password-dictionary.api.mdx b/docs/api/v3/put-password-dictionary.api.mdx index e80d104bb..4a6c0a1c0 100644 --- a/docs/api/v3/put-password-dictionary.api.mdx +++ b/docs/api/v3/put-password-dictionary.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Password Dictionary

    @@ -65,7 +63,7 @@ qazxsws The password dictionary file to be uploaded. -
    +
    Successfully updated. @@ -101,7 +99,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -113,7 +111,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -129,4 +127,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/put-password-org-config.api.mdx b/docs/api/v3/put-password-org-config.api.mdx index 005aa3083..7c5b64e71 100644 --- a/docs/api/v3/put-password-org-config.api.mdx +++ b/docs/api/v3/put-password-org-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Password Org Config

    @@ -34,7 +32,7 @@ Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config: ## Request -

    Body

    required
      = 1` and `<= 60`"} schema={{"type":"integer","format":"int32","description":"The duration of \"digit token\" in minutes. The default value is 5.","minimum":1,"maximum":60,"default":5,"example":10}}>= 6` and `<= 18`"} schema={{"type":"integer","format":"int32","description":"The length of \"digit token\". The default value is 6.","minimum":6,"maximum":18,"default":6,"example":9}}>
    +

    Body

    required
      = 1` and `<= 60`"} schema={{"type":"integer","format":"int32","description":"The duration of \"digit token\" in minutes. The default value is 5.","minimum":1,"maximum":60,"default":5,"example":10}}>= 6` and `<= 18`"} schema={{"type":"integer","format":"int32","description":"The length of \"digit token\". The default value is 6.","minimum":6,"maximum":18,"default":6,"example":9}}>
    Reference to the password org config. @@ -66,7 +64,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -82,4 +80,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/put-policy-schedule.api.mdx b/docs/api/v3/put-policy-schedule.api.mdx index 5e78cf6d5..d5b0f37cb 100644 --- a/docs/api/v3/put-policy-schedule.api.mdx +++ b/docs/api/v3/put-policy-schedule.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update SOD Policy schedule

    @@ -54,7 +52,7 @@ If `type` is `MONTHLY` or `ANNUALLY`, the values will be a number in double quot The hours selected. -
    recipients object[]
  • Array [
  • ]
    • +
    recipients object[]
  • Array [
  • ]
    • Created or updated SOD policy schedule. @@ -108,7 +106,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -124,4 +122,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/put-provisioning-policy.api.mdx b/docs/api/v3/put-provisioning-policy.api.mdx index 9b34e622c..d251a1175 100644 --- a/docs/api/v3/put-provisioning-policy.api.mdx +++ b/docs/api/v3/put-provisioning-policy.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Provisioning Policy by UsageType

    @@ -35,7 +33,7 @@ A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is requi ## Request -

    Path Parameters

    Body

    required
      fields object[]
    • Array [
    • ]
    +

    Path Parameters

    Body

    required
      fields object[]
    • Array [
    • ]
    The ProvisioningPolicyDto was successfully replaced. @@ -67,7 +65,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -79,7 +77,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -95,4 +93,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/put-saved-search.api.mdx b/docs/api/v3/put-saved-search.api.mdx index d4860b9ae..441e03958 100644 --- a/docs/api/v3/put-saved-search.api.mdx +++ b/docs/api/v3/put-saved-search.api.mdx @@ -20,8 +20,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Updates an existing saved search @@ -79,7 +77,7 @@ The lower bound of the range. The upper bound of the range. -
    +
    The persisted saved search. @@ -148,7 +146,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -164,4 +162,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/put-service-desk-integration.api.mdx b/docs/api/v3/put-service-desk-integration.api.mdx index e3b5f91ab..6fb774a9a 100644 --- a/docs/api/v3/put-service-desk-integration.api.mdx +++ b/docs/api/v3/put-service-desk-integration.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update a Service Desk integration

    @@ -64,7 +62,7 @@ Service Desk integration's attributes. Validation constraints enforced by the im Before Provisioning Rule. -
    +
    ServiceDeskIntegrationDto as updated @@ -124,7 +122,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -136,7 +134,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -152,4 +150,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/put-sod-policy.api.mdx b/docs/api/v3/put-sod-policy.api.mdx index 17c9d10cc..acc09dc79 100644 --- a/docs/api/v3/put-sod-policy.api.mdx +++ b/docs/api/v3/put-sod-policy.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update SOD policy by ID

    @@ -57,7 +55,7 @@ List of criteria. There is a min of 1 and max of 50 items in the list. List of criteria. There is a min of 1 and max of 50 items in the list. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • SOD Policy by ID @@ -113,7 +111,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -125,7 +123,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -141,4 +139,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/put-source-config.api.mdx b/docs/api/v3/put-source-config.api.mdx index a7ad2730a..299132a4f 100644 --- a/docs/api/v3/put-source-config.api.mdx +++ b/docs/api/v3/put-source-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    putSourceConfig

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    The connector's update detail @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/put-source-schema.api.mdx b/docs/api/v3/put-source-schema.api.mdx index c676bc711..1023036f3 100644 --- a/docs/api/v3/put-source-schema.api.mdx +++ b/docs/api/v3/put-source-schema.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Source Schema (Full)

    @@ -50,7 +48,7 @@ The attribute definitions which form the schema. A reference to the schema on the source to the attribute values map to. -
  • ]
    • +
  • ]
    • The Schema was successfully replaced. @@ -90,7 +88,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -102,7 +100,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -118,4 +116,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/put-source-template.api.mdx b/docs/api/v3/put-source-template.api.mdx index afccf0ad2..918d2e919 100644 --- a/docs/api/v3/put-source-template.api.mdx +++ b/docs/api/v3/put-source-template.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    putSourceTemplate

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    The connector's update detail @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/put-source.api.mdx b/docs/api/v3/put-source.api.mdx index d74350ef4..3eb386906 100644 --- a/docs/api/v3/put-source.api.mdx +++ b/docs/api/v3/put-source.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Source (Full)

    @@ -89,7 +87,7 @@ List of references to the associated PasswordPolicy objects. Reference to Management Workgroup for this Source -
    +
    Updated Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design. @@ -163,7 +161,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -175,7 +173,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -191,4 +189,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/put-tagged-object.api.mdx b/docs/api/v3/put-tagged-object.api.mdx index 3bd215e2d..e37ccd970 100644 --- a/docs/api/v3/put-tagged-object.api.mdx +++ b/docs/api/v3/put-tagged-object.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Tagged Object

    @@ -32,7 +30,7 @@ This updates a tagged object for the specified type. ## Request -

    Path Parameters

    Body

    required
      objectRef object
    +

    Path Parameters

    Body

    required
      objectRef object
    Tagged object by type and ID. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/put-translations.api.mdx b/docs/api/v3/put-translations.api.mdx index 57b7c8145..0036088c2 100644 --- a/docs/api/v3/put-translations.api.mdx +++ b/docs/api/v3/put-translations.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    putTranslations

    @@ -37,7 +35,7 @@ A token with ORG_ADMIN authority is required to call this API. object -
    +
    The connector's update detail @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -81,7 +79,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -97,4 +95,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/query-password-info.api.mdx b/docs/api/v3/query-password-info.api.mdx index 7ad921edd..e73a5e561 100644 --- a/docs/api/v3/query-password-info.api.mdx +++ b/docs/api/v3/query-password-info.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Query Password Info

    @@ -40,7 +38,7 @@ will be returned. ## Request -

    Body

    required
    +

    Body

    required
    Reference to the password info. @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/reassign-identity-certifications.api.mdx b/docs/api/v3/reassign-identity-certifications.api.mdx index 1857658a7..4c38eb954 100644 --- a/docs/api/v3/reassign-identity-certifications.api.mdx +++ b/docs/api/v3/reassign-identity-certifications.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Reassign Identities or Items

    @@ -32,7 +30,7 @@ This API reassigns up to 50 identities or items in an identity campaign certific ## Request -

    Path Parameters

    Body

    required
      reassign object[]required
    • Array [
    • ]
    +

    Path Parameters

    Body

    required
      reassign object[]required
    • Array [
    • ]
    An identity campaign certification details after completing the reassignment. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/reject-access-request.api.mdx b/docs/api/v3/reject-access-request.api.mdx index 8dd936b63..abd1d7197 100644 --- a/docs/api/v3/reject-access-request.api.mdx +++ b/docs/api/v3/reject-access-request.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Rejects an access request approval.

    @@ -40,7 +38,7 @@ Reviewer's comment. Author of the comment -
    +
    Accepted - Returned if the request was successfully accepted into the system. @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -88,7 +86,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -104,4 +102,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/reject-approval-item.api.mdx b/docs/api/v3/reject-approval-item.api.mdx index b80e0f8f4..617d5cc09 100644 --- a/docs/api/v3/reject-approval-item.api.mdx +++ b/docs/api/v3/reject-approval-item.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Reject an Approval Item

    @@ -32,7 +30,7 @@ This API rejects an Approval Item. Either an admin, or the owning/current user m ## Request -

    Path Parameters

    +

    Path Parameters

    A work items details object. @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -88,7 +86,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -104,4 +102,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/reject-approval-items-in-bulk.api.mdx b/docs/api/v3/reject-approval-items-in-bulk.api.mdx index e44462925..c98631d64 100644 --- a/docs/api/v3/reject-approval-items-in-bulk.api.mdx +++ b/docs/api/v3/reject-approval-items-in-bulk.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Bulk reject Approval Items

    @@ -32,7 +30,7 @@ This API bulk rejects Approval Items. Either an admin, or the owning/current use ## Request -

    Path Parameters

    +

    Path Parameters

    A work items details object. @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -88,7 +86,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -104,4 +102,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/reject-non-employee-request.api.mdx b/docs/api/v3/reject-non-employee-request.api.mdx index 351d7a1c4..c08573f03 100644 --- a/docs/api/v3/reject-non-employee-request.api.mdx +++ b/docs/api/v3/reject-non-employee-request.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Reject a Non-Employee Request

    @@ -32,7 +30,7 @@ This endpoint will reject an approval item request and notify user. The current ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    Non-Employee approval item object. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/reload-account.api.mdx b/docs/api/v3/reload-account.api.mdx index 9263c9191..e24934847 100644 --- a/docs/api/v3/reload-account.api.mdx +++ b/docs/api/v3/reload-account.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Reload Account

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    Async task details @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/search-aggregate.api.mdx b/docs/api/v3/search-aggregate.api.mdx index fe2156db7..382f42f19 100644 --- a/docs/api/v3/search-aggregate.api.mdx +++ b/docs/api/v3/search-aggregate.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Perform a Search Query Aggregation

    @@ -124,7 +122,7 @@ The lower bound of the range. The upper bound of the range. -
    +
    Aggregation results. @@ -273,7 +271,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -289,4 +287,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/search-count.api.mdx b/docs/api/v3/search-count.api.mdx index cc3997f52..0cc34232b 100644 --- a/docs/api/v3/search-count.api.mdx +++ b/docs/api/v3/search-count.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Count Documents Satisfying a Query

    @@ -124,7 +122,7 @@ The lower bound of the range. The upper bound of the range. -
    +
    No content - indicates the request was successful but there is no content to be returned in the response. @@ -160,7 +158,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -176,4 +174,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/search-get.api.mdx b/docs/api/v3/search-get.api.mdx index c58cacc0c..0da26c6f6 100644 --- a/docs/api/v3/search-get.api.mdx +++ b/docs/api/v3/search-get.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Get a Document by ID

    @@ -32,7 +30,7 @@ Fetches a single document from the specified index, using the specified document ## Request -

    Path Parameters

    +

    Path Parameters

    The requested document. @@ -140,7 +138,7 @@ Segments with the role. Entitlements included with the role. -
  • Array [
  • ]
    • AccessProfile Entitlement Event Identity Role
    +
  • Array [
  • ]

    • AccessProfile

    Entitlement

    Event

    Identity

    Role

    Client Error - Returned if the request body is invalid. @@ -168,7 +166,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -180,7 +178,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -196,4 +194,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/search-post.api.mdx b/docs/api/v3/search-post.api.mdx index b75dcfae0..73fe50906 100644 --- a/docs/api/v3/search-post.api.mdx +++ b/docs/api/v3/search-post.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Perform Search

    @@ -124,7 +122,7 @@ The lower bound of the range. The upper bound of the range. -
    +
    List of matching documents. @@ -236,7 +234,7 @@ Segments with the role. Entitlements included with the role. -
  • Array [
  • ]
  • ]
    • A collection of AccessProfiles A collection of Entitlements A collection of Events A collection of Identities A collection of Roles
    +
  • Array [
  • ]
  • ]

    • A collection of AccessProfiles

    A collection of Entitlements

    A collection of Events

    A collection of Identities

    A collection of Roles

    Client Error - Returned if the request body is invalid. @@ -264,7 +262,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -280,4 +278,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/set-access-request-config.api.mdx b/docs/api/v3/set-access-request-config.api.mdx index 02d6bf25e..ec19b6852 100644 --- a/docs/api/v3/set-access-request-config.api.mdx +++ b/docs/api/v3/set-access-request-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Access Request Configuration

    @@ -45,7 +43,7 @@ Approval Reminder and Escalation Configuration. Entitlement Request Configuration. -
    +
    Access Request Configuration Details. @@ -89,7 +87,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -105,4 +103,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/set-branding-item.api.mdx b/docs/api/v3/set-branding-item.api.mdx index c4648eb17..543c49dd2 100644 --- a/docs/api/v3/set-branding-item.api.mdx +++ b/docs/api/v3/set-branding-item.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update a branding item

    @@ -33,7 +31,7 @@ A token with API, ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    Branding item updated @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/set-campaign-reports-config.api.mdx b/docs/api/v3/set-campaign-reports-config.api.mdx index c3099894f..1eda8c670 100644 --- a/docs/api/v3/set-campaign-reports-config.api.mdx +++ b/docs/api/v3/set-campaign-reports-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Set Campaign Reports Configuration

    @@ -37,7 +35,7 @@ Requires roles CERT_ADMIN and ORG_ADMIN. Campaign Report Configuration -
    +
    The persisted Campaign Report Configuration @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -85,4 +83,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/set-campaign-template-schedule.api.mdx b/docs/api/v3/set-campaign-template-schedule.api.mdx index 339f7aead..e9bcec466 100644 --- a/docs/api/v3/set-campaign-template-schedule.api.mdx +++ b/docs/api/v3/set-campaign-template-schedule.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Sets a Campaign Template's Schedule

    @@ -104,7 +102,7 @@ At 5AM, noon, and 5PM: * values "5", "12", "17" -
    +
    No content - indicates the request was successful but there is no content to be returned in the response. @@ -136,7 +134,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -148,7 +146,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -164,4 +162,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/set-lifecycle-state.api.mdx b/docs/api/v3/set-lifecycle-state.api.mdx index cf4a3b3ed..f3e1658a0 100644 --- a/docs/api/v3/set-lifecycle-state.api.mdx +++ b/docs/api/v3/set-lifecycle-state.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Set Lifecycle State

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN or API authority is required to call this API. ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    The request was successfully accepted into the system. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/set-password.api.mdx b/docs/api/v3/set-password.api.mdx index 78ca3dc04..4976667cd 100644 --- a/docs/api/v3/set-password.api.mdx +++ b/docs/api/v3/set-password.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Set Identity's Password

    @@ -73,7 +71,7 @@ You can then use [Get Password Change Request Status](https://developer.sailpoin ## Request -

    Body

    required
    +

    Body

    required
    Reference to the password change. @@ -105,7 +103,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -121,4 +119,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/set-tag-to-object.api.mdx b/docs/api/v3/set-tag-to-object.api.mdx index 3df004f36..789f06fdc 100644 --- a/docs/api/v3/set-tag-to-object.api.mdx +++ b/docs/api/v3/set-tag-to-object.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Add Tag to Object

    @@ -34,7 +32,7 @@ Any authenticated token may be used to call this API. ## Request -

    Body

    required
      objectRef object
    +

    Body

    required
      objectRef object
    Created. @@ -66,7 +64,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -82,4 +80,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/set-tags-to-many-objects.api.mdx b/docs/api/v3/set-tags-to-many-objects.api.mdx index eba2b445d..8cc4ae7dd 100644 --- a/docs/api/v3/set-tags-to-many-objects.api.mdx +++ b/docs/api/v3/set-tags-to-many-objects.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Tag Multiple Objects

    @@ -38,7 +36,7 @@ A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. -
    +
      objectRefs object[]
    • Array [
    • ]
    Request succeeded. @@ -70,7 +68,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -86,4 +84,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/sidebar.js b/docs/api/v3/sidebar.js index 3e47d3682..b29e74f5e 100644 --- a/docs/api/v3/sidebar.js +++ b/docs/api/v3/sidebar.js @@ -1 +1 @@ -module.exports = [{"type":"doc","id":"api/v3/identitynow-v-3-api"},{"type":"category","label":"Access Profiles","link":{"type":"doc","id":"api/v3/access-profiles"},"items":[{"type":"doc","id":"api/v3/list-access-profiles","label":"List Access Profiles","className":"api-method get"},{"type":"doc","id":"api/v3/create-access-profile","label":"Create an Access Profile","className":"api-method post"},{"type":"doc","id":"api/v3/get-access-profile","label":"Get an Access Profile","className":"api-method get"},{"type":"doc","id":"api/v3/patch-access-profile","label":"Patch a specified Access Profile","className":"api-method patch"},{"type":"doc","id":"api/v3/delete-access-profile","label":"Delete the specified Access Profile","className":"api-method delete"},{"type":"doc","id":"api/v3/delete-access-profiles-in-bulk","label":"Delete Access Profile(s)","className":"api-method post"},{"type":"doc","id":"api/v3/get-access-profile-entitlements","label":"List Access Profile's Entitlements","className":"api-method get"}]},{"type":"category","label":"Access Request Approvals","link":{"type":"doc","id":"api/v3/access-request-approvals"},"items":[{"type":"doc","id":"api/v3/list-pending-approvals","label":"Pending Access Request Approvals List","className":"api-method get"},{"type":"doc","id":"api/v3/list-completed-approvals","label":"Completed Access Request Approvals List","className":"api-method get"},{"type":"doc","id":"api/v3/approve-access-request","label":"Approves an access request approval.","className":"api-method post"},{"type":"doc","id":"api/v3/reject-access-request","label":"Rejects an access request approval.","className":"api-method post"},{"type":"doc","id":"api/v3/forward-access-request","label":"Forwards an access request approval.","className":"api-method post"},{"type":"doc","id":"api/v3/get-access-request-approval-summary","label":"Get the number of access-requests-approvals","className":"api-method get"}]},{"type":"category","label":"Access Requests","link":{"type":"doc","id":"api/v3/access-requests"},"items":[{"type":"doc","id":"api/v3/create-access-request","label":"Submit an Access Request","className":"api-method post"},{"type":"doc","id":"api/v3/cancel-access-request","label":"Cancel Access Request","className":"api-method post"},{"type":"doc","id":"api/v3/get-access-request-config","label":"Get Access Request Configuration","className":"api-method get"},{"type":"doc","id":"api/v3/set-access-request-config","label":"Update Access Request Configuration","className":"api-method put"},{"type":"doc","id":"api/v3/list-access-request-status","label":"Access Request Status","className":"api-method get"}]},{"type":"category","label":"Account Usages","link":{"type":"doc","id":"api/v3/account-usages"},"items":[{"type":"doc","id":"api/v3/get-usages-by-account-id","label":"Returns account usage insights","className":"api-method get"}]},{"type":"category","label":"Accounts","link":{"type":"doc","id":"api/v3/accounts"},"items":[{"type":"doc","id":"api/v3/list-accounts","label":"Accounts List","className":"api-method get"},{"type":"doc","id":"api/v3/create-account","label":"Create Account","className":"api-method post"},{"type":"doc","id":"api/v3/get-account","label":"Account Details","className":"api-method get"},{"type":"doc","id":"api/v3/update-account","label":"Update Account","className":"api-method patch"},{"type":"doc","id":"api/v3/put-account","label":"Update Account","className":"api-method put"},{"type":"doc","id":"api/v3/delete-account","label":"Delete Account","className":"api-method delete"},{"type":"doc","id":"api/v3/get-account-entitlements","label":"Account Entitlements","className":"api-method get"},{"type":"doc","id":"api/v3/reload-account","label":"Reload Account","className":"api-method post"},{"type":"doc","id":"api/v3/enable-account","label":"Enable Account","className":"api-method post"},{"type":"doc","id":"api/v3/disable-account","label":"Disable Account","className":"api-method post"},{"type":"doc","id":"api/v3/unlock-account","label":"Unlock Account","className":"api-method post"}]},{"type":"category","label":"Account Activities","link":{"type":"doc","id":"api/v3/account-activities"},"items":[{"type":"doc","id":"api/v3/list-account-activities","label":"List Account Activities","className":"api-method get"},{"type":"doc","id":"api/v3/get-account-activity","label":"Get an Account Activity","className":"api-method get"}]},{"type":"category","label":"Auth User","link":{"type":"doc","id":"api/v3/auth-user"},"items":[{"type":"doc","id":"api/v3/get-auth-user","label":"Auth User Details","className":"api-method get"},{"type":"doc","id":"api/v3/patch-auth-user","label":"Auth User Update","className":"api-method patch"}]},{"type":"category","label":"Branding","link":{"type":"doc","id":"api/v3/branding"},"items":[{"type":"doc","id":"api/v3/get-branding-list","label":"List of branding items","className":"api-method get"},{"type":"doc","id":"api/v3/create-branding-item","label":"Create a branding item","className":"api-method post"},{"type":"doc","id":"api/v3/get-branding","label":"Get a branding item","className":"api-method get"},{"type":"doc","id":"api/v3/set-branding-item","label":"Update a branding item","className":"api-method put"},{"type":"doc","id":"api/v3/delete-branding","label":"Delete a branding item","className":"api-method delete"}]},{"type":"category","label":"Certification Campaigns","link":{"type":"doc","id":"api/v3/certification-campaigns"},"items":[{"type":"doc","id":"api/v3/get-active-campaigns","label":"List Campaigns","className":"api-method get"},{"type":"doc","id":"api/v3/create-campaign","label":"Create a campaign","className":"api-method post"},{"type":"doc","id":"api/v3/get-campaign","label":"Get a campaign","className":"api-method get"},{"type":"doc","id":"api/v3/update-campaign","label":"Update a Campaign","className":"api-method patch"},{"type":"doc","id":"api/v3/move","label":"Reassign Certifications","className":"api-method post"},{"type":"doc","id":"api/v3/start-campaign","label":"Activate a Campaign","className":"api-method post"},{"type":"doc","id":"api/v3/complete-campaign","label":"Complete a Campaign","className":"api-method post"},{"type":"doc","id":"api/v3/delete-campaigns","label":"Deletes Campaigns","className":"api-method post"},{"type":"doc","id":"api/v3/start-campaign-remediation-scan","label":"Run Campaign Remediation Scan","className":"api-method post"},{"type":"doc","id":"api/v3/get-campaign-reports","label":"Get Campaign Reports","className":"api-method get"},{"type":"doc","id":"api/v3/start-campaign-report","label":"Run Campaign Report","className":"api-method post"},{"type":"doc","id":"api/v3/get-campaign-reports-config","label":"Get Campaign Reports Configuration","className":"api-method get"},{"type":"doc","id":"api/v3/set-campaign-reports-config","label":"Set Campaign Reports Configuration","className":"api-method put"},{"type":"doc","id":"api/v3/create-campaign-template","label":"Create a Campaign Template","className":"api-method post"},{"type":"doc","id":"api/v3/list-campaign-templates","label":"List Campaign Templates","className":"api-method get"},{"type":"doc","id":"api/v3/patch-campaign-template","label":"Update a Campaign Template","className":"api-method patch"},{"type":"doc","id":"api/v3/get-campaign-template","label":"Get a Campaign Template","className":"api-method get"},{"type":"doc","id":"api/v3/delete-campaign-template","label":"Delete a Campaign Template","className":"api-method delete"},{"type":"doc","id":"api/v3/get-campaign-template-schedule","label":"Gets a Campaign Template's Schedule","className":"api-method get"},{"type":"doc","id":"api/v3/set-campaign-template-schedule","label":"Sets a Campaign Template's Schedule","className":"api-method put"},{"type":"doc","id":"api/v3/delete-campaign-template-schedule","label":"Deletes a Campaign Template's Schedule","className":"api-method delete"},{"type":"doc","id":"api/v3/start-generate-campaign-template","label":"Generate a Campaign from Template","className":"api-method post"}]},{"type":"category","label":"Certifications","link":{"type":"doc","id":"api/v3/certifications"},"items":[{"type":"doc","id":"api/v3/list-identity-certifications","label":"Identity Campaign Certifications by IDs","className":"api-method get"},{"type":"doc","id":"api/v3/get-identity-certification","label":"Identity Certification by ID","className":"api-method get"},{"type":"doc","id":"api/v3/list-identity-access-review-items","label":"List of Access Review Items","className":"api-method get"},{"type":"doc","id":"api/v3/make-identity-decision","label":"Decide on a Certification Item","className":"api-method post"},{"type":"doc","id":"api/v3/reassign-identity-certifications","label":"Reassign Identities or Items","className":"api-method post"},{"type":"doc","id":"api/v3/sign-off-identity-certification","label":"Finalize Identity Certification Decisions","className":"api-method post"},{"type":"doc","id":"api/v3/get-identity-certification-item-permissions","label":"Permissions for Entitlement Certification Item","className":"api-method get"},{"type":"doc","id":"api/v3/list-certification-reviewers","label":"List of Reviewers for certification","className":"api-method get"},{"type":"doc","id":"api/v3/submit-reassign-certs-async","label":"Reassign Certifications Asynchronously","className":"api-method post"},{"type":"doc","id":"api/v3/get-certification-task","label":"Certification Task by ID","className":"api-method get"},{"type":"doc","id":"api/v3/get-pending-certification-tasks","label":"List of Pending Certification Tasks","className":"api-method get"}]},{"type":"category","label":"Certification Summaries","link":{"type":"doc","id":"api/v3/certification-summaries"},"items":[{"type":"doc","id":"api/v3/get-identity-decision-summary","label":"Summary of Certification Decisions","className":"api-method get"},{"type":"doc","id":"api/v3/get-identity-summaries","label":"Identity Summaries for Campaign Certification","className":"api-method get"},{"type":"doc","id":"api/v3/get-identity-access-summaries","label":"Access Summaries","className":"api-method get"},{"type":"doc","id":"api/v3/get-identity-summary","label":"Summary for Identity","className":"api-method get"}]},{"type":"category","label":"Certification Campaign Filters","link":{"type":"doc","id":"api/v3/certification-campaign-filters"},"items":[{"type":"doc","id":"api/v3/create-campaign-filter","label":"Create a Campaign Filter","className":"api-method post"},{"type":"doc","id":"api/v3/list-campaign-filters","label":"List Campaign Filters","className":"api-method get"},{"type":"doc","id":"api/v3/get-campaign-filter-by-id","label":"Get Campaign Filter by ID","className":"api-method get"},{"type":"doc","id":"api/v3/update-campaign-filter","label":"Updates a Campaign Filter","className":"api-method post"},{"type":"doc","id":"api/v3/delete-campaign-filters","label":"Deletes Campaign Filters","className":"api-method post"}]},{"type":"category","label":"Connectors","link":{"type":"doc","id":"api/v3/connectors"},"items":[{"type":"doc","id":"api/v3/create-custom-connector","label":"Create custom connector","className":"api-method post"},{"type":"doc","id":"api/v3/get-connector","label":"getConnector","className":"api-method get"},{"type":"doc","id":"api/v3/delete-custom-connector","label":"deleteCustomConnector","className":"api-method delete"},{"type":"doc","id":"api/v3/update-connector","label":"updateConnector","className":"api-method patch"},{"type":"doc","id":"api/v3/get-connector-source-config","label":"getConnectorSourceConfig","className":"api-method get"},{"type":"doc","id":"api/v3/put-source-config","label":"putSourceConfig","className":"api-method put"},{"type":"doc","id":"api/v3/get-connector-translations","label":"getConnectorTranslations","className":"api-method get"},{"type":"doc","id":"api/v3/put-translations","label":"putTranslations","className":"api-method put"},{"type":"doc","id":"api/v3/get-connector-source-template","label":"getConnectorSourceTemplate","className":"api-method get"},{"type":"doc","id":"api/v3/put-source-template","label":"putSourceTemplate","className":"api-method put"},{"type":"doc","id":"api/v3/get-connector-correlation-config","label":"getConnectorCorrelationConfig","className":"api-method get"},{"type":"doc","id":"api/v3/put-correlation-config","label":"putCorrelationConfig","className":"api-method put"}]},{"type":"category","label":"Global Tenant Security Settings","link":{"type":"doc","id":"api/v3/global-tenant-security-settings"},"items":[{"type":"doc","id":"api/v3/get-auth-org-network-config","label":"Get security network configuration.","className":"api-method get"},{"type":"doc","id":"api/v3/create-auth-org-network-config","label":"Create security network configuration.","className":"api-method post"},{"type":"doc","id":"api/v3/patch-auth-org-network-config","label":"Update security network configuration.","className":"api-method patch"}]},{"type":"category","label":"Lifecycle States","link":{"type":"doc","id":"api/v3/lifecycle-states"},"items":[{"type":"doc","id":"api/v3/set-lifecycle-state","label":"Set Lifecycle State","className":"api-method post"},{"type":"doc","id":"api/v3/list-lifecycle-states","label":"Lists LifecycleStates","className":"api-method get"},{"type":"doc","id":"api/v3/create-lifecycle-state","label":"Create Lifecycle State","className":"api-method post"},{"type":"doc","id":"api/v3/get-lifecycle-state","label":"Retrieves Lifecycle State","className":"api-method get"},{"type":"doc","id":"api/v3/update-lifecycle-states","label":"Update Lifecycle State","className":"api-method patch"},{"type":"doc","id":"api/v3/delete-lifecycle-state","label":"Delete Lifecycle State by ID","className":"api-method delete"}]},{"type":"category","label":"Identity Profiles","link":{"type":"doc","id":"api/v3/identity-profiles"},"items":[{"type":"doc","id":"api/v3/list-identity-profiles","label":"Identity Profiles List","className":"api-method get"},{"type":"doc","id":"api/v3/delete-identity-profiles","label":"Delete Identity Profiles","className":"api-method post"},{"type":"doc","id":"api/v3/export-identity-profiles","label":"Export Identity Profiles","className":"api-method get"},{"type":"doc","id":"api/v3/import-identity-profiles","label":"Import Identity Profiles","className":"api-method post"},{"type":"doc","id":"api/v3/get-identity-profile","label":"Get single Identity Profile","className":"api-method get"},{"type":"doc","id":"api/v3/delete-identity-profile","label":"Delete an Identity Profile","className":"api-method delete"},{"type":"doc","id":"api/v3/get-default-identity-attribute-config","label":"Get default Identity Attribute Config","className":"api-method get"},{"type":"doc","id":"api/v3/sync-identity-profile","label":"Process identities under profile","className":"api-method post"}]},{"type":"category","label":"Non-Employee Lifecycle Management","link":{"type":"doc","id":"api/v3/non-employee-lifecycle-management"},"items":[{"type":"doc","id":"api/v3/create-non-employee-record","label":"Create Non-Employee Record","className":"api-method post"},{"type":"doc","id":"api/v3/list-non-employee-records","label":"List Non-Employee Records","className":"api-method get"},{"type":"doc","id":"api/v3/get-non-employee-record","label":"Get a Non-Employee Record","className":"api-method get"},{"type":"doc","id":"api/v3/update-non-employee-record","label":"Update Non-Employee Record","className":"api-method put"},{"type":"doc","id":"api/v3/patch-non-employee-record","label":"Patch Non-Employee Record","className":"api-method patch"},{"type":"doc","id":"api/v3/delete-non-employee-record","label":"Delete Non-Employee Record","className":"api-method delete"},{"type":"doc","id":"api/v3/delete-non-employee-records-in-bulk","label":"Delete Multiple Non-Employee Records","className":"api-method post"},{"type":"doc","id":"api/v3/create-non-employee-request","label":"Create Non-Employee Request","className":"api-method post"},{"type":"doc","id":"api/v3/list-non-employee-requests","label":"List Non-Employee Requests","className":"api-method get"},{"type":"doc","id":"api/v3/get-non-employee-request","label":"Get a Non-Employee Request","className":"api-method get"},{"type":"doc","id":"api/v3/delete-non-employee-request","label":"Delete Non-Employee Request","className":"api-method delete"},{"type":"doc","id":"api/v3/get-non-employee-request-summary","label":"Get Summary of Non-Employee Requests","className":"api-method get"},{"type":"doc","id":"api/v3/create-non-employee-source","label":"Create Non-Employee Source","className":"api-method post"},{"type":"doc","id":"api/v3/list-non-employee-sources","label":"List Non-Employee Sources","className":"api-method get"},{"type":"doc","id":"api/v3/get-non-employee-source","label":"Get a Non-Employee Source","className":"api-method get"},{"type":"doc","id":"api/v3/patch-non-employee-source","label":"Patch a Non-Employee Source","className":"api-method patch"},{"type":"doc","id":"api/v3/delete-non-employee-source","label":"Delete Non-Employee Source","className":"api-method delete"},{"type":"doc","id":"api/v3/export-non-employee-records","label":"Exports Non-Employee Records to CSV","className":"api-method get"},{"type":"doc","id":"api/v3/import-non-employee-records-in-bulk","label":"Imports, or Updates, Non-Employee Records","className":"api-method post"},{"type":"doc","id":"api/v3/get-non-employee-bulk-upload-status","label":"Obtain the status of bulk upload on the source","className":"api-method get"},{"type":"doc","id":"api/v3/export-non-employee-source-schema-template","label":"Exports Source Schema Template","className":"api-method get"},{"type":"doc","id":"api/v3/list-non-employee-approvals","label":"Get List of Non-Employee Approval Requests","className":"api-method get"},{"type":"doc","id":"api/v3/get-non-employee-approval","label":"Get a non-employee approval item detail","className":"api-method get"},{"type":"doc","id":"api/v3/approve-non-employee-request","label":"Approve a Non-Employee Request","className":"api-method post"},{"type":"doc","id":"api/v3/reject-non-employee-request","label":"Reject a Non-Employee Request","className":"api-method post"},{"type":"doc","id":"api/v3/get-non-employee-approval-summary","label":"Get Summary of Non-Employee Approval Requests","className":"api-method get"},{"type":"doc","id":"api/v3/get-non-employee-source-schema-attributes","label":"List Schema Attributes Non-Employee Source","className":"api-method get"},{"type":"doc","id":"api/v3/create-non-employee-source-schema-attributes","label":"Create a new Schema Attribute for Non-Employee Source","className":"api-method post"},{"type":"doc","id":"api/v3/delete-non-employee-source-schema-attributes","label":"Delete all custom schema attributes for Non-Employee Source","className":"api-method delete"},{"type":"doc","id":"api/v3/get-non-employee-schema-attribute","label":"Get Schema Attribute Non-Employee Source","className":"api-method get"},{"type":"doc","id":"api/v3/patch-non-employee-schema-attribute","label":"Patch a Schema Attribute for Non-Employee Source","className":"api-method patch"},{"type":"doc","id":"api/v3/delete-non-employee-schema-attribute","label":"Delete a Schema Attribute for Non-Employee Source","className":"api-method delete"}]},{"type":"category","label":"OAuth Clients","link":{"type":"doc","id":"api/v3/o-auth-clients"},"items":[{"type":"doc","id":"api/v3/list-oauth-clients","label":"List OAuth Clients","className":"api-method get"},{"type":"doc","id":"api/v3/create-oauth-client","label":"Create OAuth Client","className":"api-method post"},{"type":"doc","id":"api/v3/get-oauth-client","label":"Get OAuth Client","className":"api-method get"},{"type":"doc","id":"api/v3/delete-oauth-client","label":"Delete OAuth Client","className":"api-method delete"},{"type":"doc","id":"api/v3/patch-oauth-client","label":"Patch OAuth Client","className":"api-method patch"}]},{"type":"category","label":"Password Configuration","link":{"type":"doc","id":"api/v3/password-configuration"},"items":[{"type":"doc","id":"api/v3/get-password-org-config","label":"Get Password Org Config","className":"api-method get"},{"type":"doc","id":"api/v3/put-password-org-config","label":"Update Password Org Config","className":"api-method put"},{"type":"doc","id":"api/v3/create-password-org-config","label":"Create Password Org Config","className":"api-method post"}]},{"type":"category","label":"Password Management","link":{"type":"doc","id":"api/v3/password-management"},"items":[{"type":"doc","id":"api/v3/query-password-info","label":"Query Password Info","className":"api-method post"},{"type":"doc","id":"api/v3/set-password","label":"Set Identity's Password","className":"api-method post"},{"type":"doc","id":"api/v3/get-password-change-status","label":"Get Password Change Request Status","className":"api-method get"}]},{"type":"category","label":"Password Dictionary","link":{"type":"doc","id":"api/v3/password-dictionary"},"items":[{"type":"doc","id":"api/v3/get-password-dictionary","label":"Get Password Dictionary","className":"api-method get"},{"type":"doc","id":"api/v3/put-password-dictionary","label":"Update Password Dictionary","className":"api-method put"}]},{"type":"category","label":"Password Sync Groups","link":{"type":"doc","id":"api/v3/password-sync-groups"},"items":[{"type":"doc","id":"api/v3/get-password-sync-groups","label":"Get Password Sync Group List","className":"api-method get"},{"type":"doc","id":"api/v3/create-password-sync-group","label":"Create Password Sync Group","className":"api-method post"},{"type":"doc","id":"api/v3/get-password-sync-group","label":"Get Password Sync Group by ID","className":"api-method get"},{"type":"doc","id":"api/v3/update-password-sync-group","label":"Update Password Sync Group by ID","className":"api-method put"},{"type":"doc","id":"api/v3/delete-password-sync-group","label":"Delete Password Sync Group by ID","className":"api-method delete"}]},{"type":"category","label":"Personal Access Tokens","link":{"type":"doc","id":"api/v3/personal-access-tokens"},"items":[{"type":"doc","id":"api/v3/list-personal-access-tokens","label":"List Personal Access Tokens","className":"api-method get"},{"type":"doc","id":"api/v3/create-personal-access-token","label":"Create Personal Access Token","className":"api-method post"},{"type":"doc","id":"api/v3/patch-personal-access-token","label":"Patch Personal Access Token","className":"api-method patch"},{"type":"doc","id":"api/v3/delete-personal-access-token","label":"Delete Personal Access Token","className":"api-method delete"}]},{"type":"category","label":"Public Identities","link":{"type":"doc","id":"api/v3/public-identities"},"items":[{"type":"doc","id":"api/v3/get-public-identities","label":"Get a list of public identities","className":"api-method get"}]},{"type":"category","label":"Public Identities Config","link":{"type":"doc","id":"api/v3/public-identities-config"},"items":[{"type":"doc","id":"api/v3/get-public-identity-config","label":"Get the Public Identities Configuration","className":"api-method get"},{"type":"doc","id":"api/v3/update-public-identity-config","label":"Update the Public Identities Configuration","className":"api-method put"}]},{"type":"category","label":"Reports Data Extraction","link":{"type":"doc","id":"api/v3/reports-data-extraction"},"items":[{"type":"doc","id":"api/v3/get-report-result","label":"Get Report Result","className":"api-method get"},{"type":"doc","id":"api/v3/start-report","label":"Run Report","className":"api-method post"},{"type":"doc","id":"api/v3/cancel-report","label":"Cancel Report","className":"api-method post"},{"type":"doc","id":"api/v3/get-report","label":"Get Report File","className":"api-method get"}]},{"type":"category","label":"Requestable Objects","link":{"type":"doc","id":"api/v3/requestable-objects"},"items":[{"type":"doc","id":"api/v3/list-requestable-objects","label":"Requestable Objects List","className":"api-method get"}]},{"type":"category","label":"Roles","link":{"type":"doc","id":"api/v3/roles"},"items":[{"type":"doc","id":"api/v3/list-roles","label":"List Roles","className":"api-method get"},{"type":"doc","id":"api/v3/create-role","label":"Create a Role","className":"api-method post"},{"type":"doc","id":"api/v3/get-role","label":"Get a Role","className":"api-method get"},{"type":"doc","id":"api/v3/patch-role","label":"Patch a specified Role","className":"api-method patch"},{"type":"doc","id":"api/v3/delete-role","label":"Delete a Role","className":"api-method delete"},{"type":"doc","id":"api/v3/delete-bulk-roles","label":"Delete Role(s)","className":"api-method post"},{"type":"doc","id":"api/v3/get-role-assigned-identities","label":"List Identities assigned a Role","className":"api-method get"}]},{"type":"category","label":"Saved Search","link":{"type":"doc","id":"api/v3/saved-search"},"items":[{"type":"doc","id":"api/v3/create-saved-search","label":"Create a saved search","className":"api-method post"},{"type":"doc","id":"api/v3/list-saved-searches","label":"A list of Saved Searches","className":"api-method get"},{"type":"doc","id":"api/v3/put-saved-search","label":"Updates an existing saved search\n","className":"api-method put"},{"type":"doc","id":"api/v3/get-saved-search","label":"Return saved search by ID","className":"api-method get"},{"type":"doc","id":"api/v3/delete-saved-search","label":"Delete document by ID","className":"api-method delete"},{"type":"doc","id":"api/v3/execute-saved-search","label":"Execute a saved search by ID","className":"api-method post"}]},{"type":"category","label":"Scheduled Search","link":{"type":"doc","id":"api/v3/scheduled-search"},"items":[{"type":"doc","id":"api/v3/create-scheduled-search","label":"Create a new scheduled search","className":"api-method post"},{"type":"doc","id":"api/v3/list-scheduled-search","label":"List scheduled searches","className":"api-method get"},{"type":"doc","id":"api/v3/update-scheduled-search","label":"Update an existing Scheduled Search","className":"api-method put"},{"type":"doc","id":"api/v3/get-scheduled-search","label":"Get a Scheduled Search","className":"api-method get"},{"type":"doc","id":"api/v3/delete-scheduled-search","label":"Delete a Scheduled Search","className":"api-method delete"},{"type":"doc","id":"api/v3/unsubscribe-scheduled-search","label":"Unsubscribe a recipient from Scheduled Search","className":"api-method post"}]},{"type":"category","label":"Search","link":{"type":"doc","id":"api/v3/search"},"items":[{"type":"doc","id":"api/v3/search-post","label":"Perform Search","className":"api-method post"},{"type":"doc","id":"api/v3/search-count","label":"Count Documents Satisfying a Query","className":"api-method post"},{"type":"doc","id":"api/v3/search-aggregate","label":"Perform a Search Query Aggregation","className":"api-method post"},{"type":"doc","id":"api/v3/search-get","label":"Get a Document by ID","className":"api-method get"}]},{"type":"category","label":"Segments","link":{"type":"doc","id":"api/v3/segments"},"items":[{"type":"doc","id":"api/v3/create-segment","label":"Create Segment","className":"api-method post"},{"type":"doc","id":"api/v3/list-segments","label":"List Segments","className":"api-method get"},{"type":"doc","id":"api/v3/get-segment","label":"Get Segment by ID","className":"api-method get"},{"type":"doc","id":"api/v3/delete-segment","label":"Delete Segment by ID","className":"api-method delete"},{"type":"doc","id":"api/v3/patch-segment","label":"Update Segment","className":"api-method patch"}]},{"type":"category","label":"Service Desk Integration","link":{"type":"doc","id":"api/v3/service-desk-integration"},"items":[{"type":"doc","id":"api/v3/get-service-desk-integrations","label":"List existing Service Desk Integrations","className":"api-method get"},{"type":"doc","id":"api/v3/create-service-desk-integration","label":"Create new Service Desk integration","className":"api-method post"},{"type":"doc","id":"api/v3/get-service-desk-integration","label":"Get a Service Desk integration","className":"api-method get"},{"type":"doc","id":"api/v3/put-service-desk-integration","label":"Update a Service Desk integration","className":"api-method put"},{"type":"doc","id":"api/v3/delete-service-desk-integration","label":"Delete a Service Desk integration","className":"api-method delete"},{"type":"doc","id":"api/v3/patch-service-desk-integration","label":"Service Desk Integration Update PATCH","className":"api-method patch"},{"type":"doc","id":"api/v3/get-service-desk-integration-types","label":"Service Desk Integration Types List.","className":"api-method get"},{"type":"doc","id":"api/v3/get-service-desk-integration-template","label":"Service Desk integration template by scriptName.","className":"api-method get"},{"type":"doc","id":"api/v3/get-status-check-details","label":"Get the time check configuration","className":"api-method get"},{"type":"doc","id":"api/v3/update-status-check-details","label":"Update the time check configuration","className":"api-method put"}]},{"type":"category","label":"SOD Policy","link":{"type":"doc","id":"api/v3/sod-policy"},"items":[{"type":"doc","id":"api/v3/create-sod-policy","label":"Create SOD policy","className":"api-method post"},{"type":"doc","id":"api/v3/list-sod-policies","label":"List SOD policies","className":"api-method get"},{"type":"doc","id":"api/v3/get-sod-policy","label":"Get SOD policy by ID","className":"api-method get"},{"type":"doc","id":"api/v3/put-sod-policy","label":"Update SOD policy by ID","className":"api-method put"},{"type":"doc","id":"api/v3/delete-sod-policy","label":"Delete SOD policy by ID","className":"api-method delete"},{"type":"doc","id":"api/v3/patch-sod-policy","label":"Patch SOD policy by ID","className":"api-method patch"},{"type":"doc","id":"api/v3/start-evaluate-sod-policy","label":"Evaluate one policy by ID","className":"api-method post"},{"type":"doc","id":"api/v3/get-sod-policy-schedule","label":"Get SOD policy schedule","className":"api-method get"},{"type":"doc","id":"api/v3/put-policy-schedule","label":"Update SOD Policy schedule","className":"api-method put"},{"type":"doc","id":"api/v3/delete-sod-policy-schedule","label":"Delete SOD policy schedule","className":"api-method delete"},{"type":"doc","id":"api/v3/start-sod-policy","label":"Runs SOD policy violation report","className":"api-method post"},{"type":"doc","id":"api/v3/get-sod-violation-report-status","label":"Get SOD violation report status","className":"api-method get"},{"type":"doc","id":"api/v3/get-sod-violation-report-run-status","label":"Get violation report run status","className":"api-method get"},{"type":"doc","id":"api/v3/start-sod-all-policies-for-org","label":"Runs all policies for org","className":"api-method post"},{"type":"doc","id":"api/v3/get-sod-all-report-run-status","label":"Get multi-report run task status","className":"api-method get"},{"type":"doc","id":"api/v3/get-default-violation-report","label":"Download violation report","className":"api-method get"},{"type":"doc","id":"api/v3/get-custom-violation-report","label":"Download custom violation report","className":"api-method get"}]},{"type":"category","label":"SOD Violations","link":{"type":"doc","id":"api/v3/sod-violations"},"items":[{"type":"doc","id":"api/v3/start-predict-sod-violations","label":"Predict SOD violations for identity.","className":"api-method post"},{"type":"doc","id":"api/v3/start-violation-check","label":"Check SOD violations","className":"api-method post"}]},{"type":"category","label":"Source Usages","link":{"type":"doc","id":"api/v3/source-usages"},"items":[{"type":"doc","id":"api/v3/get-status-by-source-id","label":"Finds status of source usage","className":"api-method get"},{"type":"doc","id":"api/v3/get-usages-by-source-id","label":"Returns source usage insights","className":"api-method get"}]},{"type":"category","label":"Sources","link":{"type":"doc","id":"api/v3/sources"},"items":[{"type":"doc","id":"api/v3/list-sources","label":"Lists all sources in IdentityNow.","className":"api-method get"},{"type":"doc","id":"api/v3/create-source","label":"Creates a source in IdentityNow.","className":"api-method post"},{"type":"doc","id":"api/v3/get-source","label":"Get Source by ID","className":"api-method get"},{"type":"doc","id":"api/v3/put-source","label":"Update Source (Full)","className":"api-method put"},{"type":"doc","id":"api/v3/update-source","label":"Update Source (Partial)","className":"api-method patch"},{"type":"doc","id":"api/v3/delete-source","label":"Delete Source by ID","className":"api-method delete"},{"type":"doc","id":"api/v3/list-provisioning-policies","label":"Lists ProvisioningPolicies","className":"api-method get"},{"type":"doc","id":"api/v3/create-provisioning-policy","label":"Create Provisioning Policy","className":"api-method post"},{"type":"doc","id":"api/v3/get-provisioning-policy","label":"Get Provisioning Policy by UsageType","className":"api-method get"},{"type":"doc","id":"api/v3/put-provisioning-policy","label":"Update Provisioning Policy by UsageType","className":"api-method put"},{"type":"doc","id":"api/v3/update-provisioning-policy","label":"Partial update of Provisioning Policy","className":"api-method patch"},{"type":"doc","id":"api/v3/delete-provisioning-policy","label":"Delete Provisioning Policy by UsageType","className":"api-method delete"},{"type":"doc","id":"api/v3/update-provisioning-policies-in-bulk","label":"Bulk Update Provisioning Policies","className":"api-method post"},{"type":"doc","id":"api/v3/list-source-schemas","label":"List Schemas on a Source","className":"api-method get"},{"type":"doc","id":"api/v3/create-source-schema","label":"Create Schema on a Source","className":"api-method post"},{"type":"doc","id":"api/v3/get-source-schema","label":"Get Source Schema by ID","className":"api-method get"},{"type":"doc","id":"api/v3/put-source-schema","label":"Update Source Schema (Full)","className":"api-method put"},{"type":"doc","id":"api/v3/update-source-schema","label":"Update Source Schema (Partial)","className":"api-method patch"},{"type":"doc","id":"api/v3/delete-source-schema","label":"Delete Source Schema by ID","className":"api-method delete"},{"type":"doc","id":"api/v3/get-source-health","label":"Fetches source health by id","className":"api-method get"},{"type":"doc","id":"api/v3/get-accounts-schema","label":"Downloads source accounts schema template","className":"api-method get"},{"type":"doc","id":"api/v3/import-accounts-schema","label":"Uploads source accounts schema template","className":"api-method post"},{"type":"doc","id":"api/v3/get-entitlements-schema","label":"Downloads source entitlements schema template","className":"api-method get"},{"type":"doc","id":"api/v3/import-entitlements-schema","label":"Uploads source entitlements schema template","className":"api-method post"},{"type":"doc","id":"api/v3/import-connector-file","label":"Upload connector file to source","className":"api-method post"}]},{"type":"category","label":"Tagged Objects","link":{"type":"doc","id":"api/v3/tagged-objects"},"items":[{"type":"doc","id":"api/v3/list-tagged-objects","label":"List Tagged Objects","className":"api-method get"},{"type":"doc","id":"api/v3/set-tag-to-object","label":"Add Tag to Object","className":"api-method post"},{"type":"doc","id":"api/v3/list-tagged-objects-by-type","label":"List Tagged Objects by Type","className":"api-method get"},{"type":"doc","id":"api/v3/get-tagged-object","label":"Get Tagged Object","className":"api-method get"},{"type":"doc","id":"api/v3/put-tagged-object","label":"Update Tagged Object","className":"api-method put"},{"type":"doc","id":"api/v3/delete-tagged-object","label":"Delete Tagged Object","className":"api-method delete"},{"type":"doc","id":"api/v3/set-tags-to-many-objects","label":"Tag Multiple Objects","className":"api-method post"},{"type":"doc","id":"api/v3/delete-tags-to-many-object","label":"Remove Tags from Multiple Objects","className":"api-method post"}]},{"type":"category","label":"Transforms","link":{"type":"doc","id":"api/v3/transforms"},"items":[{"type":"doc","id":"api/v3/list-transforms","label":"List transforms","className":"api-method get"},{"type":"doc","id":"api/v3/create-transform","label":"Create transform","className":"api-method post"},{"type":"doc","id":"api/v3/get-transform","label":"Transform by ID","className":"api-method get"},{"type":"doc","id":"api/v3/update-transform","label":"Update a transform","className":"api-method put"},{"type":"doc","id":"api/v3/delete-transform","label":"Delete a transform","className":"api-method delete"}]},{"type":"category","label":"Work Items","link":{"type":"doc","id":"api/v3/work-items"},"items":[{"type":"doc","id":"api/v3/list-work-items","label":"List Work Items","className":"api-method get"},{"type":"doc","id":"api/v3/get-completed-work-items","label":"Completed Work Items","className":"api-method get"},{"type":"doc","id":"api/v3/get-count-work-items","label":"Count Work Items","className":"api-method get"},{"type":"doc","id":"api/v3/get-count-completed-work-items","label":"Count Completed Work Items","className":"api-method get"},{"type":"doc","id":"api/v3/get-work-items-summary","label":"Work Items Summary","className":"api-method get"},{"type":"doc","id":"api/v3/get-work-item","label":"Get a Work Item","className":"api-method get"},{"type":"doc","id":"api/v3/complete-work-item","label":"Complete a Work Item","className":"api-method post"},{"type":"doc","id":"api/v3/approve-approval-item","label":"Approve an Approval Item","className":"api-method post"},{"type":"doc","id":"api/v3/reject-approval-item","label":"Reject an Approval Item","className":"api-method post"},{"type":"doc","id":"api/v3/approve-approval-items-in-bulk","label":"Bulk approve Approval Items","className":"api-method post"},{"type":"doc","id":"api/v3/reject-approval-items-in-bulk","label":"Bulk reject Approval Items","className":"api-method post"},{"type":"doc","id":"api/v3/submit-account-selection","label":"Submit Account Selections","className":"api-method post"}]}]; \ No newline at end of file +module.exports = [{"type":"doc","id":"api/v3/identitynow-v-3-api"},{"type":"category","label":"Access Profiles","link":{"type":"doc","id":"api/v3/access-profiles"},"items":[{"type":"doc","id":"api/v3/list-access-profiles","label":"List Access Profiles","className":"api-method get"},{"type":"doc","id":"api/v3/create-access-profile","label":"Create an Access Profile","className":"api-method post"},{"type":"doc","id":"api/v3/get-access-profile","label":"Get an Access Profile","className":"api-method get"},{"type":"doc","id":"api/v3/patch-access-profile","label":"Patch a specified Access Profile","className":"api-method patch"},{"type":"doc","id":"api/v3/delete-access-profile","label":"Delete the specified Access Profile","className":"api-method delete"},{"type":"doc","id":"api/v3/delete-access-profiles-in-bulk","label":"Delete Access Profile(s)","className":"api-method post"},{"type":"doc","id":"api/v3/get-access-profile-entitlements","label":"List Access Profile's Entitlements","className":"api-method get"}]},{"type":"category","label":"Access Request Approvals","link":{"type":"doc","id":"api/v3/access-request-approvals"},"items":[{"type":"doc","id":"api/v3/list-pending-approvals","label":"Pending Access Request Approvals List","className":"api-method get"},{"type":"doc","id":"api/v3/list-completed-approvals","label":"Completed Access Request Approvals List","className":"api-method get"},{"type":"doc","id":"api/v3/approve-access-request","label":"Approves an access request approval.","className":"api-method post"},{"type":"doc","id":"api/v3/reject-access-request","label":"Rejects an access request approval.","className":"api-method post"},{"type":"doc","id":"api/v3/forward-access-request","label":"Forwards an access request approval.","className":"api-method post"},{"type":"doc","id":"api/v3/get-access-request-approval-summary","label":"Get the number of access-requests-approvals","className":"api-method get"}]},{"type":"category","label":"Access Requests","link":{"type":"doc","id":"api/v3/access-requests"},"items":[{"type":"doc","id":"api/v3/create-access-request","label":"Submit an Access Request","className":"api-method post"},{"type":"doc","id":"api/v3/cancel-access-request","label":"Cancel Access Request","className":"api-method post"},{"type":"doc","id":"api/v3/get-access-request-config","label":"Get Access Request Configuration","className":"api-method get"},{"type":"doc","id":"api/v3/set-access-request-config","label":"Update Access Request Configuration","className":"api-method put"},{"type":"doc","id":"api/v3/list-access-request-status","label":"Access Request Status","className":"api-method get"}]},{"type":"category","label":"Account Usages","link":{"type":"doc","id":"api/v3/account-usages"},"items":[{"type":"doc","id":"api/v3/get-usages-by-account-id","label":"Returns account usage insights","className":"api-method get"}]},{"type":"category","label":"Accounts","link":{"type":"doc","id":"api/v3/accounts"},"items":[{"type":"doc","id":"api/v3/list-accounts","label":"Accounts List","className":"api-method get"},{"type":"doc","id":"api/v3/create-account","label":"Create Account","className":"api-method post"},{"type":"doc","id":"api/v3/get-account","label":"Account Details","className":"api-method get"},{"type":"doc","id":"api/v3/update-account","label":"Update Account","className":"api-method patch"},{"type":"doc","id":"api/v3/put-account","label":"Update Account","className":"api-method put"},{"type":"doc","id":"api/v3/delete-account","label":"Delete Account","className":"api-method delete"},{"type":"doc","id":"api/v3/get-account-entitlements","label":"Account Entitlements","className":"api-method get"},{"type":"doc","id":"api/v3/reload-account","label":"Reload Account","className":"api-method post"},{"type":"doc","id":"api/v3/enable-account","label":"Enable Account","className":"api-method post"},{"type":"doc","id":"api/v3/disable-account","label":"Disable Account","className":"api-method post"},{"type":"doc","id":"api/v3/unlock-account","label":"Unlock Account","className":"api-method post"}]},{"type":"category","label":"Account Activities","link":{"type":"doc","id":"api/v3/account-activities"},"items":[{"type":"doc","id":"api/v3/list-account-activities","label":"List Account Activities","className":"api-method get"},{"type":"doc","id":"api/v3/get-account-activity","label":"Get an Account Activity","className":"api-method get"}]},{"type":"category","label":"Auth User","link":{"type":"doc","id":"api/v3/auth-user"},"items":[{"type":"doc","id":"api/v3/get-auth-user","label":"Auth User Details","className":"api-method get"},{"type":"doc","id":"api/v3/patch-auth-user","label":"Auth User Update","className":"api-method patch"}]},{"type":"category","label":"Branding","link":{"type":"doc","id":"api/v3/branding"},"items":[{"type":"doc","id":"api/v3/get-branding-list","label":"List of branding items","className":"api-method get"},{"type":"doc","id":"api/v3/create-branding-item","label":"Create a branding item","className":"api-method post"},{"type":"doc","id":"api/v3/get-branding","label":"Get a branding item","className":"api-method get"},{"type":"doc","id":"api/v3/set-branding-item","label":"Update a branding item","className":"api-method put"},{"type":"doc","id":"api/v3/delete-branding","label":"Delete a branding item","className":"api-method delete"}]},{"type":"category","label":"Certification Campaigns","link":{"type":"doc","id":"api/v3/certification-campaigns"},"items":[{"type":"doc","id":"api/v3/get-active-campaigns","label":"List Campaigns","className":"api-method get"},{"type":"doc","id":"api/v3/create-campaign","label":"Create a campaign","className":"api-method post"},{"type":"doc","id":"api/v3/get-campaign","label":"Get a campaign","className":"api-method get"},{"type":"doc","id":"api/v3/update-campaign","label":"Update a Campaign","className":"api-method patch"},{"type":"doc","id":"api/v3/move","label":"Reassign Certifications","className":"api-method post"},{"type":"doc","id":"api/v3/start-campaign","label":"Activate a Campaign","className":"api-method post"},{"type":"doc","id":"api/v3/complete-campaign","label":"Complete a Campaign","className":"api-method post"},{"type":"doc","id":"api/v3/delete-campaigns","label":"Deletes Campaigns","className":"api-method post"},{"type":"doc","id":"api/v3/start-campaign-remediation-scan","label":"Run Campaign Remediation Scan","className":"api-method post"},{"type":"doc","id":"api/v3/get-campaign-reports","label":"Get Campaign Reports","className":"api-method get"},{"type":"doc","id":"api/v3/start-campaign-report","label":"Run Campaign Report","className":"api-method post"},{"type":"doc","id":"api/v3/get-campaign-reports-config","label":"Get Campaign Reports Configuration","className":"api-method get"},{"type":"doc","id":"api/v3/set-campaign-reports-config","label":"Set Campaign Reports Configuration","className":"api-method put"},{"type":"doc","id":"api/v3/create-campaign-template","label":"Create a Campaign Template","className":"api-method post"},{"type":"doc","id":"api/v3/list-campaign-templates","label":"List Campaign Templates","className":"api-method get"},{"type":"doc","id":"api/v3/patch-campaign-template","label":"Update a Campaign Template","className":"api-method patch"},{"type":"doc","id":"api/v3/get-campaign-template","label":"Get a Campaign Template","className":"api-method get"},{"type":"doc","id":"api/v3/delete-campaign-template","label":"Delete a Campaign Template","className":"api-method delete"},{"type":"doc","id":"api/v3/get-campaign-template-schedule","label":"Gets a Campaign Template's Schedule","className":"api-method get"},{"type":"doc","id":"api/v3/set-campaign-template-schedule","label":"Sets a Campaign Template's Schedule","className":"api-method put"},{"type":"doc","id":"api/v3/delete-campaign-template-schedule","label":"Deletes a Campaign Template's Schedule","className":"api-method delete"},{"type":"doc","id":"api/v3/start-generate-campaign-template","label":"Generate a Campaign from Template","className":"api-method post"}]},{"type":"category","label":"Certifications","link":{"type":"doc","id":"api/v3/certifications"},"items":[{"type":"doc","id":"api/v3/list-identity-certifications","label":"Identity Campaign Certifications by IDs","className":"api-method get"},{"type":"doc","id":"api/v3/get-identity-certification","label":"Identity Certification by ID","className":"api-method get"},{"type":"doc","id":"api/v3/list-identity-access-review-items","label":"List of Access Review Items","className":"api-method get"},{"type":"doc","id":"api/v3/make-identity-decision","label":"Decide on a Certification Item","className":"api-method post"},{"type":"doc","id":"api/v3/reassign-identity-certifications","label":"Reassign Identities or Items","className":"api-method post"},{"type":"doc","id":"api/v3/sign-off-identity-certification","label":"Finalize Identity Certification Decisions","className":"api-method post"},{"type":"doc","id":"api/v3/get-identity-certification-item-permissions","label":"Permissions for Entitlement Certification Item","className":"api-method get"},{"type":"doc","id":"api/v3/list-certification-reviewers","label":"List of Reviewers for certification","className":"api-method get"},{"type":"doc","id":"api/v3/submit-reassign-certs-async","label":"Reassign Certifications Asynchronously","className":"api-method post"},{"type":"doc","id":"api/v3/get-certification-task","label":"Certification Task by ID","className":"api-method get"},{"type":"doc","id":"api/v3/get-pending-certification-tasks","label":"List of Pending Certification Tasks","className":"api-method get"}]},{"type":"category","label":"Certification Summaries","link":{"type":"doc","id":"api/v3/certification-summaries"},"items":[{"type":"doc","id":"api/v3/get-identity-decision-summary","label":"Summary of Certification Decisions","className":"api-method get"},{"type":"doc","id":"api/v3/get-identity-summaries","label":"Identity Summaries for Campaign Certification","className":"api-method get"},{"type":"doc","id":"api/v3/get-identity-access-summaries","label":"Access Summaries","className":"api-method get"},{"type":"doc","id":"api/v3/get-identity-summary","label":"Summary for Identity","className":"api-method get"}]},{"type":"category","label":"Certification Campaign Filters","link":{"type":"doc","id":"api/v3/certification-campaign-filters"},"items":[{"type":"doc","id":"api/v3/create-campaign-filter","label":"Create a Campaign Filter","className":"api-method post"},{"type":"doc","id":"api/v3/list-campaign-filters","label":"List Campaign Filters","className":"api-method get"},{"type":"doc","id":"api/v3/get-campaign-filter-by-id","label":"Get Campaign Filter by ID","className":"api-method get"},{"type":"doc","id":"api/v3/update-campaign-filter","label":"Updates a Campaign Filter","className":"api-method post"},{"type":"doc","id":"api/v3/delete-campaign-filters","label":"Deletes Campaign Filters","className":"api-method post"}]},{"type":"category","label":"Connectors","link":{"type":"doc","id":"api/v3/connectors"},"items":[{"type":"doc","id":"api/v3/get-connector","label":"getConnector","className":"api-method get"},{"type":"doc","id":"api/v3/delete-custom-connector","label":"deleteCustomConnector","className":"api-method delete"},{"type":"doc","id":"api/v3/update-connector","label":"updateConnector","className":"api-method patch"},{"type":"doc","id":"api/v3/get-connector-source-config","label":"getConnectorSourceConfig","className":"api-method get"},{"type":"doc","id":"api/v3/put-source-config","label":"putSourceConfig","className":"api-method put"},{"type":"doc","id":"api/v3/get-connector-translations","label":"getConnectorTranslations","className":"api-method get"},{"type":"doc","id":"api/v3/put-translations","label":"putTranslations","className":"api-method put"},{"type":"doc","id":"api/v3/get-connector-source-template","label":"getConnectorSourceTemplate","className":"api-method get"},{"type":"doc","id":"api/v3/put-source-template","label":"putSourceTemplate","className":"api-method put"},{"type":"doc","id":"api/v3/get-connector-correlation-config","label":"getConnectorCorrelationConfig","className":"api-method get"},{"type":"doc","id":"api/v3/put-correlation-config","label":"putCorrelationConfig","className":"api-method put"},{"type":"doc","id":"api/v3/create-custom-connector","label":"Create custom connector","className":"api-method post"}]},{"type":"category","label":"Global Tenant Security Settings","link":{"type":"doc","id":"api/v3/global-tenant-security-settings"},"items":[{"type":"doc","id":"api/v3/get-auth-org-network-config","label":"Get security network configuration.","className":"api-method get"},{"type":"doc","id":"api/v3/create-auth-org-network-config","label":"Create security network configuration.","className":"api-method post"},{"type":"doc","id":"api/v3/patch-auth-org-network-config","label":"Update security network configuration.","className":"api-method patch"}]},{"type":"category","label":"Lifecycle States","link":{"type":"doc","id":"api/v3/lifecycle-states"},"items":[{"type":"doc","id":"api/v3/set-lifecycle-state","label":"Set Lifecycle State","className":"api-method post"},{"type":"doc","id":"api/v3/list-lifecycle-states","label":"Lists LifecycleStates","className":"api-method get"},{"type":"doc","id":"api/v3/create-lifecycle-state","label":"Create Lifecycle State","className":"api-method post"},{"type":"doc","id":"api/v3/get-lifecycle-state","label":"Retrieves Lifecycle State","className":"api-method get"},{"type":"doc","id":"api/v3/update-lifecycle-states","label":"Update Lifecycle State","className":"api-method patch"},{"type":"doc","id":"api/v3/delete-lifecycle-state","label":"Delete Lifecycle State by ID","className":"api-method delete"}]},{"type":"category","label":"Identity Profiles","link":{"type":"doc","id":"api/v3/identity-profiles"},"items":[{"type":"doc","id":"api/v3/list-identity-profiles","label":"Identity Profiles List","className":"api-method get"},{"type":"doc","id":"api/v3/delete-identity-profiles","label":"Delete Identity Profiles","className":"api-method post"},{"type":"doc","id":"api/v3/export-identity-profiles","label":"Export Identity Profiles","className":"api-method get"},{"type":"doc","id":"api/v3/import-identity-profiles","label":"Import Identity Profiles","className":"api-method post"},{"type":"doc","id":"api/v3/get-identity-profile","label":"Get single Identity Profile","className":"api-method get"},{"type":"doc","id":"api/v3/delete-identity-profile","label":"Delete an Identity Profile","className":"api-method delete"},{"type":"doc","id":"api/v3/get-default-identity-attribute-config","label":"Get default Identity Attribute Config","className":"api-method get"},{"type":"doc","id":"api/v3/sync-identity-profile","label":"Process identities under profile","className":"api-method post"}]},{"type":"category","label":"Non-Employee Lifecycle Management","link":{"type":"doc","id":"api/v3/non-employee-lifecycle-management"},"items":[{"type":"doc","id":"api/v3/create-non-employee-record","label":"Create Non-Employee Record","className":"api-method post"},{"type":"doc","id":"api/v3/list-non-employee-records","label":"List Non-Employee Records","className":"api-method get"},{"type":"doc","id":"api/v3/get-non-employee-record","label":"Get a Non-Employee Record","className":"api-method get"},{"type":"doc","id":"api/v3/update-non-employee-record","label":"Update Non-Employee Record","className":"api-method put"},{"type":"doc","id":"api/v3/patch-non-employee-record","label":"Patch Non-Employee Record","className":"api-method patch"},{"type":"doc","id":"api/v3/delete-non-employee-record","label":"Delete Non-Employee Record","className":"api-method delete"},{"type":"doc","id":"api/v3/delete-non-employee-records-in-bulk","label":"Delete Multiple Non-Employee Records","className":"api-method post"},{"type":"doc","id":"api/v3/create-non-employee-request","label":"Create Non-Employee Request","className":"api-method post"},{"type":"doc","id":"api/v3/list-non-employee-requests","label":"List Non-Employee Requests","className":"api-method get"},{"type":"doc","id":"api/v3/get-non-employee-request","label":"Get a Non-Employee Request","className":"api-method get"},{"type":"doc","id":"api/v3/delete-non-employee-request","label":"Delete Non-Employee Request","className":"api-method delete"},{"type":"doc","id":"api/v3/get-non-employee-request-summary","label":"Get Summary of Non-Employee Requests","className":"api-method get"},{"type":"doc","id":"api/v3/create-non-employee-source","label":"Create Non-Employee Source","className":"api-method post"},{"type":"doc","id":"api/v3/list-non-employee-sources","label":"List Non-Employee Sources","className":"api-method get"},{"type":"doc","id":"api/v3/get-non-employee-source","label":"Get a Non-Employee Source","className":"api-method get"},{"type":"doc","id":"api/v3/patch-non-employee-source","label":"Patch a Non-Employee Source","className":"api-method patch"},{"type":"doc","id":"api/v3/delete-non-employee-source","label":"Delete Non-Employee Source","className":"api-method delete"},{"type":"doc","id":"api/v3/export-non-employee-records","label":"Exports Non-Employee Records to CSV","className":"api-method get"},{"type":"doc","id":"api/v3/import-non-employee-records-in-bulk","label":"Imports, or Updates, Non-Employee Records","className":"api-method post"},{"type":"doc","id":"api/v3/get-non-employee-bulk-upload-status","label":"Obtain the status of bulk upload on the source","className":"api-method get"},{"type":"doc","id":"api/v3/export-non-employee-source-schema-template","label":"Exports Source Schema Template","className":"api-method get"},{"type":"doc","id":"api/v3/list-non-employee-approvals","label":"Get List of Non-Employee Approval Requests","className":"api-method get"},{"type":"doc","id":"api/v3/get-non-employee-approval","label":"Get a non-employee approval item detail","className":"api-method get"},{"type":"doc","id":"api/v3/approve-non-employee-request","label":"Approve a Non-Employee Request","className":"api-method post"},{"type":"doc","id":"api/v3/reject-non-employee-request","label":"Reject a Non-Employee Request","className":"api-method post"},{"type":"doc","id":"api/v3/get-non-employee-approval-summary","label":"Get Summary of Non-Employee Approval Requests","className":"api-method get"},{"type":"doc","id":"api/v3/get-non-employee-source-schema-attributes","label":"List Schema Attributes Non-Employee Source","className":"api-method get"},{"type":"doc","id":"api/v3/create-non-employee-source-schema-attributes","label":"Create a new Schema Attribute for Non-Employee Source","className":"api-method post"},{"type":"doc","id":"api/v3/delete-non-employee-source-schema-attributes","label":"Delete all custom schema attributes for Non-Employee Source","className":"api-method delete"},{"type":"doc","id":"api/v3/get-non-employee-schema-attribute","label":"Get Schema Attribute Non-Employee Source","className":"api-method get"},{"type":"doc","id":"api/v3/patch-non-employee-schema-attribute","label":"Patch a Schema Attribute for Non-Employee Source","className":"api-method patch"},{"type":"doc","id":"api/v3/delete-non-employee-schema-attribute","label":"Delete a Schema Attribute for Non-Employee Source","className":"api-method delete"}]},{"type":"category","label":"OAuth Clients","link":{"type":"doc","id":"api/v3/o-auth-clients"},"items":[{"type":"doc","id":"api/v3/list-oauth-clients","label":"List OAuth Clients","className":"api-method get"},{"type":"doc","id":"api/v3/create-oauth-client","label":"Create OAuth Client","className":"api-method post"},{"type":"doc","id":"api/v3/get-oauth-client","label":"Get OAuth Client","className":"api-method get"},{"type":"doc","id":"api/v3/delete-oauth-client","label":"Delete OAuth Client","className":"api-method delete"},{"type":"doc","id":"api/v3/patch-oauth-client","label":"Patch OAuth Client","className":"api-method patch"}]},{"type":"category","label":"Password Configuration","link":{"type":"doc","id":"api/v3/password-configuration"},"items":[{"type":"doc","id":"api/v3/get-password-org-config","label":"Get Password Org Config","className":"api-method get"},{"type":"doc","id":"api/v3/put-password-org-config","label":"Update Password Org Config","className":"api-method put"},{"type":"doc","id":"api/v3/create-password-org-config","label":"Create Password Org Config","className":"api-method post"}]},{"type":"category","label":"Password Management","link":{"type":"doc","id":"api/v3/password-management"},"items":[{"type":"doc","id":"api/v3/query-password-info","label":"Query Password Info","className":"api-method post"},{"type":"doc","id":"api/v3/set-password","label":"Set Identity's Password","className":"api-method post"},{"type":"doc","id":"api/v3/get-password-change-status","label":"Get Password Change Request Status","className":"api-method get"}]},{"type":"category","label":"Password Dictionary","link":{"type":"doc","id":"api/v3/password-dictionary"},"items":[{"type":"doc","id":"api/v3/get-password-dictionary","label":"Get Password Dictionary","className":"api-method get"},{"type":"doc","id":"api/v3/put-password-dictionary","label":"Update Password Dictionary","className":"api-method put"}]},{"type":"category","label":"Password Sync Groups","link":{"type":"doc","id":"api/v3/password-sync-groups"},"items":[{"type":"doc","id":"api/v3/get-password-sync-groups","label":"Get Password Sync Group List","className":"api-method get"},{"type":"doc","id":"api/v3/create-password-sync-group","label":"Create Password Sync Group","className":"api-method post"},{"type":"doc","id":"api/v3/get-password-sync-group","label":"Get Password Sync Group by ID","className":"api-method get"},{"type":"doc","id":"api/v3/update-password-sync-group","label":"Update Password Sync Group by ID","className":"api-method put"},{"type":"doc","id":"api/v3/delete-password-sync-group","label":"Delete Password Sync Group by ID","className":"api-method delete"}]},{"type":"category","label":"Personal Access Tokens","link":{"type":"doc","id":"api/v3/personal-access-tokens"},"items":[{"type":"doc","id":"api/v3/list-personal-access-tokens","label":"List Personal Access Tokens","className":"api-method get"},{"type":"doc","id":"api/v3/create-personal-access-token","label":"Create Personal Access Token","className":"api-method post"},{"type":"doc","id":"api/v3/patch-personal-access-token","label":"Patch Personal Access Token","className":"api-method patch"},{"type":"doc","id":"api/v3/delete-personal-access-token","label":"Delete Personal Access Token","className":"api-method delete"}]},{"type":"category","label":"Public Identities","link":{"type":"doc","id":"api/v3/public-identities"},"items":[{"type":"doc","id":"api/v3/get-public-identities","label":"Get a list of public identities","className":"api-method get"}]},{"type":"category","label":"Public Identities Config","link":{"type":"doc","id":"api/v3/public-identities-config"},"items":[{"type":"doc","id":"api/v3/get-public-identity-config","label":"Get the Public Identities Configuration","className":"api-method get"},{"type":"doc","id":"api/v3/update-public-identity-config","label":"Update the Public Identities Configuration","className":"api-method put"}]},{"type":"category","label":"Reports Data Extraction","link":{"type":"doc","id":"api/v3/reports-data-extraction"},"items":[{"type":"doc","id":"api/v3/get-report-result","label":"Get Report Result","className":"api-method get"},{"type":"doc","id":"api/v3/start-report","label":"Run Report","className":"api-method post"},{"type":"doc","id":"api/v3/cancel-report","label":"Cancel Report","className":"api-method post"},{"type":"doc","id":"api/v3/get-report","label":"Get Report File","className":"api-method get"}]},{"type":"category","label":"Requestable Objects","link":{"type":"doc","id":"api/v3/requestable-objects"},"items":[{"type":"doc","id":"api/v3/list-requestable-objects","label":"Requestable Objects List","className":"api-method get"}]},{"type":"category","label":"Roles","link":{"type":"doc","id":"api/v3/roles"},"items":[{"type":"doc","id":"api/v3/list-roles","label":"List Roles","className":"api-method get"},{"type":"doc","id":"api/v3/create-role","label":"Create a Role","className":"api-method post"},{"type":"doc","id":"api/v3/get-role","label":"Get a Role","className":"api-method get"},{"type":"doc","id":"api/v3/patch-role","label":"Patch a specified Role","className":"api-method patch"},{"type":"doc","id":"api/v3/delete-role","label":"Delete a Role","className":"api-method delete"},{"type":"doc","id":"api/v3/delete-bulk-roles","label":"Delete Role(s)","className":"api-method post"},{"type":"doc","id":"api/v3/get-role-assigned-identities","label":"List Identities assigned a Role","className":"api-method get"}]},{"type":"category","label":"Saved Search","link":{"type":"doc","id":"api/v3/saved-search"},"items":[{"type":"doc","id":"api/v3/create-saved-search","label":"Create a saved search","className":"api-method post"},{"type":"doc","id":"api/v3/list-saved-searches","label":"A list of Saved Searches","className":"api-method get"},{"type":"doc","id":"api/v3/put-saved-search","label":"Updates an existing saved search\n","className":"api-method put"},{"type":"doc","id":"api/v3/get-saved-search","label":"Return saved search by ID","className":"api-method get"},{"type":"doc","id":"api/v3/delete-saved-search","label":"Delete document by ID","className":"api-method delete"},{"type":"doc","id":"api/v3/execute-saved-search","label":"Execute a saved search by ID","className":"api-method post"}]},{"type":"category","label":"Scheduled Search","link":{"type":"doc","id":"api/v3/scheduled-search"},"items":[{"type":"doc","id":"api/v3/create-scheduled-search","label":"Create a new scheduled search","className":"api-method post"},{"type":"doc","id":"api/v3/list-scheduled-search","label":"List scheduled searches","className":"api-method get"},{"type":"doc","id":"api/v3/update-scheduled-search","label":"Update an existing Scheduled Search","className":"api-method put"},{"type":"doc","id":"api/v3/get-scheduled-search","label":"Get a Scheduled Search","className":"api-method get"},{"type":"doc","id":"api/v3/delete-scheduled-search","label":"Delete a Scheduled Search","className":"api-method delete"},{"type":"doc","id":"api/v3/unsubscribe-scheduled-search","label":"Unsubscribe a recipient from Scheduled Search","className":"api-method post"}]},{"type":"category","label":"Search","link":{"type":"doc","id":"api/v3/search"},"items":[{"type":"doc","id":"api/v3/search-post","label":"Perform Search","className":"api-method post"},{"type":"doc","id":"api/v3/search-count","label":"Count Documents Satisfying a Query","className":"api-method post"},{"type":"doc","id":"api/v3/search-aggregate","label":"Perform a Search Query Aggregation","className":"api-method post"},{"type":"doc","id":"api/v3/search-get","label":"Get a Document by ID","className":"api-method get"}]},{"type":"category","label":"Segments","link":{"type":"doc","id":"api/v3/segments"},"items":[{"type":"doc","id":"api/v3/create-segment","label":"Create Segment","className":"api-method post"},{"type":"doc","id":"api/v3/list-segments","label":"List Segments","className":"api-method get"},{"type":"doc","id":"api/v3/get-segment","label":"Get Segment by ID","className":"api-method get"},{"type":"doc","id":"api/v3/delete-segment","label":"Delete Segment by ID","className":"api-method delete"},{"type":"doc","id":"api/v3/patch-segment","label":"Update Segment","className":"api-method patch"}]},{"type":"category","label":"Service Desk Integration","link":{"type":"doc","id":"api/v3/service-desk-integration"},"items":[{"type":"doc","id":"api/v3/get-service-desk-integrations","label":"List existing Service Desk Integrations","className":"api-method get"},{"type":"doc","id":"api/v3/create-service-desk-integration","label":"Create new Service Desk integration","className":"api-method post"},{"type":"doc","id":"api/v3/get-service-desk-integration","label":"Get a Service Desk integration","className":"api-method get"},{"type":"doc","id":"api/v3/put-service-desk-integration","label":"Update a Service Desk integration","className":"api-method put"},{"type":"doc","id":"api/v3/delete-service-desk-integration","label":"Delete a Service Desk integration","className":"api-method delete"},{"type":"doc","id":"api/v3/patch-service-desk-integration","label":"Service Desk Integration Update PATCH","className":"api-method patch"},{"type":"doc","id":"api/v3/get-service-desk-integration-types","label":"Service Desk Integration Types List.","className":"api-method get"},{"type":"doc","id":"api/v3/get-service-desk-integration-template","label":"Service Desk integration template by scriptName.","className":"api-method get"},{"type":"doc","id":"api/v3/get-status-check-details","label":"Get the time check configuration","className":"api-method get"},{"type":"doc","id":"api/v3/update-status-check-details","label":"Update the time check configuration","className":"api-method put"}]},{"type":"category","label":"SOD Policy","link":{"type":"doc","id":"api/v3/sod-policy"},"items":[{"type":"doc","id":"api/v3/create-sod-policy","label":"Create SOD policy","className":"api-method post"},{"type":"doc","id":"api/v3/list-sod-policies","label":"List SOD policies","className":"api-method get"},{"type":"doc","id":"api/v3/get-sod-policy","label":"Get SOD policy by ID","className":"api-method get"},{"type":"doc","id":"api/v3/put-sod-policy","label":"Update SOD policy by ID","className":"api-method put"},{"type":"doc","id":"api/v3/delete-sod-policy","label":"Delete SOD policy by ID","className":"api-method delete"},{"type":"doc","id":"api/v3/patch-sod-policy","label":"Patch SOD policy by ID","className":"api-method patch"},{"type":"doc","id":"api/v3/start-evaluate-sod-policy","label":"Evaluate one policy by ID","className":"api-method post"},{"type":"doc","id":"api/v3/get-sod-policy-schedule","label":"Get SOD policy schedule","className":"api-method get"},{"type":"doc","id":"api/v3/put-policy-schedule","label":"Update SOD Policy schedule","className":"api-method put"},{"type":"doc","id":"api/v3/delete-sod-policy-schedule","label":"Delete SOD policy schedule","className":"api-method delete"},{"type":"doc","id":"api/v3/start-sod-policy","label":"Runs SOD policy violation report","className":"api-method post"},{"type":"doc","id":"api/v3/get-sod-violation-report-status","label":"Get SOD violation report status","className":"api-method get"},{"type":"doc","id":"api/v3/get-sod-violation-report-run-status","label":"Get violation report run status","className":"api-method get"},{"type":"doc","id":"api/v3/start-sod-all-policies-for-org","label":"Runs all policies for org","className":"api-method post"},{"type":"doc","id":"api/v3/get-sod-all-report-run-status","label":"Get multi-report run task status","className":"api-method get"},{"type":"doc","id":"api/v3/get-default-violation-report","label":"Download violation report","className":"api-method get"},{"type":"doc","id":"api/v3/get-custom-violation-report","label":"Download custom violation report","className":"api-method get"}]},{"type":"category","label":"SOD Violations","link":{"type":"doc","id":"api/v3/sod-violations"},"items":[{"type":"doc","id":"api/v3/start-predict-sod-violations","label":"Predict SOD violations for identity.","className":"api-method post"},{"type":"doc","id":"api/v3/start-violation-check","label":"Check SOD violations","className":"api-method post"}]},{"type":"category","label":"Source Usages","link":{"type":"doc","id":"api/v3/source-usages"},"items":[{"type":"doc","id":"api/v3/get-status-by-source-id","label":"Finds status of source usage","className":"api-method get"},{"type":"doc","id":"api/v3/get-usages-by-source-id","label":"Returns source usage insights","className":"api-method get"}]},{"type":"category","label":"Sources","link":{"type":"doc","id":"api/v3/sources"},"items":[{"type":"doc","id":"api/v3/list-sources","label":"Lists all sources in IdentityNow.","className":"api-method get"},{"type":"doc","id":"api/v3/create-source","label":"Creates a source in IdentityNow.","className":"api-method post"},{"type":"doc","id":"api/v3/get-source","label":"Get Source by ID","className":"api-method get"},{"type":"doc","id":"api/v3/put-source","label":"Update Source (Full)","className":"api-method put"},{"type":"doc","id":"api/v3/update-source","label":"Update Source (Partial)","className":"api-method patch"},{"type":"doc","id":"api/v3/delete-source","label":"Delete Source by ID","className":"api-method delete"},{"type":"doc","id":"api/v3/list-provisioning-policies","label":"Lists ProvisioningPolicies","className":"api-method get"},{"type":"doc","id":"api/v3/create-provisioning-policy","label":"Create Provisioning Policy","className":"api-method post"},{"type":"doc","id":"api/v3/get-provisioning-policy","label":"Get Provisioning Policy by UsageType","className":"api-method get"},{"type":"doc","id":"api/v3/put-provisioning-policy","label":"Update Provisioning Policy by UsageType","className":"api-method put"},{"type":"doc","id":"api/v3/update-provisioning-policy","label":"Partial update of Provisioning Policy","className":"api-method patch"},{"type":"doc","id":"api/v3/delete-provisioning-policy","label":"Delete Provisioning Policy by UsageType","className":"api-method delete"},{"type":"doc","id":"api/v3/update-provisioning-policies-in-bulk","label":"Bulk Update Provisioning Policies","className":"api-method post"},{"type":"doc","id":"api/v3/list-source-schemas","label":"List Schemas on a Source","className":"api-method get"},{"type":"doc","id":"api/v3/create-source-schema","label":"Create Schema on a Source","className":"api-method post"},{"type":"doc","id":"api/v3/get-source-schema","label":"Get Source Schema by ID","className":"api-method get"},{"type":"doc","id":"api/v3/put-source-schema","label":"Update Source Schema (Full)","className":"api-method put"},{"type":"doc","id":"api/v3/update-source-schema","label":"Update Source Schema (Partial)","className":"api-method patch"},{"type":"doc","id":"api/v3/delete-source-schema","label":"Delete Source Schema by ID","className":"api-method delete"},{"type":"doc","id":"api/v3/get-source-health","label":"Fetches source health by id","className":"api-method get"},{"type":"doc","id":"api/v3/get-accounts-schema","label":"Downloads source accounts schema template","className":"api-method get"},{"type":"doc","id":"api/v3/import-accounts-schema","label":"Uploads source accounts schema template","className":"api-method post"},{"type":"doc","id":"api/v3/get-entitlements-schema","label":"Downloads source entitlements schema template","className":"api-method get"},{"type":"doc","id":"api/v3/import-entitlements-schema","label":"Uploads source entitlements schema template","className":"api-method post"},{"type":"doc","id":"api/v3/import-connector-file","label":"Upload connector file to source","className":"api-method post"}]},{"type":"category","label":"Tagged Objects","link":{"type":"doc","id":"api/v3/tagged-objects"},"items":[{"type":"doc","id":"api/v3/list-tagged-objects","label":"List Tagged Objects","className":"api-method get"},{"type":"doc","id":"api/v3/set-tag-to-object","label":"Add Tag to Object","className":"api-method post"},{"type":"doc","id":"api/v3/list-tagged-objects-by-type","label":"List Tagged Objects by Type","className":"api-method get"},{"type":"doc","id":"api/v3/get-tagged-object","label":"Get Tagged Object","className":"api-method get"},{"type":"doc","id":"api/v3/put-tagged-object","label":"Update Tagged Object","className":"api-method put"},{"type":"doc","id":"api/v3/delete-tagged-object","label":"Delete Tagged Object","className":"api-method delete"},{"type":"doc","id":"api/v3/set-tags-to-many-objects","label":"Tag Multiple Objects","className":"api-method post"},{"type":"doc","id":"api/v3/delete-tags-to-many-object","label":"Remove Tags from Multiple Objects","className":"api-method post"}]},{"type":"category","label":"Transforms","link":{"type":"doc","id":"api/v3/transforms"},"items":[{"type":"doc","id":"api/v3/list-transforms","label":"List transforms","className":"api-method get"},{"type":"doc","id":"api/v3/create-transform","label":"Create transform","className":"api-method post"},{"type":"doc","id":"api/v3/get-transform","label":"Transform by ID","className":"api-method get"},{"type":"doc","id":"api/v3/update-transform","label":"Update a transform","className":"api-method put"},{"type":"doc","id":"api/v3/delete-transform","label":"Delete a transform","className":"api-method delete"}]},{"type":"category","label":"Work Items","link":{"type":"doc","id":"api/v3/work-items"},"items":[{"type":"doc","id":"api/v3/list-work-items","label":"List Work Items","className":"api-method get"},{"type":"doc","id":"api/v3/get-completed-work-items","label":"Completed Work Items","className":"api-method get"},{"type":"doc","id":"api/v3/get-count-work-items","label":"Count Work Items","className":"api-method get"},{"type":"doc","id":"api/v3/get-count-completed-work-items","label":"Count Completed Work Items","className":"api-method get"},{"type":"doc","id":"api/v3/get-work-items-summary","label":"Work Items Summary","className":"api-method get"},{"type":"doc","id":"api/v3/get-work-item","label":"Get a Work Item","className":"api-method get"},{"type":"doc","id":"api/v3/complete-work-item","label":"Complete a Work Item","className":"api-method post"},{"type":"doc","id":"api/v3/approve-approval-item","label":"Approve an Approval Item","className":"api-method post"},{"type":"doc","id":"api/v3/reject-approval-item","label":"Reject an Approval Item","className":"api-method post"},{"type":"doc","id":"api/v3/approve-approval-items-in-bulk","label":"Bulk approve Approval Items","className":"api-method post"},{"type":"doc","id":"api/v3/reject-approval-items-in-bulk","label":"Bulk reject Approval Items","className":"api-method post"},{"type":"doc","id":"api/v3/submit-account-selection","label":"Submit Account Selections","className":"api-method post"}]},{"type":"category","label":"Workflows","link":{"type":"doc","id":"api/v3/workflows"},"items":[{"type":"doc","id":"api/v3/list-workflows","label":"List Workflows","className":"api-method get"},{"type":"doc","id":"api/v3/get-workflow","label":"Get Workflow By Id","className":"api-method get"},{"type":"doc","id":"api/v3/put-workflow","label":"Update Workflow","className":"api-method put"},{"type":"doc","id":"api/v3/patch-workflow","label":"Patch Workflow","className":"api-method patch"},{"type":"doc","id":"api/v3/delete-workflow","label":"Delete Workflow By Id","className":"api-method delete"},{"type":"doc","id":"api/v3/create-workflow","label":"Create Workflow","className":"api-method post"},{"type":"doc","id":"api/v3/test-workflow","label":"Test Workflow By Id","className":"api-method post"},{"type":"doc","id":"api/v3/list-workflow-executions","label":"List Workflow Executions","className":"api-method get"},{"type":"doc","id":"api/v3/get-workflow-execution","label":"Get a Workflow Execution","className":"api-method get"},{"type":"doc","id":"api/v3/get-workflow-execution-history","label":"Get Workflow Execution History","className":"api-method get"},{"type":"doc","id":"api/v3/cancel-workflow-execution","label":"Cancel Workflow Execution by ID","className":"api-method post"},{"type":"doc","id":"api/v3/list-complete-workflow-library","label":"List Complete Workflow Library","className":"api-method get"},{"type":"doc","id":"api/v3/list-workflow-library-actions","label":"List Workflow Library Actions","className":"api-method get"},{"type":"doc","id":"api/v3/list-workflow-library-triggers","label":"List Workflow Library Triggers","className":"api-method get"},{"type":"doc","id":"api/v3/list-workflow-library-operators","label":"List Workflow Library Operators","className":"api-method get"},{"type":"doc","id":"api/v3/create-workflow-external-trigger","label":"Generate External Trigger OAuth Client","className":"api-method post"},{"type":"doc","id":"api/v3/create-external-execute-workflow","label":"Execute Workflow via External Trigger","className":"api-method post"},{"type":"doc","id":"api/v3/test-external-execute-workflow","label":"Test Workflow via External Trigger","className":"api-method post"}]}]; \ No newline at end of file diff --git a/docs/api/v3/sign-off-identity-certification.api.mdx b/docs/api/v3/sign-off-identity-certification.api.mdx index f8b6d7fcd..bef06e488 100644 --- a/docs/api/v3/sign-off-identity-certification.api.mdx +++ b/docs/api/v3/sign-off-identity-certification.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Finalize Identity Certification Decisions

    @@ -32,7 +30,7 @@ This API finalizes all decisions made on an identity campaign certification and ## Request -

    Path Parameters

    +

    Path Parameters

    An identity campaign certification object @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/start-campaign-remediation-scan.api.mdx b/docs/api/v3/start-campaign-remediation-scan.api.mdx index c812e49b3..460302ad7 100644 --- a/docs/api/v3/start-campaign-remediation-scan.api.mdx +++ b/docs/api/v3/start-campaign-remediation-scan.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Run Campaign Remediation Scan

    @@ -33,7 +31,7 @@ Requires roles of CERT_ADMIN and ORG_ADMIN ## Request -

    Path Parameters

    +

    Path Parameters

    Accepted - Returned if the request was successfully accepted into the system. @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -81,7 +79,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -97,4 +95,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/start-campaign-report.api.mdx b/docs/api/v3/start-campaign-report.api.mdx index b6b106bef..c47025dc6 100644 --- a/docs/api/v3/start-campaign-report.api.mdx +++ b/docs/api/v3/start-campaign-report.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Run Campaign Report

    @@ -33,7 +31,7 @@ Requires the following roles: CERT_ADMIN, DASHBOARD, ORG_ADMIN and REPORT_ADMIN. ## Request -

    Path Parameters

    +

    Path Parameters

    Accepted - Returned if the request was successfully accepted into the system. @@ -69,7 +67,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -81,7 +79,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -97,4 +95,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/start-campaign.api.mdx b/docs/api/v3/start-campaign.api.mdx index 054c19e5b..96f442500 100644 --- a/docs/api/v3/start-campaign.api.mdx +++ b/docs/api/v3/start-campaign.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Activate a Campaign

    @@ -37,7 +35,7 @@ Requires roles of CERT_ADMIN and ORG_ADMIN Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. -
    +
    Accepted - Returned if the request was successfully accepted into the system. @@ -73,7 +71,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -85,7 +83,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -101,4 +99,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/start-evaluate-sod-policy.api.mdx b/docs/api/v3/start-evaluate-sod-policy.api.mdx index 2966f9299..2bed17f30 100644 --- a/docs/api/v3/start-evaluate-sod-policy.api.mdx +++ b/docs/api/v3/start-evaluate-sod-policy.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Evaluate one policy by ID

    @@ -32,7 +30,7 @@ Runs the scheduled report for the policy retrieved by passed policy ID. The rep ## Request -

    Path Parameters

    +

    Path Parameters

    Reference to the violation report run task. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/start-generate-campaign-template.api.mdx b/docs/api/v3/start-generate-campaign-template.api.mdx index 74c7ece29..a46a809f0 100644 --- a/docs/api/v3/start-generate-campaign-template.api.mdx +++ b/docs/api/v3/start-generate-campaign-template.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Generate a Campaign from Template

    @@ -36,7 +34,7 @@ Requires roles ORG_ADMIN. ## Request -

    Path Parameters

    +

    Path Parameters

    Indicates a campaign was successfully generated from this template, and returns a reference to the new campaign. @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -84,4 +82,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/start-predict-sod-violations.api.mdx b/docs/api/v3/start-predict-sod-violations.api.mdx index f278aba0d..e5ffbd1f4 100644 --- a/docs/api/v3/start-predict-sod-violations.api.mdx +++ b/docs/api/v3/start-predict-sod-violations.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Predict SOD violations for identity.

    @@ -38,7 +36,7 @@ A token with ORG_ADMIN or API authority is required to call this API. The list of entitlements to consider for possible violations in a preventive check. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Violation Contexts @@ -90,7 +88,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -102,7 +100,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -118,4 +116,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/start-report.api.mdx b/docs/api/v3/start-report.api.mdx index 10bc34284..694e8d656 100644 --- a/docs/api/v3/start-report.api.mdx +++ b/docs/api/v3/start-report.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Run Report

    @@ -60,7 +58,7 @@ Query parameters used to construct an Elasticsearch query object. The innerHit query object returns a flattened list of results for the specified nested type. -
    +
    Details about running report task. @@ -76,7 +74,7 @@ Task definition results, if necessary. Extra attributes map(dictionary) needed for the report. -
    Identities Details Report task result. Identities Details Report task result.
    +

    Identities Details Report task result.

    Identities Details Report task result.

    Client Error - Returned if the request body is invalid. @@ -104,7 +102,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -120,4 +118,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/start-sod-all-policies-for-org.api.mdx b/docs/api/v3/start-sod-all-policies-for-org.api.mdx index d6ca27f40..c386c443c 100644 --- a/docs/api/v3/start-sod-all-policies-for-org.api.mdx +++ b/docs/api/v3/start-sod-all-policies-for-org.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Runs all policies for org

    @@ -32,7 +30,7 @@ Runs multi-policy report for the org. If a policy reports more than 5000 violati ## Request -

    Body

    +

    Body

    Reference to the violation report run task. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -80,4 +78,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/start-sod-policy.api.mdx b/docs/api/v3/start-sod-policy.api.mdx index 86b80ae69..30e8916ad 100644 --- a/docs/api/v3/start-sod-policy.api.mdx +++ b/docs/api/v3/start-sod-policy.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Runs SOD policy violation report

    @@ -32,7 +30,7 @@ This invokes processing of violation report for given SOD policy. If the policy ## Request -

    Path Parameters

    +

    Path Parameters

    Reference to the violation report run task. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/start-violation-check.api.mdx b/docs/api/v3/start-violation-check.api.mdx index 5c4135e7a..13d1d7e3e 100644 --- a/docs/api/v3/start-violation-check.api.mdx +++ b/docs/api/v3/start-violation-check.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Check SOD violations

    @@ -38,7 +36,7 @@ A token with ORG_ADMIN authority is required to call this API. Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. -
    +
    Request ID with a timestamp. @@ -70,7 +68,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -82,7 +80,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -98,4 +96,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/submit-account-selection.api.mdx b/docs/api/v3/submit-account-selection.api.mdx index 599411912..9f1cd8ae8 100644 --- a/docs/api/v3/submit-account-selection.api.mdx +++ b/docs/api/v3/submit-account-selection.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Submit Account Selections

    @@ -36,7 +34,7 @@ This API submits account selections. Either an admin, or the owning/current user Account Selection Data map, keyed on fieldName -
    +
    A work items details object. @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -92,7 +90,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -108,4 +106,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/submit-reassign-certs-async.api.mdx b/docs/api/v3/submit-reassign-certs-async.api.mdx index 851d787ba..31f5c7126 100644 --- a/docs/api/v3/submit-reassign-certs-async.api.mdx +++ b/docs/api/v3/submit-reassign-certs-async.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Reassign Certifications Asynchronously

    @@ -32,7 +30,7 @@ This API initiates a task to reassign up to 500 identities or items in an identi ## Request -

    Path Parameters

    Body

    required
      reassign object[]required
    • Array [
    • ]
    +

    Path Parameters

    Body

    required
      reassign object[]required
    • Array [
    • ]
    A certification task object for the reassignment which can be queried for status. @@ -72,7 +70,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -84,7 +82,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -100,4 +98,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/sync-identity-profile.api.mdx b/docs/api/v3/sync-identity-profile.api.mdx index d1128de04..271eca4f8 100644 --- a/docs/api/v3/sync-identity-profile.api.mdx +++ b/docs/api/v3/sync-identity-profile.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Process identities under profile

    @@ -34,7 +32,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    +

    Path Parameters

    Accepted - Returned if the request was successfully accepted into the system. @@ -70,7 +68,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -82,7 +80,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -98,4 +96,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/unlock-account.api.mdx b/docs/api/v3/unlock-account.api.mdx index fbb60cd82..4bccf2adf 100644 --- a/docs/api/v3/unlock-account.api.mdx +++ b/docs/api/v3/unlock-account.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Unlock Account

    @@ -33,7 +31,7 @@ A token with ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    Async task details @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/unsubscribe-scheduled-search.api.mdx b/docs/api/v3/unsubscribe-scheduled-search.api.mdx index aeaf9d33d..f3fb5146a 100644 --- a/docs/api/v3/unsubscribe-scheduled-search.api.mdx +++ b/docs/api/v3/unsubscribe-scheduled-search.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Unsubscribe a recipient from Scheduled Search

    @@ -38,7 +36,7 @@ Unsubscribes a recipient from the specified scheduled search. The recipient to be removed from the scheduled search. -
    +
    No Content - Indicates the request was successful but there is no content to be returned in the response. @@ -66,7 +64,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -78,4 +76,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 404 response object

     \ No newline at end of file diff --git a/docs/api/v3/update-account.api.mdx b/docs/api/v3/update-account.api.mdx index 44c8aa932..e6c17ded4 100644 --- a/docs/api/v3/update-account.api.mdx +++ b/docs/api/v3/update-account.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Account

    @@ -61,7 +59,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • Accepted - Returned if the request was successfully accepted into the system. @@ -97,7 +95,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -109,7 +107,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -125,4 +123,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/update-campaign-filter.api.mdx b/docs/api/v3/update-campaign-filter.api.mdx index 471ff71f8..5df8f747d 100644 --- a/docs/api/v3/update-campaign-filter.api.mdx +++ b/docs/api/v3/update-campaign-filter.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Updates a Campaign Filter

    @@ -40,7 +38,7 @@ A campaign filter details with updated field values. List of criteria. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Created successfully. @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/update-campaign.api.mdx b/docs/api/v3/update-campaign.api.mdx index 18c0bfbbd..67b817c6e 100644 --- a/docs/api/v3/update-campaign.api.mdx +++ b/docs/api/v3/update-campaign.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update a Campaign

    @@ -69,7 +67,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • Indicates the PATCH operation succeeded, and returns the campaign's new representation. @@ -105,7 +103,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -117,7 +115,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -133,4 +131,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/update-connector.api.mdx b/docs/api/v3/update-connector.api.mdx index ea35df6c2..056058f16 100644 --- a/docs/api/v3/update-connector.api.mdx +++ b/docs/api/v3/update-connector.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    updateConnector

    @@ -57,7 +55,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • A updated Connector Dto object @@ -97,7 +95,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -109,7 +107,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -125,4 +123,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/update-lifecycle-states.api.mdx b/docs/api/v3/update-lifecycle-states.api.mdx index e805222bd..d823ea624 100644 --- a/docs/api/v3/update-lifecycle-states.api.mdx +++ b/docs/api/v3/update-lifecycle-states.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Lifecycle State

    @@ -65,7 +63,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • The LifecycleState was successfully updated. @@ -101,7 +99,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -113,7 +111,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -129,4 +127,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/update-non-employee-record.api.mdx b/docs/api/v3/update-non-employee-record.api.mdx index 2c0aa9dee..ce32691ea 100644 --- a/docs/api/v3/update-non-employee-record.api.mdx +++ b/docs/api/v3/update-non-employee-record.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Non-Employee Record

    @@ -44,7 +42,7 @@ Non-employee record creation request body. Attributes are restricted by user typ Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported. -
    +
    An updated non-employee record. @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -92,7 +90,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -108,4 +106,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/update-password-sync-group.api.mdx b/docs/api/v3/update-password-sync-group.api.mdx index 35efb6416..abe4ebe68 100644 --- a/docs/api/v3/update-password-sync-group.api.mdx +++ b/docs/api/v3/update-password-sync-group.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Password Sync Group by ID

    @@ -32,7 +30,7 @@ This API updates the specified password sync group. A token with ORG_ADMIN autho ## Request -

    Path Parameters

    Body

    required
    +

    Path Parameters

    Body

    required
    Reference to the password sync group. @@ -64,7 +62,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -76,7 +74,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -92,4 +90,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/update-provisioning-policies-in-bulk.api.mdx b/docs/api/v3/update-provisioning-policies-in-bulk.api.mdx index 1beec0f42..daca6aaa3 100644 --- a/docs/api/v3/update-provisioning-policies-in-bulk.api.mdx +++ b/docs/api/v3/update-provisioning-policies-in-bulk.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Bulk Update Provisioning Policies

    @@ -33,7 +31,7 @@ A token with API, or ORG_ADMIN authority is required to call this API. ## Request -

    Path Parameters

    Body

    arrayrequired
    • Array [
      • fields object[]
    • Array [
    • ]
    • ]
    +

    Path Parameters

    Body

    arrayrequired
    • Array [
      • fields object[]
    • Array [
    • ]
    • ]
    A list of the ProvisioningPolicyDto was successfully replaced. @@ -65,7 +63,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -77,7 +75,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -93,4 +91,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/update-provisioning-policy.api.mdx b/docs/api/v3/update-provisioning-policy.api.mdx index 22361768d..870d133bb 100644 --- a/docs/api/v3/update-provisioning-policy.api.mdx +++ b/docs/api/v3/update-provisioning-policy.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Partial update of Provisioning Policy

    @@ -59,7 +57,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • The ProvisioningPolicyDto was successfully updated. @@ -91,7 +89,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -103,7 +101,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -119,4 +117,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/update-public-identity-config.api.mdx b/docs/api/v3/update-public-identity-config.api.mdx index 491b5d2df..d11ad07bb 100644 --- a/docs/api/v3/update-public-identity-config.api.mdx +++ b/docs/api/v3/update-public-identity-config.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update the Public Identities Configuration

    @@ -40,7 +38,7 @@ Up to 5 identity attributes that will be available to everyone in the org for al The identity who last modified this configuration. -
    +
    Request succeeded. @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    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. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/update-scheduled-search.api.mdx b/docs/api/v3/update-scheduled-search.api.mdx index a843abf59..77aa468de 100644 --- a/docs/api/v3/update-scheduled-search.api.mdx +++ b/docs/api/v3/update-scheduled-search.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update an existing Scheduled Search

    @@ -67,7 +65,7 @@ The hours selected. A list of identities that should receive the scheduled search report via email. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • The persisted scheduled search. @@ -129,7 +127,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -141,7 +139,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -157,4 +155,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/update-source-schema.api.mdx b/docs/api/v3/update-source-schema.api.mdx index 77ed90f87..97a38341c 100644 --- a/docs/api/v3/update-source-schema.api.mdx +++ b/docs/api/v3/update-source-schema.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Source Schema (Partial)

    @@ -85,7 +83,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • The Schema was successfully updated. @@ -125,7 +123,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -137,7 +135,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -153,4 +151,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/update-source.api.mdx b/docs/api/v3/update-source.api.mdx index 08ac829a8..ca33ee9c6 100644 --- a/docs/api/v3/update-source.api.mdx +++ b/docs/api/v3/update-source.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update Source (Partial)

    @@ -73,7 +71,7 @@ string integer -
  • ]
  • ]
    • +
  • ]
  • ]
    • Updated Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design. @@ -147,7 +145,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -159,7 +157,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -175,4 +173,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/update-status-check-details.api.mdx b/docs/api/v3/update-status-check-details.api.mdx index 356e550d8..31a6794a6 100644 --- a/docs/api/v3/update-status-check-details.api.mdx +++ b/docs/api/v3/update-status-check-details.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update the time check configuration

    @@ -36,7 +34,7 @@ Update the time check configuration of queued SDIM tickets. A token with Org Ad the modified time check configuration -
    +
    QueuedCheckConfigDetails as updated @@ -68,7 +66,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -80,7 +78,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -96,4 +94,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/api/v3/update-transform.api.mdx b/docs/api/v3/update-transform.api.mdx index 92bb12b11..5c0efbe8b 100644 --- a/docs/api/v3/update-transform.api.mdx +++ b/docs/api/v3/update-transform.api.mdx @@ -18,8 +18,6 @@ import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem";

    Update a transform

    @@ -269,7 +267,7 @@ This is an optional attribute that can explicitly define the input data which wi This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. -
    +
    Indicates the transform was successfully updated and returns its new representation. @@ -533,7 +531,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    • An example of a 403 response object
    +
  • Array [
  • ]

    • An example of a 403 response object

    Not Found - returned if the request URL refers to a resource or object that does not exist @@ -545,7 +543,7 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 404 response object
    +
  • Array [
  • ]

    • An example of a 404 response object

    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. @@ -561,4 +559,4 @@ Generic localized reason for error Plain-text descriptive reasons to provide additional detail to the text provided in the messages field -
  • Array [
  • ]
    •  An example of a 500 response object \ No newline at end of file +
  • Array [
  • ]

    • An example of a 500 response object

     \ No newline at end of file diff --git a/docs/connectivity.md b/docs/connectivity.md new file mode 100644 index 000000000..e9f97beb6 --- /dev/null +++ b/docs/connectivity.md @@ -0,0 +1,29 @@ +--- +id: connectivity +title: Connectivity +pagination_label: Connectivity +sidebar_label: Connectivity +sidebar_position: 1 +sidebar_class_name: connectivity +keywords: ['connectivity'] +description: Build and expand ISC connectivity. +slug: /connectivity +tags: ['connectivity'] +--- + +## Overview + +Connectivity refers to Identity Security Cloud's (ISC) ability to connect to many different [sources](https://documentation.sailpoint.com/saas/help/sources/index.html) of many different types. Organizations can then manage access to the different sources and ensure that the access is secure. + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + +## Discuss + +The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions. + +To learn more about ISC connectivity and discuss it with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/isc/6). diff --git a/products/idn/docs/identity-now/saas-connectivity/assets/SaaS_Connectivity.postman_collection b/docs/connectivity/saas-connectivity/assets/SaaS_Connectivity.postman_collection similarity index 100% rename from products/idn/docs/identity-now/saas-connectivity/assets/SaaS_Connectivity.postman_collection rename to docs/connectivity/saas-connectivity/assets/SaaS_Connectivity.postman_collection diff --git a/products/idn/docs/identity-now/saas-connectivity/common-cli-commands.md b/docs/connectivity/saas-connectivity/common-cli-commands.md similarity index 71% rename from products/idn/docs/identity-now/saas-connectivity/common-cli-commands.md rename to docs/connectivity/saas-connectivity/common-cli-commands.md index 36b2f0820..0b8e6f2b4 100644 --- a/products/idn/docs/identity-now/saas-connectivity/common-cli-commands.md +++ b/docs/connectivity/saas-connectivity/common-cli-commands.md @@ -7,7 +7,7 @@ sidebar_position: 3 sidebar_class_name: commonCliCommands keywords: ['connectivity', 'connectors', 'commands', 'cli'] description: These are the CLI commands most commonly used when building SaaS Connectors. -slug: /docs/saas-connectivity/common-cli-commands +slug: /connectivity/saas-connectivity/common-cli-commands tags: ['Connectivity'] --- @@ -18,21 +18,21 @@ Below is a list of commands and their usages: - Create a customizer on your local system `sail conn customizers init "my-customizer-project"` - Test your connector or customizer locally: `npm run debug` - **Deployment** - - Create an empty connector in your IDN Org (used to get id so you can upload): `sail conn create "my-project"` - - Create an empty customizer in your IDN Org (used to get id so you can upload): `sail conn customizers create "my-customizer-project"` + - Create an empty connector in your ISC Org (used to get id so you can upload): `sail conn create "my-project"` + - Create an empty customizer in your ISC Org (used to get id so you can upload): `sail conn customizers create "my-customizer-project"` - Build a project: `npm run pack-zip` - - Upload your connector to your IDN Org: `sail conn upload -c [connectorID | connectorAlias] -f dist/[connector filename].zip` - - Upload your customizer to your IDN Org: `sail conn customizers upload -c [customizerID] -f dist/[customizer filename].zip` + - Upload your connector to your ISC Org: `sail conn upload -c [connectorID | connectorAlias] -f dist/[connector filename].zip` + - Upload your customizer to your ISC Org: `sail conn customizers upload -c [customizerID] -f dist/[customizer filename].zip` - **Exploring** - - List connectors in your IDN Org: `sail conn list` - - List customizers in your IDN Org: `sail conn customizers list` - - List source instances in your IDN Org: `sail conn instances list` + - List connectors in your ISC Org: `sail conn list` + - List customizers in your ISC Org: `sail conn customizers list` + - List source instances in your ISC Org: `sail conn instances list` - List your connector tags: `sail conn tags list -c [connectorID | connectorAlias]` - **Testing and Debugging** - - Test your connector on the IDN Org: `sail connectors invoke [action] -c [connectorID | connectorAlias] -p config.json` + - Test your connector on the ISC Org: `sail connectors invoke [action] -c [connectorID | connectorAlias] -p config.json` - Get a list of actions: `sail conn invoke -h` - Run read-only integration tests against your connector: `sail conn validate -p config.json -c [connectorID | connectorAlias] -r` - - Tail IDN Org connector logs: `sail conn logs tail` + - Tail ISC Org connector logs: `sail conn logs tail` - **Delete** - Delete a connector: `sail conn delete -c [connectorID | connectorAlias]` - **Linking** diff --git a/products/idn/docs/identity-now/saas-connectivity/connector-commands/account-create.md b/docs/connectivity/saas-connectivity/connector-commands/account-create.md similarity index 92% rename from products/idn/docs/identity-now/saas-connectivity/connector-commands/account-create.md rename to docs/connectivity/saas-connectivity/connector-commands/account-create.md index f606d4a36..477522c15 100644 --- a/products/idn/docs/identity-now/saas-connectivity/connector-commands/account-create.md +++ b/docs/connectivity/saas-connectivity/connector-commands/account-create.md @@ -5,7 +5,7 @@ pagination_label: Account Create sidebar_label: Account Create keywords: ['connectivity', 'connectors', 'account create'] description: Create account on the source. -slug: /docs/saas-connectivity/commands/account-create +slug: /connectivity/saas-connectivity/commands/account-create tags: ['Connectivity', 'Connector Command'] --- @@ -57,13 +57,13 @@ tags: ['Connectivity', 'Connector Command'] ## Description -The account create command triggers whenever IDN is told to provision entitlements for an identity on the target source, but no account for the identity on the target source exists yet. For example, if you create an access profile that grants a group on the target source and then add that access profile to a role, any identity matching that role’s membership criteria will be granted to the group. IDN determines which identities do not have accounts on the target source and triggers the account create command for each identity. If an identity already has an account, then it invokes the account update command. +The account create command triggers whenever ISC is told to provision entitlements for an identity on the target source, but no account for the identity on the target source exists yet. For example, if you create an access profile that grants a group on the target source and then add that access profile to a role, any identity matching that role’s membership criteria will be granted to the group. ISC determines which identities do not have accounts on the target source and triggers the account create command for each identity. If an identity already has an account, then it invokes the account update command. ## The Provisioning Plan -The account create command accepts a provisioning plan from IDN and creates the corresponding account(s) in the target source. When you configure your source in IDN, you must set up ‘Create Profile’ to tell IDN how to provision new accounts for your source. +The account create command accepts a provisioning plan from ISC and creates the corresponding account(s) in the target source. When you configure your source in ISC, you must set up ‘Create Profile’ to tell ISC how to provision new accounts for your source. -You can create the provisioning plan through the `accountCreateTemplate` in the `connector-spec.json` file, and you can also modify its behavior in IDN using the create profile screen: +You can create the provisioning plan through the `accountCreateTemplate` in the `connector-spec.json` file, and you can also modify its behavior in ISC using the create profile screen: ![Account Create](./img/account_create_idn.png) @@ -177,7 +177,7 @@ public static createWithStdAccountCreateInput(record: StdAccountCreateInput): Ai ## The return object -When the account is returned to IDN, any values you set are updated in IDN. So if an account ID is auto-generated on the source system, you must send the account ID back to IDN so IDN is aware of it for future account update activities. This is useful for the compound key type. +When the account is returned to ISC, any values you set are updated in ISC. So if an account ID is auto-generated on the source system, you must send the account ID back to ISC so ISC is aware of it for future account update activities. This is useful for the compound key type. ## Password Handling @@ -224,9 +224,9 @@ async createAccount(input: StdAccountCreateInput): Promise { } ``` -## Testing in IdentityNow +## Testing in Identity Security Cloud -One way to test whether the account create code works in IDN is to set up an access profile and role that grants members an entitlement from the connector’s target source. Start by creating an access profile that grants one or more entitlements from the target source. +One way to test whether the account create code works in ISC is to set up an access profile and role that grants members an entitlement from the connector’s target source. Start by creating an access profile that grants one or more entitlements from the target source. ![Testing 1](./img/testing1.png) diff --git a/products/idn/docs/identity-now/saas-connectivity/connector-commands/account-delete.md b/docs/connectivity/saas-connectivity/connector-commands/account-delete.md similarity index 78% rename from products/idn/docs/identity-now/saas-connectivity/connector-commands/account-delete.md rename to docs/connectivity/saas-connectivity/connector-commands/account-delete.md index a86dbdddd..2ce42fedf 100644 --- a/products/idn/docs/identity-now/saas-connectivity/connector-commands/account-delete.md +++ b/docs/connectivity/saas-connectivity/connector-commands/account-delete.md @@ -5,7 +5,7 @@ pagination_label: Account Delete sidebar_label: Account Delete keywords: ['connectivity', 'connectors', 'account delete'] description: Remove account from a source. -slug: /docs/saas-connectivity/commands/account-delete +slug: /connectivity/saas-connectivity/commands/account-delete tags: ['Connectivity', 'Connector Command'] --- @@ -36,9 +36,9 @@ tags: ['Connectivity', 'Connector Command'] ## Description -The account delete command sends one attribute from IDN, the identity to delete. This can be passed to your connector to delete the account from the source system. +The account delete command sends one attribute from ISC, the identity to delete. This can be passed to your connector to delete the account from the source system. -Enable account delete in IDN through a BeforeProvisioning rule. The connector honors whichever operation the provisioning plan sends. For more information, see the [documentation](https://community.sailpoint.com/t5/IdentityNow-Articles/IdentityNow-Rule-Guide/ta-p/76665) and an [example implementation](https://community.sailpoint.com/t5/IdentityNow-Wiki/IdentityNow-Rule-Guide-Before-Provisioning-Rule/ta-p/77415). +Enable account delete in ISC through a BeforeProvisioning rule. The connector honors whichever operation the provisioning plan sends. For more information, see the [documentation](https://community.sailpoint.com/t5/Identity Security Cloud-Articles/Identity Security Cloud-Rule-Guide/ta-p/76665) and an [example implementation](https://community.sailpoint.com/t5/Identity Security Cloud-Wiki/Identity Security Cloud-Rule-Guide-Before-Provisioning-Rule/ta-p/77415). The following snippet shows an example of account delete command implementation: diff --git a/products/idn/docs/identity-now/saas-connectivity/connector-commands/account-disable.md b/docs/connectivity/saas-connectivity/connector-commands/account-disable.md similarity index 95% rename from products/idn/docs/identity-now/saas-connectivity/connector-commands/account-disable.md rename to docs/connectivity/saas-connectivity/connector-commands/account-disable.md index 394a990a6..105371100 100644 --- a/products/idn/docs/identity-now/saas-connectivity/connector-commands/account-disable.md +++ b/docs/connectivity/saas-connectivity/connector-commands/account-disable.md @@ -5,7 +5,7 @@ pagination_label: Account Disable sidebar_label: Account Disable keywords: ['connectivity', 'connectors', 'account disable'] description: Disable an account on the source. -slug: /docs/saas-connectivity/commands/account-disable +slug: /connectivity/saas-connectivity/commands/account-disable tags: ['Connectivity', 'Connector Command'] --- @@ -54,7 +54,7 @@ You typically invoke the `account disable` command during the joiner, mover, lea Disabling accounts is generally preferred if the source supports account disabling so the account data remains for later reactivation or inspection. If the source does not support account disabling, or deleting accounts is preferred when an identity leaves the organization, the connector can perform the necessary steps to delete an account with the account disable function. -> 🚧 It is important to note that although SaaS Connectivity supports the account delete command, IDN never sends the account delete command, only the account disable command. The connector’s developer determines the appropriate action for account disable on the source. +> 🚧 It is important to note that although SaaS Connectivity supports the account delete command, ISC never sends the account delete command, only the account disable command. The connector’s developer determines the appropriate action for account disable on the source. Account disable is similar to implementing the account update command. If you have implemented your source call to modify any of the values on your source, then you can use the same method to implement the command. The following code implements disable: diff --git a/products/idn/docs/identity-now/saas-connectivity/connector-commands/account-discover.md b/docs/connectivity/saas-connectivity/connector-commands/account-discover.md similarity index 94% rename from products/idn/docs/identity-now/saas-connectivity/connector-commands/account-discover.md rename to docs/connectivity/saas-connectivity/connector-commands/account-discover.md index cec06a8fb..f83efc723 100644 --- a/products/idn/docs/identity-now/saas-connectivity/connector-commands/account-discover.md +++ b/docs/connectivity/saas-connectivity/connector-commands/account-discover.md @@ -5,7 +5,7 @@ pagination_label: Account Discover sidebar_label: Account Discover keywords: ['connectivity', 'connectors', 'account discover'] description: Dynamically determine account schema from the source. -slug: /docs/saas-connectivity/commands/account-discover +slug: /connectivity/saas-connectivity/commands/account-discover tags: ['Connectivity', 'Connector Command'] --- @@ -51,7 +51,7 @@ tags: ['Connectivity', 'Connector Command'] ## Description -The account discover schema command tells IDN to dynamically create the account schema for the source rather than use the account schema provided by the connector in connector-spec.json. It is often ideal to statically define the account schema because it is generally more performant and easier to develop and reason about the code. However, some sources have schemas that can be different for each customer deployment. It can also be difficult to determine which account attributes to statically expose, which requires the schema to be dynamically generated. SalesForce is an example of a source that can have thousands of account attributes, which makes it impractical to statically define a set of attributes that satisfies all connector users. Although the SalesForce connector defines a standard set of account attributes out of the box, it also allows schema discovery for users looking for more attributes. +The account discover schema command tells ISC to dynamically create the account schema for the source rather than use the account schema provided by the connector in connector-spec.json. It is often ideal to statically define the account schema because it is generally more performant and easier to develop and reason about the code. However, some sources have schemas that can be different for each customer deployment. It can also be difficult to determine which account attributes to statically expose, which requires the schema to be dynamically generated. SalesForce is an example of a source that can have thousands of account attributes, which makes it impractical to statically define a set of attributes that satisfies all connector users. Although the SalesForce connector defines a standard set of account attributes out of the box, it also allows schema discovery for users looking for more attributes. ## Implementation @@ -229,7 +229,7 @@ export const connector = async () => { } ``` -Next, implement the `discoverSchema()` function in your client code. The following function calls the necessary endpoints to get the full schema of the user account you want to represent in IDN. After you receive a response from your call, you must build your account schema object that will return to IDN. The response has a structure like the accountSchema property in the connector-spec.json file. The following is an example from [airtable.ts](https://github.com/sailpoint-oss/airtable-example-connector/blob/main/src/airtable.ts). +Next, implement the `discoverSchema()` function in your client code. The following function calls the necessary endpoints to get the full schema of the user account you want to represent in ISC. After you receive a response from your call, you must build your account schema object that will return to ISC. The response has a structure like the accountSchema property in the connector-spec.json file. The following is an example from [airtable.ts](https://github.com/sailpoint-oss/airtable-example-connector/blob/main/src/airtable.ts). ```javascript async getAccountSchema(): Promise { @@ -276,7 +276,7 @@ async getAccountSchema(): Promise { } ``` -This code produces the following payload that will be sent back to IDN. +This code produces the following payload that will be sent back to ISC. ```javascript { @@ -343,9 +343,9 @@ This code produces the following payload that will be sent back to IDN. There are many properties in this payload, so you may want to remove some, but it can be hard to determine which properties to keep in a dynamic way. If you can programmatically determine which properties to remove, you can alter the `discoverSchema()` function to remove them. -## Test in IdentityNow +## Test in Identity Security Cloud -To test the account discover schema command in IDN, ensure that you upload your latest connector code and create a new source in IDN. After you configure and test your source connection, go to the ‘Account Schema’ page. You will see an empty schema. +To test the account discover schema command in ISC, ensure that you upload your latest connector code and create a new source in ISC. After you configure and test your source connection, go to the ‘Account Schema’ page. You will see an empty schema. ![Discover Schema 1](./img/discover_schema_idn1.png) @@ -353,7 +353,7 @@ To discover the schema for this source, click the ‘Options’ dropdown in the ![Discover Schema 2](./img/discover_schema_idn2.png) -IDN then asks you to assign attributes to ‘Account ID’ and 'Account Name.' +ISC then asks you to assign attributes to ‘Account ID’ and 'Account Name.' ![Discover Schema 3](./img/discover_schema_idn3.png) diff --git a/products/idn/docs/identity-now/saas-connectivity/connector-commands/account-enable.md b/docs/connectivity/saas-connectivity/connector-commands/account-enable.md similarity index 96% rename from products/idn/docs/identity-now/saas-connectivity/connector-commands/account-enable.md rename to docs/connectivity/saas-connectivity/connector-commands/account-enable.md index 48739fa53..1158ac2b0 100644 --- a/products/idn/docs/identity-now/saas-connectivity/connector-commands/account-enable.md +++ b/docs/connectivity/saas-connectivity/connector-commands/account-enable.md @@ -5,7 +5,7 @@ pagination_label: Account Enable sidebar_label: Account Enable keywords: ['connectivity', 'connectors', 'account enable'] description: Enable an account on the source. -slug: /docs/saas-connectivity/commands/account-enable +slug: /connectivity/saas-connectivity/commands/account-enable tags: ['Connectivity', 'Connector Command'] --- diff --git a/products/idn/docs/identity-now/saas-connectivity/connector-commands/account-list.md b/docs/connectivity/saas-connectivity/connector-commands/account-list.md similarity index 91% rename from products/idn/docs/identity-now/saas-connectivity/connector-commands/account-list.md rename to docs/connectivity/saas-connectivity/connector-commands/account-list.md index 2051d2c94..05c110a32 100644 --- a/products/idn/docs/identity-now/saas-connectivity/connector-commands/account-list.md +++ b/docs/connectivity/saas-connectivity/connector-commands/account-list.md @@ -4,8 +4,8 @@ title: Account List pagination_label: Account List sidebar_label: Account List keywords: ['connectivity', 'connectors', 'account list'] -description: Aggregate all accounts from the source into IdentityNow. -slug: /docs/saas-connectivity/commands/account-list +description: Aggregate all accounts from the source into Identity Security Cloud. +slug: /connectivity/saas-connectivity/commands/account-list tags: ['Connectivity', 'Connector Command'] --- @@ -47,7 +47,7 @@ tags: ['Connectivity', 'Connector Command'] ## Description -The account list command aggregates all accounts from the target source into IdentityNow. IDN calls this command during a manual or scheduled account aggregation. +The account list command aggregates all accounts from the target source into Identity Security Cloud. ISC calls this command during a manual or scheduled account aggregation. ![Account List](./img/account_list_idn.png) @@ -73,13 +73,13 @@ async getAllAccounts(): Promise { :::caution Important -IDN will throw a connection timeout error if your connector doesn't respond within 3 minutes, and there are memory limitations involved with aggregating data. To prevent large memory utilization or timeout errors, you should set up your connectors to send data to IDN as it's retrieved from your source system. For more details and an example, refer to [Connector Timeouts](../in-depth/connector-timeouts.md). +ISC will throw a connection timeout error if your connector doesn't respond within 3 minutes, and there are memory limitations involved with aggregating data. To prevent large memory utilization or timeout errors, you should set up your connectors to send data to ISC as it's retrieved from your source system. For more details and an example, refer to [Connector Timeouts](../in-depth/connector-timeouts.md). ::: :::caution Important -IDN supports [delta aggregation](#delta-aggregation-state). If your source has a large number of accounts that will be syncronized with IDN, then it is highly recommended to utilize [delta aggregation](#delta-aggregation-state) for the source. +ISC supports [delta aggregation](#delta-aggregation-state). If your source has a large number of accounts that will be syncronized with ISC, then it is highly recommended to utilize [delta aggregation](#delta-aggregation-state) for the source. ::: @@ -105,7 +105,7 @@ export const connector = async () => { ... ``` -IDN expects each user in the target source to be converted into a format IDN understands. The specific attributes the web service returns depend on what your source provides. +ISC expects each user in the target source to be converted into a format ISC understands. The specific attributes the web service returns depend on what your source provides. ```javascript public toStdAccountListOutput(): StdAccountListOutput { @@ -130,7 +130,7 @@ private buildStandardObject(): StdAccountListOutput | StdAccountCreateOutput | S } ``` -The result of the account list command is not an array of objects but several individual objects. This is the format IDN expects, so if you see something like the following result while testing, it is normal: +The result of the account list command is not an array of objects but several individual objects. This is the format ISC expects, so if you see something like the following result while testing, it is normal: ```javascript { @@ -193,7 +193,7 @@ If your source can keep track of changes to the data in some way, then delta agg } ``` -2. In the ```stdAccountList``` command, when you are done sending accounts, you need to also send the state to IDN so it knows where to start the next time it sends a list request: +2. In the ```stdAccountList``` command, when you are done sending accounts, you need to also send the state to ISC so it knows where to start the next time it sends a list request: ```javascript const state = {"data": Date.now().toString()} diff --git a/products/idn/docs/identity-now/saas-connectivity/connector-commands/account-read.md b/docs/connectivity/saas-connectivity/connector-commands/account-read.md similarity index 89% rename from products/idn/docs/identity-now/saas-connectivity/connector-commands/account-read.md rename to docs/connectivity/saas-connectivity/connector-commands/account-read.md index 4ecf6baa5..21d3e0a2e 100644 --- a/products/idn/docs/identity-now/saas-connectivity/connector-commands/account-read.md +++ b/docs/connectivity/saas-connectivity/connector-commands/account-read.md @@ -4,8 +4,8 @@ title: Account Read pagination_label: Account Read sidebar_label: Account Read keywords: ['connectivity', 'connectors', 'account read'] -description: Aggregate a single account from the source into IdentityNow. -slug: /docs/saas-connectivity/commands/account-read +description: Aggregate a single account from the source into Identity Security Cloud. +slug: /connectivity/saas-connectivity/commands/account-read tags: ['Connectivity', 'Connector Command'] --- @@ -50,7 +50,7 @@ tags: ['Connectivity', 'Connector Command'] ## Description -The account read command aggregates a single account from the target source into IdentityNow. IDN can call this command during a “one-off” account refresh, which you can trigger by aggregating an individual account in IDN. +The account read command aggregates a single account from the target source into Identity Security Cloud. ISC can call this command during a “one-off” account refresh, which you can trigger by aggregating an individual account in ISC. ![Account Read](./img/account_read_idn.png) @@ -84,7 +84,7 @@ async getAccount(identity: SimpleKeyType | CompoundKeyType): Promise>CUS: StdAccountRead Request + ISC->>CUS: StdAccountRead Request CUS->>CON: Mutated StdAccountRead Request CON->>CUS: StdAccountRead Response - CUS->>IDN: Mutated StdAccountRead Response + CUS->>ISC: Mutated StdAccountRead Response ``` diff --git a/products/idn/docs/identity-now/saas-connectivity/connector-customizers/link.md b/docs/connectivity/saas-connectivity/connector-customizers/link.md similarity index 92% rename from products/idn/docs/identity-now/saas-connectivity/connector-customizers/link.md rename to docs/connectivity/saas-connectivity/connector-customizers/link.md index 6fa57def2..7e3175484 100644 --- a/products/idn/docs/identity-now/saas-connectivity/connector-customizers/link.md +++ b/docs/connectivity/saas-connectivity/connector-customizers/link.md @@ -7,7 +7,7 @@ sidebar_position: 6 sidebar_class_name: saasConnectivity keywords: ['connectivity', 'connectors', customizers] description: Link connectivity customizers to sources. -slug: /docs/saas-connectivity/customizers/linking +slug: /connectivity/saas-connectivity/customizers/linking tags: ['Connectivity'] --- @@ -15,7 +15,7 @@ tags: ['Connectivity'] ### Initial requirements -Before you can link a connector customizer to a source, you must have a SaaS source in IdentityNow, as well as a Customizer built and deployed. You can use the following commands to get a list of valid sources, as well as customizers: +Before you can link a connector customizer to a source, you must have a SaaS source in Identity Security Cloud, as well as a Customizer built and deployed. You can use the following commands to get a list of valid sources, as well as customizers: Use this command to find sources: diff --git a/products/idn/docs/identity-now/saas-connectivity/connector-customizers/testing.md b/docs/connectivity/saas-connectivity/connector-customizers/testing.md similarity index 97% rename from products/idn/docs/identity-now/saas-connectivity/connector-customizers/testing.md rename to docs/connectivity/saas-connectivity/connector-customizers/testing.md index 4cb4b49b1..d296a21c4 100644 --- a/products/idn/docs/identity-now/saas-connectivity/connector-customizers/testing.md +++ b/docs/connectivity/saas-connectivity/connector-customizers/testing.md @@ -7,7 +7,7 @@ sidebar_position: 6 sidebar_class_name: saasConnectivity keywords: ['connectivity', 'connectors', customizers] description: Test and debug connectors with customizers. -slug: /docs/saas-connectivity/customizers/testing +slug: /connectivity/saas-connectivity/customizers/testing tags: ['Connectivity'] --- diff --git a/products/idn/docs/identity-now/saas-connectivity/connector-customizers/upload.md b/docs/connectivity/saas-connectivity/connector-customizers/upload.md similarity index 84% rename from products/idn/docs/identity-now/saas-connectivity/connector-customizers/upload.md rename to docs/connectivity/saas-connectivity/connector-customizers/upload.md index 1e64dcd58..bc63c34e2 100644 --- a/products/idn/docs/identity-now/saas-connectivity/connector-customizers/upload.md +++ b/docs/connectivity/saas-connectivity/connector-customizers/upload.md @@ -1,17 +1,17 @@ --- id: connectivity-customizers-uploading -title: Build and Upload into Identity Now +title: Build and Upload into Identity Security Cloud pagination_label: Build and Upload sidebar_label: Build and Upload sidebar_position: 5 sidebar_class_name: saasConnectivity keywords: ['connectivity', 'connectors', customizers] description: Build and upload connectivity customizers. -slug: /docs/saas-connectivity/customizers/upload +slug: /connectivity/saas-connectivity/customizers/upload tags: ['Connectivity'] --- -# Building and uploading to Identity Now +# Building and uploading to Identity Security Cloud ### Initial requirements @@ -48,9 +48,9 @@ After the build is complete, you will see a message like this: Connector zip file created under dist folder: my-connector-customizer-0.1.0.zip ``` -### Upload to IdentityNow +### Upload to Identity Security Cloud -To upload the customizer to IdentityNow, use the upload command: +To upload the customizer to Identity Security Cloud, use the upload command: ```bash sail conn customizers upload -c 7b968fab-0f40-49f0-b13b-8bf529fc0b82 -f .\dist\my-connector-customizer-0.1.0.zip diff --git a/products/idn/docs/identity-now/saas-connectivity/connector-spec/card.md b/docs/connectivity/saas-connectivity/connector-spec/card.md similarity index 97% rename from products/idn/docs/identity-now/saas-connectivity/connector-spec/card.md rename to docs/connectivity/saas-connectivity/connector-spec/card.md index 4a0d8f5e2..c07a1bac9 100644 --- a/products/idn/docs/identity-now/saas-connectivity/connector-spec/card.md +++ b/docs/connectivity/saas-connectivity/connector-spec/card.md @@ -5,7 +5,7 @@ pagination_label: Card sidebar_label: Card keywords: ['connectivity', 'connectors','connector-spec', 'card'] description: Details on using the card item -slug: /docs/saas-connectivity/connector-spec/card +slug: /connectivity/saas-connectivity/connector-spec/card tags: ['Connectivity', 'Connector Spec'] --- diff --git a/products/idn/docs/identity-now/saas-connectivity/connector-spec/index.md b/docs/connectivity/saas-connectivity/connector-spec/index.md similarity index 77% rename from products/idn/docs/identity-now/saas-connectivity/connector-spec/index.md rename to docs/connectivity/saas-connectivity/connector-spec/index.md index 5dc05b339..f07790122 100644 --- a/products/idn/docs/identity-now/saas-connectivity/connector-spec/index.md +++ b/docs/connectivity/saas-connectivity/connector-spec/index.md @@ -6,14 +6,14 @@ sidebar_label: Connector Spec File sidebar_position: 4 sidebar_class_name: connectorSpecFile keywords: ['connectivity', 'connectors', 'spec', 'specification'] -description: The connector spec file tells IDN how the connector should interact between IDN and the custom connector. It is the glue between IDN and the connector, so understanding the different sections are key to understanding how to build a custom connectors. -slug: /docs/saas-connectivity/connector-spec +description: The connector spec file tells ISC how the connector should interact between ISC and the custom connector. It is the glue between ISC and the connector, so understanding the different sections are key to understanding how to build a custom connectors. +slug: /connectivity/saas-connectivity/connector-spec tags: ['Connectivity'] --- ## Summary -The connector spec file tells IDN how the connector should interact between IDN and the custom connector. It is the glue between IDN and the connector, so understanding the different sections are key to understanding how to build a custom connectors. +The connector spec file tells ISC how the connector should interact between ISC and the custom connector. It is the glue between ISC and the connector, so understanding the different sections are key to understanding how to build a custom connectors. ## Sample File @@ -23,17 +23,17 @@ To see a sample spec file, see this link: [connector-spec.json](https://github.c The following describes in detail the different fields in the connector spec: -- **name:** The name of the connector as it appears in IDN. Tags can be appended to this name. +- **name:** The name of the connector as it appears in ISC. Tags can be appended to this name. - **keyType:** Either “simple” or “compound” This determines which type of key your connector expects to receive and send back for each of the commands. This must always be indicated in your connector spec - the connector returns the correct type for each command that returns a key type. - For example, the stdAccountRead command input is the StdAccountReadInput. if you select keyType as “simple,” then the StdAccountReadInput.key will be the type SimpleKey. - **commands:** The list of commands the connector supports. A full list of available commands can be found [here](../connector-commands/index.md). - -- **sourceConfig** A list of configuration items you must provide when you create a source in IDN. The order of these items is preserved in the UI. +- **[sourceConfigInitialValues](./connector-spec/initial-value):** Key value pair of source config item keys and the default value that should be associated with them. +- **sourceConfig** A list of configuration items you must provide when you create a source in ISC. The order of these items is preserved in the UI. - **type:** This is always “menu” - it indicates a new menu for the sidebar. You can have multiple sections defined for complex connector configurations - - **label:** This label indicates the text that will show up on the sidebar in IDN + - **label:** This label indicates the text that will show up on the sidebar in ISC - **items:** The array of items in the menu - **type:** This is always "section" - it indicates a new section on the page - **sectionTitle:** The large text title that will display for the section. @@ -42,7 +42,7 @@ The following describes in detail the different fields in the connector spec: - **docLink:** The optional link that the docLinkLabel will direct to if clicked. - **key:** The name of the configuration item as it is referenced in code. - **label:** The name of the configuration item as it appears in the UI. - - **required** (Optional): Set to 'false' by default. Valid values are 'true' or 'false.' You must populate required configuration items in the IDN source configuration wizard before continuing. + - **required** (Optional): Set to 'false' by default. Valid values are 'true' or 'false.' You must populate required configuration items in the ISC source configuration wizard before continuing. - **type:** The configuration items' types. The following types are valid: - text - number @@ -57,27 +57,27 @@ The following describes in detail the different fields in the connector spec: - [list](./connector-spec/list) - [keyValue](./connector-spec/key-value) - [cardList](./connector-spec/card) -- **accountSchema:** The schema for an account in IDN populated by data from the source. - - **displayAttribute:** Identifies the attribute (defined below) used to map to `Account Name` in the IdentityNow account schema. This should be a unique value even though it is not required because the connector will use this value to correlate accounts in IDN to accounts in the source system. - - **identityAttribute:** Identifies the attribute (defined below) used to map to `Account ID` in the IdentityNow account schema. This must be a globally unique identifier, such as email address, employee ID, etc. +- **accountSchema:** The schema for an account in ISC populated by data from the source. + - **displayAttribute:** Identifies the attribute (defined below) used to map to `Account Name` in the Identity Security Cloud account schema. This should be a unique value even though it is not required because the connector will use this value to correlate accounts in ISC to accounts in the source system. + - **identityAttribute:** Identifies the attribute (defined below) used to map to `Account ID` in the Identity Security Cloud account schema. This must be a globally unique identifier, such as email address, employee ID, etc. - **groupAttribute:** Identifies the attribute used to map accounts to entitlements. For example, a web service can define `groups` that users are members of, and the `groups` grant entitlements to each user. In this case, **groupAttribute** is “groups,” and there is also an account attribute called “groups”. - **attributes:** One or more attributes that map to a user’s attribute on the target source. Each attribute defines the following: - - **name:** The attribute’s name as it appears in IDN. + - **name:** The attribute’s name as it appears in ISC. - **type:** The attribute’s type. Possible values are `string`, `boolean`, `long`, and `int`. - **description:** A helpful description of the attribute. This is useful to source owners when they are trying to understand the account schema. - - **managed:** This indicates whether the entitlements are manageable through IDN or read-only. - - **entitlement:** This boolean indicates whether the attribute is an entitlement. Entitlements give identities privileges on the source system. Use this indication to determine which fields to synchronize with accounts in IDN for tasks such as separation of duties and role assignment. The boolean indicates whether the attribute is an entitlement. + - **managed:** This indicates whether the entitlements are manageable through ISC or read-only. + - **entitlement:** This boolean indicates whether the attribute is an entitlement. Entitlements give identities privileges on the source system. Use this indication to determine which fields to synchronize with accounts in ISC for tasks such as separation of duties and role assignment. The boolean indicates whether the attribute is an entitlement. - **multi:** This indicates entitlements that are stored in an array format. This one field can store multiple entitlements for a single account. -- **entitlementSchemas:** A list of entitlement schemas in IDN populated by data from the source. +- **entitlementSchemas:** A list of entitlement schemas in ISC populated by data from the source. - **type:** The entitlement’s type. Currently, only `group` is supported. - **displayAttribute:** The entitlement attribute’s name. This can be the `name` or another human friendly identifier for a group. - **identityAttribute:** The entitlement attribute’s unique ID. This can be the `id` or another unique key for a group. - **attributes:** The entitlement’s list of attributes. This list of attributes is an example: `id`, `name`, and `description`. - - **name:** The name of the attribute as it appears in IDN. + - **name:** The name of the attribute as it appears in ISC. - **type:** The attribute’s type. Possible values are `string`, `boolean`, `long`, and `int`. - **description:** A helpful description the attribute. This is useful to source owners when they are trying to understand the account schema. -- **accountCreateTemplate:** A map of identity attributes IDN will pass to the connector to create an account in the target source. - - **key:** The unique identifier of the attribute. This is also the name that is presented in the Create Profile screen in IDN. +- **accountCreateTemplate:** A map of identity attributes ISC will pass to the connector to create an account in the target source. + - **key:** The unique identifier of the attribute. This is also the name that is presented in the Create Profile screen in ISC. - **label:** A friendly name for presentation purposes. - **type:** The attribute’s type. Possible values are `string`, `boolean`, `long`, and `int`. - **initialValue (Optional):** Use this to specify identitAttribute mapping, generator or default values. @@ -88,4 +88,4 @@ The following describes in detail the different fields in the connector spec: - **maxSize:** Use this for the Create Unique Account ID generator type. This value specifies the maximum size of the username to be generated. - **maxUniqueChecks:** Use this for the Create Unique Account ID generator type. This value specifies the maximum retries in case a unique ID is not found with the first random generated user. - **template:** Use this for the Create Unique Account ID generator type. This value specifies the template used for generation. Example: `"$(firstname).$(lastname)$(uniqueCounter)"`. - - **required (Optional):** Determines whether the account create operation requires this attribute. It defaults to `false`. If it is `true` and IdentityNow encounters an identity missing this attribute, IDN does not send the account to the connector for account creation. + - **required (Optional):** Determines whether the account create operation requires this attribute. It defaults to `false`. If it is `true` and Identity Security Cloud encounters an identity missing this attribute, ISC does not send the account to the connector for account creation. diff --git a/docs/connectivity/saas-connectivity/connector-spec/initialValue.md b/docs/connectivity/saas-connectivity/connector-spec/initialValue.md new file mode 100644 index 000000000..bf8d1de34 --- /dev/null +++ b/docs/connectivity/saas-connectivity/connector-spec/initialValue.md @@ -0,0 +1,44 @@ +--- +id: connector-spec-initial-value +title: Initial Value +pagination_label: Initial Value +sidebar_label: Initial Value +keywords: ['connectivity', 'connectors','connector-spec', 'sourceConfigInitialValues'] +description: How to use the sourceConfigInitialValues field +slug: /connectivity/saas-connectivity/connector-spec/initial-value +tags: ['Connectivity', 'Connector Spec'] +--- + +## How to use the sourceConfigInitialValues in the connector spec + +If you want to prepopulate a field in the connector spec configuration with an initial value, you can use the `sourceConfigInitialValues` field in the connector spec to specify the prepopulated value. This can be used across all items. All you need to provide is the item's key and its corresponding default value. This is a simple example using a textbox: + +```json +"sourceConfigInitialValues": { + // Note that the key `airtableURL` is also the key of the item the initial value is provided for + "airtableURL": "https://api.airtable.com/v0" +}, +"sourceConfig": [ + { + "type": "menu", + "label": "Configuration", + "items": [ + { + + "type": "section", + "sectionTitle": "Authentication", + "sectionHelpMessage": "Provide the parameters to connect with the airtable worksheet.", + "items": [ + { + // The key is what you use to assign initial values to the spec + "key": "airtableURL", + "label": "airtable url", + "required": true, + "type": "text" + } + ] + } + ] + } +] +``` \ No newline at end of file diff --git a/products/idn/docs/identity-now/saas-connectivity/connector-spec/keyValue.md b/docs/connectivity/saas-connectivity/connector-spec/keyValue.md similarity index 93% rename from products/idn/docs/identity-now/saas-connectivity/connector-spec/keyValue.md rename to docs/connectivity/saas-connectivity/connector-spec/keyValue.md index d02a51be0..e6c9ef602 100644 --- a/products/idn/docs/identity-now/saas-connectivity/connector-spec/keyValue.md +++ b/docs/connectivity/saas-connectivity/connector-spec/keyValue.md @@ -5,7 +5,7 @@ pagination_label: Key Value sidebar_label: Key Value keywords: ['connectivity', 'connectors','connector-spec', 'keyValue'] description: Details on using the key value item -slug: /docs/saas-connectivity/connector-spec/key-value +slug: /connectivity/saas-connectivity/connector-spec/key-value tags: ['Connectivity', 'Connector Spec'] --- diff --git a/products/idn/docs/identity-now/saas-connectivity/connector-spec/list.md b/docs/connectivity/saas-connectivity/connector-spec/list.md similarity index 91% rename from products/idn/docs/identity-now/saas-connectivity/connector-spec/list.md rename to docs/connectivity/saas-connectivity/connector-spec/list.md index dfd620f38..97f4115cc 100644 --- a/products/idn/docs/identity-now/saas-connectivity/connector-spec/list.md +++ b/docs/connectivity/saas-connectivity/connector-spec/list.md @@ -5,7 +5,7 @@ pagination_label: List sidebar_label: List keywords: ['connectivity', 'connectors','connector-spec', 'list'] description: Details on using the list item -slug: /docs/saas-connectivity/connector-spec/list +slug: /connectivity/saas-connectivity/connector-spec/list tags: ['Connectivity', 'Connector Spec'] --- diff --git a/products/idn/docs/identity-now/saas-connectivity/connector-spec/radio.md b/docs/connectivity/saas-connectivity/connector-spec/radio.md similarity index 95% rename from products/idn/docs/identity-now/saas-connectivity/connector-spec/radio.md rename to docs/connectivity/saas-connectivity/connector-spec/radio.md index 0bb1f951c..b91e3d1b3 100644 --- a/products/idn/docs/identity-now/saas-connectivity/connector-spec/radio.md +++ b/docs/connectivity/saas-connectivity/connector-spec/radio.md @@ -5,7 +5,7 @@ pagination_label: Radio sidebar_label: Radio keywords: ['connectivity', 'connectors','connector-spec', 'radio'] description: Details on using the Radio item -slug: /docs/saas-connectivity/connector-spec/radio +slug: /connectivity/saas-connectivity/connector-spec/radio tags: ['Connectivity', 'Connector Spec'] --- diff --git a/products/idn/docs/identity-now/saas-connectivity/connector-spec/select.md b/docs/connectivity/saas-connectivity/connector-spec/select.md similarity index 95% rename from products/idn/docs/identity-now/saas-connectivity/connector-spec/select.md rename to docs/connectivity/saas-connectivity/connector-spec/select.md index 85adec79b..5d9047b16 100644 --- a/products/idn/docs/identity-now/saas-connectivity/connector-spec/select.md +++ b/docs/connectivity/saas-connectivity/connector-spec/select.md @@ -5,7 +5,7 @@ pagination_label: Select sidebar_label: Select keywords: ['connectivity', 'connectors','connector-spec', 'select'] description: Details on using the select item -slug: /docs/saas-connectivity/connector-spec/select +slug: /connectivity/saas-connectivity/connector-spec/select tags: ['Connectivity', 'Connector Spec'] --- diff --git a/products/idn/docs/identity-now/saas-connectivity/example-connectors.md b/docs/connectivity/saas-connectivity/example-connectors.md similarity index 93% rename from products/idn/docs/identity-now/saas-connectivity/example-connectors.md rename to docs/connectivity/saas-connectivity/example-connectors.md index 6d9fa8267..8485c3287 100644 --- a/products/idn/docs/identity-now/saas-connectivity/example-connectors.md +++ b/docs/connectivity/saas-connectivity/example-connectors.md @@ -7,7 +7,7 @@ sidebar_position: 5 sidebar_class_name: exampleConnectors keywords: ['connectivity', 'connectors', 'example'] description: Here are a few example connectors that were built for you to download and learn from. -slug: /docs/saas-connectivity/example-connectors +slug: /connectivity/saas-connectivity/example-connectors tags: ['Connectivity'] --- diff --git a/products/idn/docs/identity-now/saas-connectivity/img/button.svg b/docs/connectivity/saas-connectivity/img/button.svg similarity index 100% rename from products/idn/docs/identity-now/saas-connectivity/img/button.svg rename to docs/connectivity/saas-connectivity/img/button.svg diff --git a/products/idn/docs/identity-now/saas-connectivity/img/card.png b/docs/connectivity/saas-connectivity/img/card.png similarity index 100% rename from products/idn/docs/identity-now/saas-connectivity/img/card.png rename to docs/connectivity/saas-connectivity/img/card.png diff --git a/products/idn/docs/identity-now/saas-connectivity/img/cardMenu.png b/docs/connectivity/saas-connectivity/img/cardMenu.png similarity index 100% rename from products/idn/docs/identity-now/saas-connectivity/img/cardMenu.png rename to docs/connectivity/saas-connectivity/img/cardMenu.png diff --git a/products/idn/docs/identity-now/saas-connectivity/img/keyValue.png b/docs/connectivity/saas-connectivity/img/keyValue.png similarity index 100% rename from products/idn/docs/identity-now/saas-connectivity/img/keyValue.png rename to docs/connectivity/saas-connectivity/img/keyValue.png diff --git a/products/idn/docs/identity-now/saas-connectivity/img/list.png b/docs/connectivity/saas-connectivity/img/list.png similarity index 100% rename from products/idn/docs/identity-now/saas-connectivity/img/list.png rename to docs/connectivity/saas-connectivity/img/list.png diff --git a/products/idn/docs/identity-now/saas-connectivity/img/new_connectivity_diagram.png b/docs/connectivity/saas-connectivity/img/new_connectivity_diagram.png similarity index 100% rename from products/idn/docs/identity-now/saas-connectivity/img/new_connectivity_diagram.png rename to docs/connectivity/saas-connectivity/img/new_connectivity_diagram.png diff --git a/products/idn/docs/identity-now/saas-connectivity/img/new_connectivity_diagram_both.png b/docs/connectivity/saas-connectivity/img/new_connectivity_diagram_both.png similarity index 100% rename from products/idn/docs/identity-now/saas-connectivity/img/new_connectivity_diagram_both.png rename to docs/connectivity/saas-connectivity/img/new_connectivity_diagram_both.png diff --git a/products/idn/docs/identity-now/saas-connectivity/img/old_connectivity_diagram.png b/docs/connectivity/saas-connectivity/img/old_connectivity_diagram.png similarity index 100% rename from products/idn/docs/identity-now/saas-connectivity/img/old_connectivity_diagram.png rename to docs/connectivity/saas-connectivity/img/old_connectivity_diagram.png diff --git a/products/idn/docs/identity-now/saas-connectivity/img/radio.png b/docs/connectivity/saas-connectivity/img/radio.png similarity index 100% rename from products/idn/docs/identity-now/saas-connectivity/img/radio.png rename to docs/connectivity/saas-connectivity/img/radio.png diff --git a/products/idn/docs/identity-now/saas-connectivity/img/select.png b/docs/connectivity/saas-connectivity/img/select.png similarity index 100% rename from products/idn/docs/identity-now/saas-connectivity/img/select.png rename to docs/connectivity/saas-connectivity/img/select.png diff --git a/products/idn/docs/identity-now/saas-connectivity/in-depth/api-calls.md b/docs/connectivity/saas-connectivity/in-depth/api-calls.md similarity index 98% rename from products/idn/docs/identity-now/saas-connectivity/in-depth/api-calls.md rename to docs/connectivity/saas-connectivity/in-depth/api-calls.md index 6815faec8..e446b156a 100644 --- a/products/idn/docs/identity-now/saas-connectivity/in-depth/api-calls.md +++ b/docs/connectivity/saas-connectivity/in-depth/api-calls.md @@ -7,7 +7,7 @@ sidebar_position: 1 sidebar_class_name: apiCalls keywords: ['connectivity', 'connectors', 'api calls'] description: Calling API endpoints sequentially for hundreds or thousands of accounts is slow. If several API calls are required to build a user’s account, then it is recommended that you use asynchronous functions to speed up this task. -slug: /docs/saas-connectivity/in-depth/api-calls +slug: /connectivity/saas-connectivity/in-depth/api-calls tags: ['Connectivity'] --- diff --git a/docs/connectivity/saas-connectivity/in-depth/cli-advanced.md b/docs/connectivity/saas-connectivity/in-depth/cli-advanced.md new file mode 100644 index 000000000..b0fd37514 --- /dev/null +++ b/docs/connectivity/saas-connectivity/in-depth/cli-advanced.md @@ -0,0 +1,90 @@ +--- +id: cli-advanced +title: CLI - Advanced +pagination_label: CLI - Advanced +sidebar_label: CLI - Advanced +sidebar_position: 1 +sidebar_class_name: cliAdvanced +keywords: ['connectivity', 'connectors', 'cli'] +description: Using the CLI to properly test and debug your connector in Identity Security Cloud +slug: /connectivity/saas-connectivity/in-depth/cli-advanced +tags: ['Connectivity'] +--- + +You can use the CLI to invoke a number of calls in Identity Security Cloud, including calls that aren't specifically defined by the CLI. This section includes examples that show how you can invoke those calls: + +## Use provided CLI invoke calls + +To find commands supported by the CLI, you can use the `sail conn invoke -h` command: + +```bash +Available Commands: + account-create Invoke a std:account:create command + account-delete Invoke a std:account:delete command + account-discover-schema Invoke a std:account:discover-schema command + account-list Invoke a std:account:list command + account-read Invoke a std:account:read command + account-update Invoke a std:account:update command + change-password Invoke a change-password command + entitlement-list Invoke a std:entitlement:list command + entitlement-read Invoke a std:entitlement:read command + raw Invoke a raw command + source-data-discover Invoke a std:source-data:discover command + source-data-read Invoke a std:source-data:read command + test-connection Invoke a std:test-connection command +``` +To understand the required parameters to invoke a command from the CLI, you can use the help command to get a list of required parameters. For example, to read an account using the CLI, first call `sail conn invoke account-read -h`. The CLI will respond with the required input: + +```bash +Usage: + sail connectors invoke account-read [id/lookupId] [uniqueId] [flags] + +Flags: + -h, --help help for account-read + --schema string Optional - Custom account schema + +Global Flags: + --config-json string Config JSON to use for commands + -p, --config-path string Path to config to use for commands + -e, --conn-endpoint string Override connectors endpoint (default "/beta/platform-connectors") + --debug Enable debug logging + --env string Environment to use for SailPoint CLI commands + -c, --id string Connector ID or Alias + -v, --version string Optional. Run against a specific version if provided. Otherwise run against the latest tag. +``` +In this case, you need to provide the connector ID, the config path that contains the necessary configuration for the connector, and the ID for the account. + +The config file will look something like this: + +```json +{ + "apiKey": "", + "airtableBase": "" +} +``` + +The command to invoke account-read will look like this: + +```bash +sail conn invoke account-read philip.ellis -c 4b12cf79-b2ac-44ac-842b-b5a6268548f5 -p config.json +``` + +## Use sail conn invoke raw + +Even if a command isn't supported by the CLI, you can still invoke it. The `invoke raw` command allows you to specify the entire JSON object used to invoke the command. + +You can use the Postman collection as a way to build the JSON object needed to invoke the command. For example, if you want to run the `account-disable` command, you can create a JSON object with the required fields. If you look at this example, you will see that it closely resembles the same information that is sent when debugging the command using Postman: + +``` +{ + "type": "std:account:disable", + "input": { + "key": {"simple": { "id": "philip.ellis"}} + } +} +``` +Running the `raw` command is similar to running the other commands, except now you pass the JSON file created earlier with the `-f` flag: + +``` +sail conn invoke raw -c 4b12cf79-b2ac-44ac-842b-b5a6268548f5 -f account-disable.json -p config.json +``` diff --git a/products/idn/docs/identity-now/saas-connectivity/in-depth/connector-timeouts.md b/docs/connectivity/saas-connectivity/in-depth/connector-timeouts.md similarity index 58% rename from products/idn/docs/identity-now/saas-connectivity/in-depth/connector-timeouts.md rename to docs/connectivity/saas-connectivity/in-depth/connector-timeouts.md index a99d995e6..61e5c81e1 100644 --- a/products/idn/docs/identity-now/saas-connectivity/in-depth/connector-timeouts.md +++ b/docs/connectivity/saas-connectivity/in-depth/connector-timeouts.md @@ -6,14 +6,14 @@ sidebar_label: Connector Timeouts sidebar_position: 1.2 sidebar_class_name: connectorTimeouts keywords: ['connectivity', 'connectors', 'timeout'] -description: IdentityNow will throw an error if your connector does not send a response in 3 minutes. For connector commands that might take longer than 3 minutes, make sure to send data at regular intervals to prevent a timeout. -slug: /docs/saas-connectivity/in-depth/connector-timeouts +description: Identity Security Cloud will throw an error if your connector does not send a response in 3 minutes. For connector commands that might take longer than 3 minutes, make sure to send data at regular intervals to prevent a timeout. +slug: /connectivity/saas-connectivity/in-depth/connector-timeouts tags: ['Connectivity'] --- -An IdentityNow SaaS Connectivity connector will send a timeout error if it doesn't send a response within 3 minutes. If the connector is sending thousands of records, the record fetching process will likely exceed this timeout limit. If you are storing all those records in memory before sending them to IDN, you can run into memory utilization issues. To prevent these issues, you should paginate through your source data and send the data back in regular intervals. +An Identity Security Cloud SaaS Connectivity connector will send a timeout error if it doesn't send a response within 3 minutes. If the connector is sending thousands of records, the record fetching process will likely exceed this timeout limit. If you are storing all those records in memory before sending them to ISC, you can run into memory utilization issues. To prevent these issues, you should paginate through your source data and send the data back in regular intervals. -In the case of a long running API call to the source system, you can also optionally send `res.keepAlive()` to keep the connection to IdentityNow open without having to send any data to IdentityNow. If `res.keepAlive()` or `res.send()` is not called within 3 minutes, a connector timeout will occur. +In the case of a long running API call to the source system, you can also optionally send `res.keepAlive()` to keep the connection to Identity Security Cloud open without having to send any data to Identity Security Cloud. If `res.keepAlive()` or `res.send()` is not called within 3 minutes, a connector timeout will occur. This is an example of how to set up this pagination: @@ -25,8 +25,8 @@ async getAccounts(res: Response): Promise { // each page will be called recursively until there are no more records to fetch, at which case the promise is fulfilled ).eachPage((records, fetchNextPage) => { for (let record of records) { - // this is the part that sends the data to IdentityNow. Since eachPage is called with just 10 records, - // if there are 100 records total, we would send data back to IDN in 10 sets of 10 records. + // this is the part that sends the data to Identity Security Cloud. Since eachPage is called with just 10 records, + // if there are 100 records total, we would send data back to ISC in 10 sets of 10 records. res.send({ identity: record.id, attributes: { diff --git a/products/idn/docs/identity-now/saas-connectivity/in-depth/debugging.md b/docs/connectivity/saas-connectivity/in-depth/debugging.md similarity index 93% rename from products/idn/docs/identity-now/saas-connectivity/in-depth/debugging.md rename to docs/connectivity/saas-connectivity/in-depth/debugging.md index 730254f9c..e99c27e7a 100644 --- a/products/idn/docs/identity-now/saas-connectivity/in-depth/debugging.md +++ b/docs/connectivity/saas-connectivity/in-depth/debugging.md @@ -7,7 +7,7 @@ sidebar_position: 2 sidebar_class_name: debugging keywords: ['connectivity', 'connectors', 'debugging'] description: An easy way to debug locally is to use console.log() to print debug information to your console. -slug: /docs/saas-connectivity/in-depth/debugging +slug: /connectivity/saas-connectivity/in-depth/debugging tags: ['Connectivity'] --- @@ -39,7 +39,7 @@ export const connector = async () => { }; ``` -`console.log()` statements work anywhere, and they work when you deploy your connector to IDN. However, these statements can create clutter in your code. You will often have to clean up debug statements once you are done. +`console.log()` statements work anywhere, and they work when you deploy your connector to ISC. However, these statements can create clutter in your code. You will often have to clean up debug statements once you are done. If your IDE supports debugging JavaScript, then your IDE’s built-in debugger can be a powerful and easy way to debug your code. @@ -87,6 +87,6 @@ With these configurations set, you can run the debugger by selecting the options ![debugging 2](./img/debugging2.png) -## Debug in IdentityNow +## Debug in Identity Security Cloud -You can use the `sail conn logs` command to gain insight into how your connector is performing while running in IDN. See the section on logging for more information. +You can use the `sail conn logs` command to gain insight into how your connector is performing while running in ISC. See the section on logging for more information. diff --git a/products/idn/docs/identity-now/saas-connectivity/in-depth/error-handling.md b/docs/connectivity/saas-connectivity/in-depth/error-handling.md similarity index 93% rename from products/idn/docs/identity-now/saas-connectivity/in-depth/error-handling.md rename to docs/connectivity/saas-connectivity/in-depth/error-handling.md index fb018285e..862454d8a 100644 --- a/products/idn/docs/identity-now/saas-connectivity/in-depth/error-handling.md +++ b/docs/connectivity/saas-connectivity/in-depth/error-handling.md @@ -7,7 +7,7 @@ sidebar_position: 3 sidebar_class_name: errorHandling keywords: ['connectivity', 'connectors', 'error handling'] description: If the code fails due to validation issues, connectivity, or configuration errors, you can handle the error and provide the user with information about what went wrong. -slug: /docs/saas-connectivity/in-depth/error-handling +slug: /connectivity/saas-connectivity/in-depth/error-handling tags: ['Connectivity'] --- @@ -45,7 +45,7 @@ export class AirtableClient { ## Not Found Error Type -The connector SDK offers a special error type of "Not Found". This error signals to IDN that the specific account is not in the source system. If the account should be in the source system, IDN will then call the connector ```std:account:create``` command to create the account. +The connector SDK offers a special error type of "Not Found". This error signals to ISC that the specific account is not in the source system. If the account should be in the source system, ISC will then call the connector ```std:account:create``` command to create the account. Here is an example: @@ -54,7 +54,7 @@ Here is an example: const account = await myClient.getAccount(input.identity) if (!account) { // account was not found, but identity now has the account and expects it to be there! - // Send an error message to IdentityNow so the account is automatically created + // Send an error message to Identity Security Cloud so the account is automatically created if (!account) { throw new ConnectorError("account is not found", ConnectorErrorType.NotFound) } diff --git a/products/idn/docs/identity-now/saas-connectivity/in-depth/img/debugging1.png b/docs/connectivity/saas-connectivity/in-depth/img/debugging1.png similarity index 100% rename from products/idn/docs/identity-now/saas-connectivity/in-depth/img/debugging1.png rename to docs/connectivity/saas-connectivity/in-depth/img/debugging1.png diff --git a/products/idn/docs/identity-now/saas-connectivity/in-depth/img/debugging2.png b/docs/connectivity/saas-connectivity/in-depth/img/debugging2.png similarity index 100% rename from products/idn/docs/identity-now/saas-connectivity/in-depth/img/debugging2.png rename to docs/connectivity/saas-connectivity/in-depth/img/debugging2.png diff --git a/products/idn/docs/identity-now/saas-connectivity/in-depth/img/testing1.png b/docs/connectivity/saas-connectivity/in-depth/img/testing1.png similarity index 100% rename from products/idn/docs/identity-now/saas-connectivity/in-depth/img/testing1.png rename to docs/connectivity/saas-connectivity/in-depth/img/testing1.png diff --git a/products/idn/docs/identity-now/saas-connectivity/in-depth/img/testing2.png b/docs/connectivity/saas-connectivity/in-depth/img/testing2.png similarity index 100% rename from products/idn/docs/identity-now/saas-connectivity/in-depth/img/testing2.png rename to docs/connectivity/saas-connectivity/in-depth/img/testing2.png diff --git a/products/idn/docs/identity-now/saas-connectivity/in-depth/linting.md b/docs/connectivity/saas-connectivity/in-depth/linting.md similarity index 93% rename from products/idn/docs/identity-now/saas-connectivity/in-depth/linting.md rename to docs/connectivity/saas-connectivity/in-depth/linting.md index ecf491755..77777240c 100644 --- a/products/idn/docs/identity-now/saas-connectivity/in-depth/linting.md +++ b/docs/connectivity/saas-connectivity/in-depth/linting.md @@ -7,7 +7,7 @@ sidebar_position: 4 sidebar_class_name: linting keywords: ['connectivity', 'connectors', 'linting'] description: Automatically check your connector source code for programmatic and stylistic errors. -slug: /docs/saas-connectivity/in-depth/linting +slug: /connectivity/saas-connectivity/in-depth/linting tags: ['Connectivity'] --- diff --git a/products/idn/docs/identity-now/saas-connectivity/in-depth/logging.md b/docs/connectivity/saas-connectivity/in-depth/logging.md similarity index 98% rename from products/idn/docs/identity-now/saas-connectivity/in-depth/logging.md rename to docs/connectivity/saas-connectivity/in-depth/logging.md index 1f4c1477e..4e2cdd0e6 100644 --- a/products/idn/docs/identity-now/saas-connectivity/in-depth/logging.md +++ b/docs/connectivity/saas-connectivity/in-depth/logging.md @@ -7,13 +7,13 @@ sidebar_position: 5 sidebar_class_name: logging keywords: ['connectivity', 'connectors', 'logging'] description: You can use this feature to read the logs of your connectors. -slug: /docs/saas-connectivity/in-depth/logging +slug: /connectivity/saas-connectivity/in-depth/logging tags: ['Connectivity'] --- ## Printing Logs with the CLI -Fetch logs from IDN by issuing the `sail conn logs` command: +Fetch logs from ISC by issuing the `sail conn logs` command: ```bash $ sail conn logs diff --git a/products/idn/docs/identity-now/saas-connectivity/in-depth/rate-limits.md b/docs/connectivity/saas-connectivity/in-depth/rate-limits.md similarity index 98% rename from products/idn/docs/identity-now/saas-connectivity/in-depth/rate-limits.md rename to docs/connectivity/saas-connectivity/in-depth/rate-limits.md index 65e5114e8..49b813331 100644 --- a/products/idn/docs/identity-now/saas-connectivity/in-depth/rate-limits.md +++ b/docs/connectivity/saas-connectivity/in-depth/rate-limits.md @@ -7,7 +7,7 @@ sidebar_position: 6 sidebar_class_name: handlingRateLimits keywords: ['connectivity', 'connectors', 'rate limits'] description: Rate limiting for SaaS Connectivity. -slug: /docs/saas-connectivity/in-depth/handling-rate-limits +slug: /connectivity/saas-connectivity/in-depth/handling-rate-limits tags: ['Connectivity'] --- diff --git a/products/idn/docs/identity-now/saas-connectivity/in-depth/testing.md b/docs/connectivity/saas-connectivity/in-depth/testing.md similarity index 99% rename from products/idn/docs/identity-now/saas-connectivity/in-depth/testing.md rename to docs/connectivity/saas-connectivity/in-depth/testing.md index 93c501bed..56b579b86 100644 --- a/products/idn/docs/identity-now/saas-connectivity/in-depth/testing.md +++ b/docs/connectivity/saas-connectivity/in-depth/testing.md @@ -7,7 +7,7 @@ sidebar_position: 7 sidebar_class_name: testing keywords: ['connectivity', 'connectors', 'testing'] description: Testing SaaS Connectivity. -slug: /docs/saas-connectivity/in-depth/testing +slug: /connectivity/saas-connectivity/in-depth/testing tags: ['Connectivity'] --- diff --git a/products/idn/docs/identity-now/saas-connectivity/index.md b/docs/connectivity/saas-connectivity/index.md similarity index 80% rename from products/idn/docs/identity-now/saas-connectivity/index.md rename to docs/connectivity/saas-connectivity/index.md index b74fda1bd..790ad4d8d 100644 --- a/products/idn/docs/identity-now/saas-connectivity/index.md +++ b/docs/connectivity/saas-connectivity/index.md @@ -6,8 +6,8 @@ sidebar_label: SaaS Connectivity sidebar_position: 4 sidebar_class_name: saasConnectivity keywords: ['connectivity', 'connectors'] -description: SaaS Connectivity is a cloud based connector runtime that makes developing and deploying web service connectors easy. -slug: /docs/saas-connectivity +description: Cloud-based connectivity without VAs. +slug: /connectivity/saas-connectivity tags: ['Connectivity'] --- @@ -15,12 +15,12 @@ SaaS Connectivity is a cloud based connector runtime that makes developing and d ## What Are Connectors -Connectors are the bridges between the SailPoint Identity Now (IDN) SaaS platform and the source systems that IDN needs to communicate with and aggregate data from. An example of a source system IDN may need to communicate with would be an Oracle HR system or GitHub. In these cases, IDN synchronizes data between systems to ensure account entitlements and state are correct through the organization. +Connectors are the bridges between the SailPoint Identity Security Cloud (ISC) SaaS platform and the source systems that ISC needs to communicate with and aggregate data from. An example of a source system ISC may need to communicate with would be an Oracle HR system or GitHub. In these cases, ISC synchronizes data between systems to ensure account entitlements and state are correct through the organization. ## Why We Are Introducing SaaS Connectivity The primary driver for indroducing the SaaS Connectivity framework is to allow a way to connect to other cloud based sources in a truly SaaS architecture, without the need to rely on a VA. There are also other benefits that come with the SaaS Connectivity framework: - - Ability to develop, debug and test custom connectors locally without any dependencies on IdentityNow + - Ability to develop, debug and test custom connectors locally without any dependencies on Identity Security Cloud - Features to customize the user interface when configuring the connector that are specific to the source - Support for more modern languages and frameworks @@ -30,7 +30,7 @@ VA connectors always communicate with external sources through the Virtual Appli ![Old Connectivity](./img/old_connectivity_diagram.png) -The new Cloud connectors work differently - they run on the IDN platform instead: +The new Cloud connectors work differently - they run on the ISC platform instead: ![New Connectivity](./img/new_connectivity_diagram.png) diff --git a/products/idn/docs/identity-now/saas-connectivity/limits.md b/docs/connectivity/saas-connectivity/limits.md similarity index 84% rename from products/idn/docs/identity-now/saas-connectivity/limits.md rename to docs/connectivity/saas-connectivity/limits.md index a71a5fcd1..9ee82d3c6 100644 --- a/products/idn/docs/identity-now/saas-connectivity/limits.md +++ b/docs/connectivity/saas-connectivity/limits.md @@ -7,7 +7,7 @@ sidebar_position: 6.8 sidebar_class_name: limits keywords: ['connectivity', 'connectors', 'commands', 'cli'] description: This describes certain limits that are in place when running a SaaS Connector -slug: /docs/saas-connectivity/limits +slug: /connectivity/saas-connectivity/limits tags: ['Connectivity'] --- @@ -15,7 +15,7 @@ Below is a list of limits set in SaaS Connectivity: - **Max Run Time** - The actual run time of a connector is not limited at this time, however a response in the form of `res.send()` must be recieved from a command at least every 3 minutes - - If you have a long running call, you can use `res.keepAlive()` to send a heartbeat to IdentityNow in between `res.send()` calls to let it know the connector is still running + - If you have a long running call, you can use `res.keepAlive()` to send a heartbeat to Identity Security Cloud in between `res.send()` calls to let it know the connector is still running - **Response Size** - The maximum size of a single `res.send()` call is 256 KiB. Not that some metadata is sent along with the call, so the max size of the payload sent will be slightly less than 256 KiB - **Memory Limits** diff --git a/products/idn/docs/identity-now/saas-connectivity/postman-collection.md b/docs/connectivity/saas-connectivity/postman-collection.md similarity index 93% rename from products/idn/docs/identity-now/saas-connectivity/postman-collection.md rename to docs/connectivity/saas-connectivity/postman-collection.md index 421516fdb..601602fa5 100644 --- a/products/idn/docs/identity-now/saas-connectivity/postman-collection.md +++ b/docs/connectivity/saas-connectivity/postman-collection.md @@ -7,7 +7,7 @@ sidebar_position: 6 sidebar_class_name: postmanCollection keywords: ['connectivity', 'connectors', 'postman'] description: Use the following Postman Collection file to run tests for each of the commands locally. -slug: /docs/saas-connectivity/postman-collection +slug: /connectivity/saas-connectivity/postman-collection tags: ['Connectivity', 'Postman'] --- diff --git a/products/idn/docs/identity-now/saas-connectivity/prerequisites.md b/docs/connectivity/saas-connectivity/prerequisites.md similarity index 84% rename from products/idn/docs/identity-now/saas-connectivity/prerequisites.md rename to docs/connectivity/saas-connectivity/prerequisites.md index 09251dd13..d9388dae0 100644 --- a/products/idn/docs/identity-now/saas-connectivity/prerequisites.md +++ b/docs/connectivity/saas-connectivity/prerequisites.md @@ -7,7 +7,7 @@ sidebar_position: 1 sidebar_class_name: prerequisites keywords: ['connectivity', 'connectors', 'prerequisites'] description: These are some prerequisites you must have before you start building SaaS Connectors. -slug: /docs/saas-connectivity/prerequisites +slug: /connectivity/saas-connectivity/prerequisites tags: ['Connectivity'] --- @@ -19,7 +19,7 @@ To develop a connector, Node >= 18.0.0 is required. Download node from the [node ### SailPoint CLI -SailPoint provides a CLI tool to manage the connectors' lifecycles. To install and set up the CLI, [follow the instructions here](../../../idn/tools/cli) or you can directly download and install from the [GitHub releases page](https://github.com/sailpoint-oss/sailpoint-cli/releases) +SailPoint provides a CLI tool to manage the connectors' lifecycles. To install and set up the CLI, [follow the instructions here](../../tools/cli) or you can directly download and install from the [GitHub releases page](https://github.com/sailpoint-oss/sailpoint-cli/releases) ## Recommended Software @@ -29,7 +29,7 @@ Although you can develop connectors in a text editor, use an Integrated Developm ### Postman -A convenient way to test your connector before deploying to IDN is to use Postman. You can get it from the [postman.com downloads page](https://www.postman.com/downloads/) +A convenient way to test your connector before deploying to ISC is to use Postman. You can get it from the [postman.com downloads page](https://www.postman.com/downloads/) ## Creating your first project @@ -61,15 +61,15 @@ my-first-project This directory contains three main files: -- **index.ts:** Use this file to register all the available commands the connector supports, provide the necessary configuration options to the client code implementing the API for the source, and pass data the client code obtains to IdentityNow. This file can either use a vendor supplied client Software Development Kit (SDK) to interact with the web service or reference custom client code within the project. +- **index.ts:** Use this file to register all the available commands the connector supports, provide the necessary configuration options to the client code implementing the API for the source, and pass data the client code obtains to Identity Security Cloud. This file can either use a vendor supplied client Software Development Kit (SDK) to interact with the web service or reference custom client code within the project. - **my-client.ts:** Use this template to create custom client code to interact with a web service’s APIs. If the web service does not provide an SDK, you can modify this file to implement the necessary API calls to interact with the source web service. -- **connector-spec.ts** This file describes how the connector works to IDN. More information about the connector spec is available in the next section. At a high level, it has the information for the following: +- **connector-spec.ts** This file describes how the connector works to ISC. More information about the connector spec is available in the next section. At a high level, it has the information for the following: - What commands the connector supports - What config values the user must provide when creating the connector - Defining the account schema - Defining the entitlment schema - - Defining the account create template that maps fields from IDN to the connector + - Defining the account create template that maps fields from ISC to the connector These files are templates that provide guidance to begin implementing the connector on the target web service. Although you can implement a connector's entire functionality within these three files (or even just one if the web service provides an SDK), you can implement your own code architecture, like breaking out common utility functions into a separate file or creating separate files for each operation. diff --git a/products/idn/docs/identity-now/saas-connectivity/test-build-deploy.md b/docs/connectivity/saas-connectivity/test-build-deploy.md similarity index 84% rename from products/idn/docs/identity-now/saas-connectivity/test-build-deploy.md rename to docs/connectivity/saas-connectivity/test-build-deploy.md index 97637f4aa..339b996fb 100644 --- a/products/idn/docs/identity-now/saas-connectivity/test-build-deploy.md +++ b/docs/connectivity/saas-connectivity/test-build-deploy.md @@ -7,7 +7,7 @@ sidebar_position: 2 sidebar_class_name: testBuildDeploy keywords: ['connectivity', 'connectors', 'test', 'build', 'deploy'] description: As you implement command handlers, you must test them. The connector SDK provides some utility methods to locally run your connector to test, build, and deploy. -slug: /docs/saas-connectivity/test-build-deploy +slug: /connectivity/saas-connectivity/test-build-deploy tags: ['Connectivity'] --- @@ -37,17 +37,17 @@ As you implement command handlers, you must test them. The connector SDK provide ## Create and Upload Connector Bundle -Follow these steps to use the CLI to package a connector bundle, create it in your IdentityNow org, and upload it to IdentityNow. +Follow these steps to use the CLI to package a connector bundle, create it in your Identity Security Cloud org, and upload it to Identity Security Cloud. ### Package Connector Files -You must compress the files in the connector project into a zip file before uploading them to IdentityNow. +You must compress the files in the connector project into a zip file before uploading them to Identity Security Cloud. Use the CLI to run `npm run pack-zip` to build and package the connector bundle. Put the resulting zip file in the `dist` folder. ### Create Connector In Your Org -Before uploading the zip file, you must create an entry for the connector in your IdentityNow org. Run `sail conn create "my-project"` to create a connector entry. +Before uploading the zip file, you must create an entry for the connector in your Identity Security Cloud org. Run `sail conn create "my-project"` to create a connector entry. The response to this command contains a connector ID you can use to manage this connector. @@ -76,9 +76,9 @@ $ sail conn list +--------------------------------------+----------------------------+ ``` -### Upload Connector Zip File to IdentityNow +### Upload Connector Zip File to Identity Security Cloud -Run `sail conn upload -c [connectorID | connectorAlias] -f dist/[connector filename].zip` to upload the zip file built from the previous step to IdentityNow. +Run `sail conn upload -c [connectorID | connectorAlias] -f dist/[connector filename].zip` to upload the zip file built from the previous step to Identity Security Cloud. ```bash $ sail conn upload -c example-connector -f dist/example-connector-0.1.0.zip @@ -103,15 +103,15 @@ $ sail conn tags list -c example-connector :::caution Important Make sure that you implement a form of version control or regular backup process for your connectors. -You cannot recover the source code from IDN because it gets sent to IDN as a compiled and minified JavaScript (JS) bundle that cannot be easily expanded into its original source code structure. +You cannot recover the source code from ISC because it gets sent to ISC as a compiled and minified JavaScript (JS) bundle that cannot be easily expanded into its original source code structure. ::: -## Test Your Connector in IdentityNow +## Test Your Connector in Identity Security Cloud -Follow these steps to test a connector bundle in both IdentityNow and the IdentityNow user interface (UI). +Follow these steps to test a connector bundle in both Identity Security Cloud and the Identity Security Cloud user interface (UI). -### Test Your Connector Bundle In IdentityNow +### Test Your Connector Bundle In Identity Security Cloud The connector CLI provides ways to test invoking commands with any connector upload version. Before running a command, create a file, **config.json**, in the root project folder. Include any configuration items required to interact with the target web service in this file, such as API token, username, password, organization, version, etc. The following snippet is an example: @@ -141,8 +141,8 @@ $ sail connectors invoke account-list -c example-connector -p config.json > > Ensure that you add config.json to your .gitignore file so you do not accidentally store secrets in your code repository. -## Test Your Connector from IdentityNow UI +## Test Your Connector from Identity Security Cloud UI -Go to your IdentityNow org’s source section. Create a source from the connector you just uploaded. This connector will display in the dropdown list: **example-connector (tag: latest)** +Go to your Identity Security Cloud org’s source section. Create a source from the connector you just uploaded. This connector will display in the dropdown list: **example-connector (tag: latest)** -After creating a source, you can to test connection, aggregate account, etc. from the IdentityNow UI. +After creating a source, you can to test connection, aggregate account, etc. from the Identity Security Cloud UI. diff --git a/products/idn/docs/identity-now/saas-connectivity/videos.md b/docs/connectivity/saas-connectivity/videos.md similarity index 94% rename from products/idn/docs/identity-now/saas-connectivity/videos.md rename to docs/connectivity/saas-connectivity/videos.md index a7bfa0524..4c8adb4a0 100644 --- a/products/idn/docs/identity-now/saas-connectivity/videos.md +++ b/docs/connectivity/saas-connectivity/videos.md @@ -7,7 +7,7 @@ sidebar_position: 1.5 sidebar_class_name: videos keywords: ['connectivity', 'connectors', 'videos'] description: Helpful videos on using SaaS connectivity -slug: /docs/saas-connectivity/videos +slug: /connectivity/saas-connectivity/videos tags: ['Connectivity'] --- import Video from '@site/src/components/Video'; diff --git a/docs/extensibility.md b/docs/extensibility.md new file mode 100644 index 000000000..e25b29e06 --- /dev/null +++ b/docs/extensibility.md @@ -0,0 +1,27 @@ +--- +id: extensibility +title: Extensibility +pagination_label: Extensibility +sidebar_label: Extensibility +sidebar_position: 1 +sidebar_class_name: extensibility +keywords: ['extensibility'] +description: Extend your ISC platform. +slug: /extensibility +tags: ['extensibility'] +--- + +## Overview +The Identity Security Cloud (ISC) platform is designed for extensibility, which means that it's designed to allow the addition of new capabilities or functionalities. In addition to the APIs, SailPoint provides a number of extensibility options you can use to build custom solutions and integrations that meet your organization's needs. + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + +## Discuss +The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions. + +To learn more about ISC extensibility and discuss the different extensibility options with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/isc/6). \ No newline at end of file diff --git a/products/idn/docs/identity-now/_category_.json b/docs/extensibility/_category_.json similarity index 100% rename from products/idn/docs/identity-now/_category_.json rename to docs/extensibility/_category_.json diff --git a/docs/extensibility/configuration-management/_category_.json b/docs/extensibility/configuration-management/_category_.json new file mode 100644 index 000000000..e8ff3fd29 --- /dev/null +++ b/docs/extensibility/configuration-management/_category_.json @@ -0,0 +1,5 @@ +{ + "customProps": { + "description": "Export and import tenant configurations." + } +} \ No newline at end of file diff --git a/docs/extensibility/configuration-management/index.mdx b/docs/extensibility/configuration-management/index.mdx new file mode 100644 index 000000000..9d7a47ff5 --- /dev/null +++ b/docs/extensibility/configuration-management/index.mdx @@ -0,0 +1,36 @@ +--- +id: configuration-management +title: Configuration Management +pagination_label: Configuration Management +sidebar_label: Configuration Management +sidebar_position: 6 +sidebar_class_name: Configuration Management +hide_title: true +keywords: + [ + 'portal', + 'docs', + 'documentation', + ] +description: Export and import tenant configurations. +slug: /extensibility/configuration-management +tags: ['Introduction', 'Getting Started'] +--- + +## Overview +Configuration Management provides you with a form of version control for your tenant configurations. +With Configuration Management, you can export snapshots of your current tenant configurations, downloading them in a JSON. +These configurations can serve as different versions of your tenant configuration. +You can then import those configurations into tenants to update, resore, or migrate tenant configurations. + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + +## Discuss +The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions. + +To learn more about ISC configuration management and discuss it with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/isc/6). diff --git a/products/idn/docs/identity-now/saas-configuration.mdx b/docs/extensibility/configuration-management/saas-configuration.mdx similarity index 94% rename from products/idn/docs/identity-now/saas-configuration.mdx rename to docs/extensibility/configuration-management/saas-configuration.mdx index f6cd0ee92..95a939216 100644 --- a/products/idn/docs/identity-now/saas-configuration.mdx +++ b/docs/extensibility/configuration-management/saas-configuration.mdx @@ -6,7 +6,7 @@ sidebar_position: 3 sidebar_class_name: saasConfiguration keywords: ['configuration'] description: Use SaaS Configuration APIs to import and export configurations. -slug: /docs/saas-configuration +slug: /extensibility/configuration-management/saas-configuration tags: ['SaaS Configuration'] --- @@ -67,7 +67,7 @@ The available supported objects are also available via REST API! See List Config ### Process -![img](./img/sp-config-export.png) +![img](../img/sp-config-export.png) 1. **Start Export** - Start the export process by configuring a JSON payload for the export options. This payload will be sent to `POST /beta/sp-config/export`. 2. **Response with Export Status** - An export status will be given in response. This contains a `jobId` and a `status` to be used to subsequently monitor the process. Initially, this may have a status of `NOT_STARTED`. @@ -85,7 +85,7 @@ The available supported objects are also available via REST API! See List Config ### Process -![img](./img/sp-config-import.png) +![img](../img/sp-config-import.png) 1. **Start Import** - Start the import process by configuring a JSON payload for the import options. This will then be sent to `POST /beta/sp-config/import`. 2. **Response with Import Status** - An import status will be given in response. This contains a `jobId` and a `status` to be used to subsequently monitor the process. Initially this might have a status of `NOT_STARTED`. @@ -111,7 +111,7 @@ The available supported objects are also available via REST API! See List Config **Description** -[This endpoint](https://developer.sailpoint.com/idn/api/beta/list-sp-config-objects) gets the list of object configurations known to the tenant export/import service. +[This endpoint](https://developer.sailpoint.com/docs/api/beta/list-sp-config-objects) gets the list of object configurations known to the tenant export/import service. Object configurations containing "importUrl" and "exportUrl" are available for export/import. @@ -216,7 +216,7 @@ Content-Type: application/json **Description** -[This endpoint](https://developer.sailpoint.com/idn/api/beta/export-sp-config) exports selected objects from the tenant to a JSON configuration file. +[This endpoint](https://developer.sailpoint.com/docs/api/beta/export-sp-config) exports selected objects from the tenant to a JSON configuration file. @@ -298,7 +298,7 @@ You can only use the `includedIds` and `includedNames` filters when you're expor **Description** -[This endpoint](https://developer.sailpoint.com/idn/api/beta/export-sp-config-job-status) gets the status of the export job identified by its `id` parameter. +[This endpoint](https://developer.sailpoint.com/docs/api/beta/export-sp-config-job-status) gets the status of the export job identified by its `id` parameter. This request requires one of the following security scopes: @@ -339,7 +339,7 @@ Content-Type: application/json **Description** -[This endpoint](https://developer.sailpoint.com/idn/api/beta/export-sp-config-download) gets the export job's resulting export file by using the requested `id` and downloads it to a file. +[This endpoint](https://developer.sailpoint.com/docs/api/beta/export-sp-config-download) gets the export job's resulting export file by using the requested `id` and downloads it to a file. This request requires one of the following security scopes: @@ -503,7 +503,7 @@ Content-Type: application/json **Description** -[This endpoint](https://developer.sailpoint.com/idn/api/beta/import-sp-config) imports objects from a JSON configuration file into a tenant. +[This endpoint](https://developer.sailpoint.com/docs/api/beta/import-sp-config) imports objects from a JSON configuration file into a tenant. By default, every import job first exports all existing objects supported by sp-config as a backup before attempting the import. The import job provides a backup so the configuration's import status is available for inspection or restore if needed. You can skip the backup by setting `excludeBackup` to `true` in the import options. @@ -559,7 +559,7 @@ Example: POST /beta/sp-config/import?preview=true **Description** -[This endpoint](https://developer.sailpoint.com/idn/api/beta/import-sp-config-job-status) gets the status of the import job identified by its `id` parameter. +[This endpoint](https://developer.sailpoint.com/docs/api/beta/import-sp-config-job-status) gets the status of the import job identified by its `id` parameter. This request requires the following security scope: @@ -600,7 +600,7 @@ Content-Type: application/json **Description** -[This endpoint](https://developer.sailpoint.com/idn/api/beta/import-sp-config-download) gets the import job's resulting import file by using the requested `id` and downloads the file. +[This endpoint](https://developer.sailpoint.com/docs/api/beta/import-sp-config-download) gets the import job's resulting import file by using the requested `id` and downloads the file. The downloaded file will contain the import job's results, including any associated error, warning or informational messages. This request requires the following security scope: diff --git a/docs/extensibility/event-triggers/_category_.json b/docs/extensibility/event-triggers/_category_.json new file mode 100644 index 000000000..9b49f47c2 --- /dev/null +++ b/docs/extensibility/event-triggers/_category_.json @@ -0,0 +1,5 @@ +{ + "customProps": { + "description": "Actions triggered by specific events." + } +} \ No newline at end of file diff --git a/products/idn/docs/identity-now/event-triggers/available/access-request-decision.md b/docs/extensibility/event-triggers/available/access-request-decision.md similarity index 88% rename from products/idn/docs/identity-now/event-triggers/available/access-request-decision.md rename to docs/extensibility/event-triggers/available/access-request-decision.md index e4c1ed2e7..f098dc7e7 100644 --- a/products/idn/docs/identity-now/event-triggers/available/access-request-decision.md +++ b/docs/extensibility/event-triggers/available/access-request-decision.md @@ -17,13 +17,13 @@ keywords: 'available', ] description: Fires after an access request is approved. -slug: /docs/event-triggers/triggers/access-request-decision +slug: /extensibility/event-triggers/triggers/access-request-decision tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget'] --- ## Event Context -The SailPoint IdentityNow platform now includes event triggers within the access request approval workflow. The 'Access Request Decision' event trigger provides more proactive governance and ensures users can quickly obtain needed access. +The SailPoint Identity Security Cloud platform now includes event triggers within the access request approval workflow. The 'Access Request Decision' event trigger provides more proactive governance and ensures users can quickly obtain needed access. ![Flow](./img/access-request-postapproval-path.png) diff --git a/products/idn/docs/identity-now/event-triggers/available/access-request-dynamic-approval.md b/docs/extensibility/event-triggers/available/access-request-dynamic-approval.md similarity index 91% rename from products/idn/docs/identity-now/event-triggers/available/access-request-dynamic-approval.md rename to docs/extensibility/event-triggers/available/access-request-dynamic-approval.md index a1b771403..ddeebc5ab 100644 --- a/products/idn/docs/identity-now/event-triggers/available/access-request-dynamic-approval.md +++ b/docs/extensibility/event-triggers/available/access-request-dynamic-approval.md @@ -7,7 +7,7 @@ sidebar_class_name: accessRequestDynamicApproval keywords: ['event', 'trigger', 'access', 'request', 'dynamic', 'approval', 'available'] description: Fires after an access request is submitted. -slug: /docs/event-triggers/triggers/access-request-dynamic-approval +slug: /extensibility/event-triggers/triggers/access-request-dynamic-approval tags: ['Event Triggers', 'Available Event Triggers', 'Request Response'] --- @@ -18,12 +18,12 @@ The Access Request Dynamic Approval event trigger provides a way to route a requ When an access request is submitted, the Access Request Dynamic Approval trigger does the following: - Sends data about the access request and expects a response including the ID of an existing identity or workgroup (i.e. governance group) to add to the approval workflow. -- Based on the ID received, an approval task is assigned to the identity or governance group in IdentityNow for a decision as an additional step after other configured approval requirements are met. +- Based on the ID received, an approval task is assigned to the identity or governance group in Identity Security Cloud for a decision as an additional step after other configured approval requirements are met. - If the new approver is also the target identity for this request, the manager is assigned instead. If the identity has no manager, a random org admin is assigned. - If the ID of the additional approver is wrong, then a random org admin is assigned. - You can choose to **NOT** add an additional approver by providing an empty object as the response to the triggered REST request. -You can use this trigger to develop logic outside of IdentityNow’s out-of-the-box offerings to route an approval step to users such as the following: +You can use this trigger to develop logic outside of Identity Security Cloud’s out-of-the-box offerings to route an approval step to users such as the following: - The recipient’s department head - The recipient’s cost center diff --git a/products/idn/docs/identity-now/event-triggers/available/access-request-submitted.md b/docs/extensibility/event-triggers/available/access-request-submitted.md similarity index 98% rename from products/idn/docs/identity-now/event-triggers/available/access-request-submitted.md rename to docs/extensibility/event-triggers/available/access-request-submitted.md index 4eb2ade50..180be84e1 100644 --- a/products/idn/docs/identity-now/event-triggers/available/access-request-submitted.md +++ b/docs/extensibility/event-triggers/available/access-request-submitted.md @@ -6,7 +6,7 @@ sidebar_label: Access Request Submitted sidebar_class_name: accessRequestSubmitted keywords: ['event', 'trigger', 'access', 'request', 'submitted', 'preapproval', 'available'] description: Fires after an access request is submitted. -slug: /docs/event-triggers/triggers/access-request-submitted +slug: /extensibility/event-triggers/triggers/access-request-submitted tags: ['Event Triggers', 'Available Event Triggers', 'Request Response'] --- diff --git a/products/idn/docs/identity-now/event-triggers/available/account-aggregation-completed.md b/docs/extensibility/event-triggers/available/account-aggregation-completed.md similarity index 92% rename from products/idn/docs/identity-now/event-triggers/available/account-aggregation-completed.md rename to docs/extensibility/event-triggers/available/account-aggregation-completed.md index fab67236d..6e0de65a9 100644 --- a/products/idn/docs/identity-now/event-triggers/available/account-aggregation-completed.md +++ b/docs/extensibility/event-triggers/available/account-aggregation-completed.md @@ -7,7 +7,7 @@ sidebar_class_name: accountAggregationCompleted keywords: ['event', 'trigger', 'account', 'aggregation', 'completed', 'available'] description: Fires after an account aggregation completed, terminated, or failed. -slug: /docs/event-triggers/triggers/account-aggregation-completed +slug: /extensibility/event-triggers/triggers/account-aggregation-completed tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget'] --- @@ -19,9 +19,9 @@ The platform has introduced an event trigger within the Source Aggregation workf After the initial collection of accounts in the source system during aggregation completes, some uses cases for this trigger include the following: -- Notify an administrator that IdentityNow was able to successfully connect to the source system and collect source accounts. +- Notify an administrator that Identity Security Cloud was able to successfully connect to the source system and collect source accounts. - Notify an administrator when the aggregation is terminated manually during the account collection phase. -- Notify an administrator or system (e.g. PagerDuty) that IdentityNow failed to collect accounts during aggregation and indicate required remediation for the source system. +- Notify an administrator or system (e.g. PagerDuty) that Identity Security Cloud failed to collect accounts during aggregation and indicate required remediation for the source system. :::info diff --git a/products/idn/docs/identity-now/event-triggers/available/campaign-activated.md b/docs/extensibility/event-triggers/available/campaign-activated.md similarity index 95% rename from products/idn/docs/identity-now/event-triggers/available/campaign-activated.md rename to docs/extensibility/event-triggers/available/campaign-activated.md index e27649520..a303caec3 100644 --- a/products/idn/docs/identity-now/event-triggers/available/campaign-activated.md +++ b/docs/extensibility/event-triggers/available/campaign-activated.md @@ -6,7 +6,7 @@ sidebar_label: Campaign Activated sidebar_class_name: campaignActivated keywords: ['event', 'trigger', 'campaign', 'activated', 'available'] description: Triggered when a campaign is activated. -slug: /docs/event-triggers/triggers/campaign-activated +slug: /extensibility/event-triggers/triggers/campaign-activated tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget'] --- diff --git a/products/idn/docs/identity-now/event-triggers/available/campaign-ended.md b/docs/extensibility/event-triggers/available/campaign-ended.md similarity index 95% rename from products/idn/docs/identity-now/event-triggers/available/campaign-ended.md rename to docs/extensibility/event-triggers/available/campaign-ended.md index dea4ee34e..7646b140d 100644 --- a/products/idn/docs/identity-now/event-triggers/available/campaign-ended.md +++ b/docs/extensibility/event-triggers/available/campaign-ended.md @@ -6,7 +6,7 @@ sidebar_label: Campaign Ended sidebar_class_name: campaignEnded keywords: ['event', 'trigger', 'campaign', 'ended', 'available'] description: Triggered when a campaign is ended. -slug: /docs/event-triggers/triggers/campaign-ended +slug: /extensibility/event-triggers/triggers/campaign-ended tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget'] --- diff --git a/products/idn/docs/identity-now/event-triggers/available/campaign-generated.md b/docs/extensibility/event-triggers/available/campaign-generated.md similarity index 96% rename from products/idn/docs/identity-now/event-triggers/available/campaign-generated.md rename to docs/extensibility/event-triggers/available/campaign-generated.md index 5c7b393aa..485601343 100644 --- a/products/idn/docs/identity-now/event-triggers/available/campaign-generated.md +++ b/docs/extensibility/event-triggers/available/campaign-generated.md @@ -6,7 +6,7 @@ sidebar_label: Campaign Generated sidebar_class_name: campaignGenerated keywords: ['event', 'trigger', 'campaign', 'generated', 'available'] description: Triggered when a campaign finishes generating. -slug: /docs/event-triggers/triggers/campaign-generated +slug: /extensibility/event-triggers/triggers/campaign-generated tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget'] --- diff --git a/products/idn/docs/identity-now/event-triggers/available/certification-signed-off.md b/docs/extensibility/event-triggers/available/certification-signed-off.md similarity index 96% rename from products/idn/docs/identity-now/event-triggers/available/certification-signed-off.md rename to docs/extensibility/event-triggers/available/certification-signed-off.md index e0b87a2c9..109337a0a 100644 --- a/products/idn/docs/identity-now/event-triggers/available/certification-signed-off.md +++ b/docs/extensibility/event-triggers/available/certification-signed-off.md @@ -6,7 +6,7 @@ sidebar_label: Certification Signed Off sidebar_class_name: certificationSignedOff keywords: ['event', 'trigger', 'certification', 'available'] description: Triggered when a certification is signed off by its reviewer. -slug: /docs/event-triggers/triggers/certification-signed-off +slug: /extensibility/event-triggers/triggers/certification-signed-off tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget'] --- diff --git a/products/idn/docs/identity-now/event-triggers/available/form-submitted.md b/docs/extensibility/event-triggers/available/form-submitted.md similarity index 96% rename from products/idn/docs/identity-now/event-triggers/available/form-submitted.md rename to docs/extensibility/event-triggers/available/form-submitted.md index 4183dcedd..998ecfe6e 100644 --- a/products/idn/docs/identity-now/event-triggers/available/form-submitted.md +++ b/docs/extensibility/event-triggers/available/form-submitted.md @@ -6,7 +6,7 @@ sidebar_label: Form Submitted sidebar_class_name: formSubmitted keywords: ['event', 'trigger', 'form', 'submitted', 'available'] description: Triggered when a form is submitted. -slug: /docs/event-triggers/triggers/form-submitted +slug: /extensibility/event-triggers/triggers/form-submitted tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget'] --- diff --git a/products/idn/docs/identity-now/event-triggers/available/identity-attribute-changed.md b/docs/extensibility/event-triggers/available/identity-attribute-changed.md similarity index 96% rename from products/idn/docs/identity-now/event-triggers/available/identity-attribute-changed.md rename to docs/extensibility/event-triggers/available/identity-attribute-changed.md index f6f234ab4..02f30b340 100644 --- a/products/idn/docs/identity-now/event-triggers/available/identity-attribute-changed.md +++ b/docs/extensibility/event-triggers/available/identity-attribute-changed.md @@ -6,7 +6,7 @@ sidebar_label: Identity Attributes Changed sidebar_class_name: identityAttributesChanged keywords: ['event', 'trigger', 'identity', 'attributes', 'changed', 'available'] description: Fires after one or more identity attributes changed. -slug: /docs/event-triggers/triggers/identity-attribute-changed +slug: /extensibility/event-triggers/triggers/identity-attribute-changed tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget'] --- diff --git a/products/idn/docs/identity-now/event-triggers/available/identity-created.md b/docs/extensibility/event-triggers/available/identity-created.md similarity index 96% rename from products/idn/docs/identity-now/event-triggers/available/identity-created.md rename to docs/extensibility/event-triggers/available/identity-created.md index 64134b661..678f76484 100644 --- a/products/idn/docs/identity-now/event-triggers/available/identity-created.md +++ b/docs/extensibility/event-triggers/available/identity-created.md @@ -6,7 +6,7 @@ sidebar_label: Identity Created sidebar_class_name: identityCreated keywords: ['event', 'trigger', 'identity', 'created', 'available'] description: Fires after an identity is created. -slug: /docs/event-triggers/triggers/identity-created +slug: /extensibility/event-triggers/triggers/identity-created tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget'] --- diff --git a/products/idn/docs/identity-now/event-triggers/available/img/access-request-postapproval-path.png b/docs/extensibility/event-triggers/available/img/access-request-postapproval-path.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/available/img/access-request-postapproval-path.png rename to docs/extensibility/event-triggers/available/img/access-request-postapproval-path.png diff --git a/products/idn/docs/identity-now/event-triggers/available/img/access-request-preapproval-failure.png b/docs/extensibility/event-triggers/available/img/access-request-preapproval-failure.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/available/img/access-request-preapproval-failure.png rename to docs/extensibility/event-triggers/available/img/access-request-preapproval-failure.png diff --git a/products/idn/docs/identity-now/event-triggers/available/img/access-request-preapproval-path.png b/docs/extensibility/event-triggers/available/img/access-request-preapproval-path.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/available/img/access-request-preapproval-path.png rename to docs/extensibility/event-triggers/available/img/access-request-preapproval-path.png diff --git a/products/idn/docs/identity-now/event-triggers/available/img/aggregation-delete-threshold.png b/docs/extensibility/event-triggers/available/img/aggregation-delete-threshold.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/available/img/aggregation-delete-threshold.png rename to docs/extensibility/event-triggers/available/img/aggregation-delete-threshold.png diff --git a/products/idn/docs/identity-now/event-triggers/available/img/aggregation-diagram.png b/docs/extensibility/event-triggers/available/img/aggregation-diagram.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/available/img/aggregation-diagram.png rename to docs/extensibility/event-triggers/available/img/aggregation-diagram.png diff --git a/products/idn/docs/identity-now/event-triggers/available/img/aggregation-enable-scheduling.png b/docs/extensibility/event-triggers/available/img/aggregation-enable-scheduling.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/available/img/aggregation-enable-scheduling.png rename to docs/extensibility/event-triggers/available/img/aggregation-enable-scheduling.png diff --git a/products/idn/docs/identity-now/event-triggers/available/img/attributes-highlight.png b/docs/extensibility/event-triggers/available/img/attributes-highlight.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/available/img/attributes-highlight.png rename to docs/extensibility/event-triggers/available/img/attributes-highlight.png diff --git a/products/idn/docs/identity-now/event-triggers/available/img/campaign-generated-generating.png b/docs/extensibility/event-triggers/available/img/campaign-generated-generating.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/available/img/campaign-generated-generating.png rename to docs/extensibility/event-triggers/available/img/campaign-generated-generating.png diff --git a/products/idn/docs/identity-now/event-triggers/available/img/campaign-generated-preview.png b/docs/extensibility/event-triggers/available/img/campaign-generated-preview.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/available/img/campaign-generated-preview.png rename to docs/extensibility/event-triggers/available/img/campaign-generated-preview.png diff --git a/products/idn/docs/identity-now/event-triggers/available/img/identity-created-attributes-highlight.png b/docs/extensibility/event-triggers/available/img/identity-created-attributes-highlight.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/available/img/identity-created-attributes-highlight.png rename to docs/extensibility/event-triggers/available/img/identity-created-attributes-highlight.png diff --git a/products/idn/docs/identity-now/event-triggers/available/img/identity-created-path.png b/docs/extensibility/event-triggers/available/img/identity-created-path.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/available/img/identity-created-path.png rename to docs/extensibility/event-triggers/available/img/identity-created-path.png diff --git a/products/idn/docs/identity-now/event-triggers/available/img/provisioning-access-request-2.png b/docs/extensibility/event-triggers/available/img/provisioning-access-request-2.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/available/img/provisioning-access-request-2.png rename to docs/extensibility/event-triggers/available/img/provisioning-access-request-2.png diff --git a/products/idn/docs/identity-now/event-triggers/available/img/provisioning-access-request-certification.png b/docs/extensibility/event-triggers/available/img/provisioning-access-request-certification.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/available/img/provisioning-access-request-certification.png rename to docs/extensibility/event-triggers/available/img/provisioning-access-request-certification.png diff --git a/products/idn/docs/identity-now/event-triggers/available/img/provisioning-access-request.png b/docs/extensibility/event-triggers/available/img/provisioning-access-request.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/available/img/provisioning-access-request.png rename to docs/extensibility/event-triggers/available/img/provisioning-access-request.png diff --git a/products/idn/docs/identity-now/event-triggers/available/img/provisioning-action.png b/docs/extensibility/event-triggers/available/img/provisioning-action.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/available/img/provisioning-action.png rename to docs/extensibility/event-triggers/available/img/provisioning-action.png diff --git a/products/idn/docs/identity-now/event-triggers/available/img/provisioning-lifecycle-management.png b/docs/extensibility/event-triggers/available/img/provisioning-lifecycle-management.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/available/img/provisioning-lifecycle-management.png rename to docs/extensibility/event-triggers/available/img/provisioning-lifecycle-management.png diff --git a/products/idn/docs/identity-now/event-triggers/available/img/provisioning-role-membership.png b/docs/extensibility/event-triggers/available/img/provisioning-role-membership.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/available/img/provisioning-role-membership.png rename to docs/extensibility/event-triggers/available/img/provisioning-role-membership.png diff --git a/products/idn/docs/identity-now/event-triggers/available/img/saved-search-path.png b/docs/extensibility/event-triggers/available/img/saved-search-path.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/available/img/saved-search-path.png rename to docs/extensibility/event-triggers/available/img/saved-search-path.png diff --git a/products/idn/docs/identity-now/event-triggers/available/img/trigger-path.png b/docs/extensibility/event-triggers/available/img/trigger-path.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/available/img/trigger-path.png rename to docs/extensibility/event-triggers/available/img/trigger-path.png diff --git a/products/idn/docs/identity-now/event-triggers/available/img/va-cluster-failed.png b/docs/extensibility/event-triggers/available/img/va-cluster-failed.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/available/img/va-cluster-failed.png rename to docs/extensibility/event-triggers/available/img/va-cluster-failed.png diff --git a/products/idn/docs/identity-now/event-triggers/available/img/va-cluster-healthy-source.png b/docs/extensibility/event-triggers/available/img/va-cluster-healthy-source.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/available/img/va-cluster-healthy-source.png rename to docs/extensibility/event-triggers/available/img/va-cluster-healthy-source.png diff --git a/products/idn/docs/identity-now/event-triggers/available/img/va-cluster-unhealthy-source.png b/docs/extensibility/event-triggers/available/img/va-cluster-unhealthy-source.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/available/img/va-cluster-unhealthy-source.png rename to docs/extensibility/event-triggers/available/img/va-cluster-unhealthy-source.png diff --git a/products/idn/docs/identity-now/event-triggers/available/img/va-cluster-warning.png b/docs/extensibility/event-triggers/available/img/va-cluster-warning.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/available/img/va-cluster-warning.png rename to docs/extensibility/event-triggers/available/img/va-cluster-warning.png diff --git a/products/idn/docs/identity-now/event-triggers/available/index.mdx b/docs/extensibility/event-triggers/available/index.mdx similarity index 86% rename from products/idn/docs/identity-now/event-triggers/available/index.mdx rename to docs/extensibility/event-triggers/available/index.mdx index 5ce153d65..58fd41bc0 100644 --- a/products/idn/docs/identity-now/event-triggers/available/index.mdx +++ b/docs/extensibility/event-triggers/available/index.mdx @@ -7,13 +7,13 @@ sidebar_class_name: availableEventTriggers keywords: ['event', 'trigger', 'available'] description: Event triggers that are generally available. sidebar_position: 7 -slug: /docs/event-triggers/available +slug: /extensibility/event-triggers/available tags: ['Event Triggers', 'Available Event Triggers'] --- import DocCardList from '@theme/DocCardList'; import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; -The event triggers in this section are generally available to all IDN tenants. Event triggers currently in development are considered [Early Access](../early-access/index.mdx) and require a support ticket to be enabled in a tenant. +The event triggers in this section are generally available to all ISC tenants. Event triggers currently in development are considered [Early Access](../early-access/index.mdx) and require a support ticket to be enabled in a tenant. diff --git a/products/idn/docs/identity-now/event-triggers/available/native-change-account-created.md b/docs/extensibility/event-triggers/available/native-change-account-created.md similarity index 96% rename from products/idn/docs/identity-now/event-triggers/available/native-change-account-created.md rename to docs/extensibility/event-triggers/available/native-change-account-created.md index 344c095aa..6de4780e4 100644 --- a/products/idn/docs/identity-now/event-triggers/available/native-change-account-created.md +++ b/docs/extensibility/event-triggers/available/native-change-account-created.md @@ -6,7 +6,7 @@ sidebar_label: Native Change Account Created sidebar_class_name: nativeChangeAccountCreated keywords: ['account', 'created', 'available'] description: Fires after Account Aggregations detects that a new account is created external to Identity Security Platform on sources -slug: /docs/event-triggers/triggers/native-change-account-created +slug: /extensibility/event-triggers/triggers/native-change-account-created tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget'] --- @@ -16,7 +16,7 @@ tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget'] You must have at least one source configured for Native Change Detection (NCD) before you will receive events from this trigger. There are two ways you can configure a source for NCD: -1. Invoke the [update native change detection configuration](https://developer.sailpoint.com/idn/api/beta/put-native-change-detection-config) for each source you want to receive events for NCD. +1. Invoke the [update native change detection configuration](https://developer.sailpoint.com/docs/api/beta/put-native-change-detection-config) for each source you want to receive events for NCD. 2. Configure the NCD options on the source in the source configuration UI. ::: @@ -180,7 +180,7 @@ This is an example input from this trigger: - `multiValueAttributeChanges` List of multivalued attributes that were aggregated with the account. Only `addedValues` will appear for account created events. - it will include ALL account attributes if the config is `"allNonEntitlementAttributes": true` - it will include the enumerated list of attributes contained in `"selectedNonEntitlementAttributes": []` -- `account` The details of the account as it appears in IdentityNow. This information can be used to query the account API for more information. +- `account` The details of the account as it appears in Identity Security Cloud. This information can be used to query the account API for more information. ## Additional Information and Links diff --git a/products/idn/docs/identity-now/event-triggers/available/native-change-account-deleted.md b/docs/extensibility/event-triggers/available/native-change-account-deleted.md similarity index 95% rename from products/idn/docs/identity-now/event-triggers/available/native-change-account-deleted.md rename to docs/extensibility/event-triggers/available/native-change-account-deleted.md index 48417a7dc..0da5ec974 100644 --- a/products/idn/docs/identity-now/event-triggers/available/native-change-account-deleted.md +++ b/docs/extensibility/event-triggers/available/native-change-account-deleted.md @@ -6,7 +6,7 @@ sidebar_label: Native Change Account Deleted sidebar_class_name: nativeChangeAccountDeleted keywords: ['account', 'deleted', 'available'] description: Fires after Account Aggregations detects that an account is deleted external to Identity Security Platform on sources -slug: /docs/event-triggers/triggers/native-change-account-deleted +slug: /extensibility/event-triggers/triggers/native-change-account-deleted tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget'] --- @@ -16,7 +16,7 @@ tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget'] You must have at least one source configured for Native Change Detection (NCD) before you will receive events from this trigger. There are two ways you can configure a source for NCD: -1. Invoke the [update native change detection configuration](https://developer.sailpoint.com/idn/api/beta/put-native-change-detection-config) for each source you want to receive events for NCD. +1. Invoke the [update native change detection configuration](https://developer.sailpoint.com/docs/api/beta/put-native-change-detection-config) for each source you want to receive events for NCD. 2. Configure the NCD options on the source in the source configuration UI. ::: @@ -168,7 +168,7 @@ This is an example input from this trigger: - `multiValueAttributeChanges` List of multivalued attributes that were aggregated with the account. Only `removedValues` will appear for account deleted events. - it will include ALL account attributes if the config is `"allNonEntitlementAttributes": true` - it will include the enumerated list of attributes contained in `"selectedNonEntitlementAttributes": []` -- `account` The details of the account as it appears in IdentityNow. This information can be used to query the account API for more information. +- `account` The details of the account as it appears in Identity Security Cloud. This information can be used to query the account API for more information. ## Additional Information and Links diff --git a/products/idn/docs/identity-now/event-triggers/available/native-change-account-updated.md b/docs/extensibility/event-triggers/available/native-change-account-updated.md similarity index 95% rename from products/idn/docs/identity-now/event-triggers/available/native-change-account-updated.md rename to docs/extensibility/event-triggers/available/native-change-account-updated.md index ecefd2bb0..948afa2f1 100644 --- a/products/idn/docs/identity-now/event-triggers/available/native-change-account-updated.md +++ b/docs/extensibility/event-triggers/available/native-change-account-updated.md @@ -6,7 +6,7 @@ sidebar_label: Native Change Account Updated sidebar_class_name: nativeChangeAccountUpdated keywords: ['account', 'updated', 'available'] description: Fires after an account is updated outside of Identity Security Platform -slug: /docs/event-triggers/triggers/native-change-account-updated +slug: /extensibility/event-triggers/triggers/native-change-account-updated tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget'] --- @@ -16,7 +16,7 @@ tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget'] You must have at least one source configured for Native Change Detection (NCD) before you will receive events from this trigger. There are two ways you can configure a source for NCD: -1. Invoke the [update native change detection configuration](https://developer.sailpoint.com/idn/api/beta/put-native-change-detection-config) for each source you want to receive events for NCD. +1. Invoke the [update native change detection configuration](https://developer.sailpoint.com/docs/api/beta/put-native-change-detection-config) for each source you want to receive events for NCD. 2. Configure the NCD options on the source in the source configuration UI. ::: @@ -135,7 +135,7 @@ This is an example input from this trigger: - `multiValueAttributeChanges` List of multivalued attributes that were added and/or removed on the account. - it will include ALL account attributes if the config is `"allNonEntitlementAttributes": true` - it will include the enumerated list of attributes contained in `"selectedNonEntitlementAttributes": []` -- `account` The details of the account as it appears in IdentityNow. This information can be used to query the account API for more information. +- `account` The details of the account as it appears in Identity Security Cloud. This information can be used to query the account API for more information. ## Additional Information and Links diff --git a/products/idn/docs/identity-now/event-triggers/available/outlier-detected.md b/docs/extensibility/event-triggers/available/outlier-detected.md similarity index 96% rename from products/idn/docs/identity-now/event-triggers/available/outlier-detected.md rename to docs/extensibility/event-triggers/available/outlier-detected.md index 1bf53a138..00f752d9c 100644 --- a/products/idn/docs/identity-now/event-triggers/available/outlier-detected.md +++ b/docs/extensibility/event-triggers/available/outlier-detected.md @@ -7,7 +7,7 @@ sidebar_class_name: outlierDetected keywords: ['event', 'trigger', 'outlier', 'detected'] description: Fires after an identity was detected as an outlier. -slug: /docs/event-triggers/triggers/outlier-detected +slug: /extensibility/event-triggers/triggers/outlier-detected tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget'] --- diff --git a/products/idn/docs/identity-now/event-triggers/available/provisioning-completed.md b/docs/extensibility/event-triggers/available/provisioning-completed.md similarity index 95% rename from products/idn/docs/identity-now/event-triggers/available/provisioning-completed.md rename to docs/extensibility/event-triggers/available/provisioning-completed.md index 8955e5169..ca274ef02 100644 --- a/products/idn/docs/identity-now/event-triggers/available/provisioning-completed.md +++ b/docs/extensibility/event-triggers/available/provisioning-completed.md @@ -7,7 +7,7 @@ sidebar_class_name: provisioningCompleted keywords: ['event', 'trigger', 'provisioning', 'action', 'completed', 'available'] description: Fires after a provisioning action completed on a source. -slug: /docs/event-triggers/triggers/provisioning-completed +slug: /extensibility/event-triggers/triggers/provisioning-completed tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget'] --- @@ -83,7 +83,7 @@ To provision to a target application, the connector for the source must support - `PROVISIONING` - Can write to accounts. Currently, the trigger does not include attribute synchronization. - `PASSWORD` - Can update password for accounts. -For a list of supported connectors and features, see [Supported Connectors for IdentityNow](https://community.sailpoint.com/t5/Connectors/Supported-Sources-Connectors-for-IdentityNow/ta-p/80019). +For a list of supported connectors and features, see [Supported Connectors for Identity Security Cloud](https://community.sailpoint.com/t5/Connectors/Supported-Sources-Connectors-for-Identity Security Cloud/ta-p/80019). For information about configuring sources for provisioning, see [How can I edit the Create Profile on a source?](https://community.sailpoint.com/t5/Connectors/How-can-I-edit-the-Create-Profile-on-a-source/ta-p/74429). @@ -110,7 +110,7 @@ The following steps must be completed: - Access profile using source entitlements. Role setup is optional. - Application enabled for Access Request. -> **NOTE:** There is no indication to the approver in the IdentityNow UI that the approval is for a revoke action. This must be considered for all usage of these APIs. +> **NOTE:** There is no indication to the approver in the Identity Security Cloud UI that the approval is for a revoke action. This must be considered for all usage of these APIs. ![Flow](./img/provisioning-access-request-2.png) diff --git a/products/idn/docs/identity-now/event-triggers/available/scheduled-search.md b/docs/extensibility/event-triggers/available/scheduled-search.md similarity index 95% rename from products/idn/docs/identity-now/event-triggers/available/scheduled-search.md rename to docs/extensibility/event-triggers/available/scheduled-search.md index 63ec34b3b..c4649f11f 100644 --- a/products/idn/docs/identity-now/event-triggers/available/scheduled-search.md +++ b/docs/extensibility/event-triggers/available/scheduled-search.md @@ -6,7 +6,7 @@ sidebar_label: Scheduled Search sidebar_class_name: scheduledSearch keywords: ['event', 'trigger', 'saved', 'scheduled', 'search', 'complete', 'available'] description: Fires after a scheduled search completes. -slug: /docs/event-triggers/triggers/scheduled-search +slug: /extensibility/event-triggers/triggers/scheduled-search tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget'] --- @@ -16,7 +16,7 @@ tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget'] Users can subscribe to saved searches and receive an email of a report generated from the saved search. For example, a user can save a search query called "Identities with upcoming end dates" and create a subscription to receive a daily report showing identities with an end date within 10 days from the current date. This event trigger can also notify an external HTTP application that a report generated from a saved search subscription is available to be processed. -'Scheduled search' events occur based on the schedules set for saved search subscriptions. For example, if you have a scheduled saved search for Monday, Tuesday, Wednesday, Thursday, Friday at 6:00 GMT, your HTTP endpoint will also receive a notification at those times. This can be set using the `schedule` object in the [create scheduled search endpoint](/idn/api/v3/create-scheduled-search). +'Scheduled search' events occur based on the schedules set for saved search subscriptions. For example, if you have a scheduled saved search for Monday, Tuesday, Wednesday, Thursday, Friday at 6:00 GMT, your HTTP endpoint will also receive a notification at those times. This can be set using the `schedule` object in the [create scheduled search endpoint](/docs/api/v3/create-scheduled-search). To receive this event when a saved search query does not have any results, set `emailEmptyResults` to `TRUE`. You can also set the expiration date in the `expiration` field within the `schedule` object. Your HTTP endpoint will stop receiving these events when the scheduled search expires. diff --git a/products/idn/docs/identity-now/event-triggers/available/source-created.md b/docs/extensibility/event-triggers/available/source-created.md similarity index 95% rename from products/idn/docs/identity-now/event-triggers/available/source-created.md rename to docs/extensibility/event-triggers/available/source-created.md index e584613ad..938003fae 100644 --- a/products/idn/docs/identity-now/event-triggers/available/source-created.md +++ b/docs/extensibility/event-triggers/available/source-created.md @@ -6,7 +6,7 @@ sidebar_label: Source Created sidebar_class_name: sourceCreated keywords: ['event', 'trigger', 'source', 'created', 'available'] description: Fires after a source is created. -slug: /docs/event-triggers/triggers/source-created +slug: /extensibility/event-triggers/triggers/source-created tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget'] --- diff --git a/products/idn/docs/identity-now/event-triggers/available/source-deleted.md b/docs/extensibility/event-triggers/available/source-deleted.md similarity index 95% rename from products/idn/docs/identity-now/event-triggers/available/source-deleted.md rename to docs/extensibility/event-triggers/available/source-deleted.md index 7779f0f72..87ecdd892 100644 --- a/products/idn/docs/identity-now/event-triggers/available/source-deleted.md +++ b/docs/extensibility/event-triggers/available/source-deleted.md @@ -6,7 +6,7 @@ sidebar_label: Source Deleted sidebar_class_name: sourceDeleted keywords: ['event', 'trigger', 'source', 'deleted', 'available'] description: Fires after a source is deleted. -slug: /docs/event-triggers/triggers/source-deleted +slug: /extensibility/event-triggers/triggers/source-deleted tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget'] --- diff --git a/products/idn/docs/identity-now/event-triggers/available/source-updated.md b/docs/extensibility/event-triggers/available/source-updated.md similarity index 95% rename from products/idn/docs/identity-now/event-triggers/available/source-updated.md rename to docs/extensibility/event-triggers/available/source-updated.md index cea8335a1..205bda20e 100644 --- a/products/idn/docs/identity-now/event-triggers/available/source-updated.md +++ b/docs/extensibility/event-triggers/available/source-updated.md @@ -6,7 +6,7 @@ sidebar_label: Source Updated sidebar_class_name: sourceUpdated keywords: ['event', 'trigger', 'source', 'updated', 'available'] description: Fires after a source is updated. -slug: /docs/event-triggers/triggers/source-updated +slug: /extensibility/event-triggers/triggers/source-updated tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget'] --- diff --git a/products/idn/docs/identity-now/event-triggers/available/va-cluster-status-change.md b/docs/extensibility/event-triggers/available/va-cluster-status-change.md similarity index 92% rename from products/idn/docs/identity-now/event-triggers/available/va-cluster-status-change.md rename to docs/extensibility/event-triggers/available/va-cluster-status-change.md index cf8c9a94b..53fc16d12 100644 --- a/products/idn/docs/identity-now/event-triggers/available/va-cluster-status-change.md +++ b/docs/extensibility/event-triggers/available/va-cluster-status-change.md @@ -6,7 +6,7 @@ sidebar_label: VA Cluster Status Change sidebar_class_name: vaClusterStatusChange keywords: ['event', 'trigger', 'va', 'cluster', 'status', 'change', 'available'] description: Fires after the status of a VA cluster has changed. -slug: /docs/event-triggers/triggers/va-cluster-status-change +slug: /extensibility/event-triggers/triggers/va-cluster-status-change tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget'] --- @@ -23,7 +23,7 @@ Additional notes about VA Cluster Status Changes: - VA cluster health checks run every 30 minutes. - This trigger will invoke on any VA cluster health status change (i.e. healthy -> unhealthy, unhealthy -> healthy). -- See [troubleshooting virtual appliances](https://community.sailpoint.com/t5/IdentityNow-Connectors/Virtual-Appliance-Troubleshooting-Guide/ta-p/78735) for more information. +- See [troubleshooting virtual appliances](https://community.sailpoint.com/t5/Identity Security Cloud-Connectors/Virtual-Appliance-Troubleshooting-Guide/ta-p/78735) for more information. Healthy Cluster Source diff --git a/products/idn/docs/identity-now/event-triggers/early-access/identity-deleted.md b/docs/extensibility/event-triggers/early-access/identity-deleted.md similarity index 69% rename from products/idn/docs/identity-now/event-triggers/early-access/identity-deleted.md rename to docs/extensibility/event-triggers/early-access/identity-deleted.md index cc35a21ad..d0f859c97 100644 --- a/products/idn/docs/identity-now/event-triggers/early-access/identity-deleted.md +++ b/docs/extensibility/event-triggers/early-access/identity-deleted.md @@ -6,7 +6,7 @@ sidebar_label: Identity Deleted sidebar_class_name: identityDeleted keywords: ['event', 'trigger', 'identity', 'deleted', 'early access'] description: Fires after an identity is deleted. -slug: /docs/event-triggers/triggers/identity-deleted +slug: /extensibility/event-triggers/triggers/identity-deleted tags: ['Event Triggers', 'Early Access Event Triggers', 'Fire and Forget'] --- @@ -29,11 +29,11 @@ Identity deleted event will occur when an identity meets all of the following re - No assigned capabilities (ex. not an assigned cert reviewer) - Not involved in any active certification as a target (its access is not being certified) -After accounts are aggregated and the identity refresh process finds an identity that meets the above criteria, the associated identity is deleted from IdentityNow. For more information, see [Configuring Correlation](https://community.sailpoint.com/t5/Connectors/Configuring-Correlation/ta-p/74045). The Identity deleted event contains any identity attributes as they are configured in the identity profile. For more information, see [Mapping Identity Profiles](https://community.sailpoint.com/t5/Admin-Help/Mapping-Identity-Profiles/ta-p/77877). +After accounts are aggregated and the identity refresh process finds an identity that meets the above criteria, the associated identity is deleted from Identity Security Cloud. For more information, see [Configuring Correlation](https://community.sailpoint.com/t5/Connectors/Configuring-Correlation/ta-p/74045). The Identity deleted event contains any identity attributes as they are configured in the identity profile. For more information, see [Mapping Identity Profiles](https://community.sailpoint.com/t5/Admin-Help/Mapping-Identity-Profiles/ta-p/77877). :::info -IdentityNow will **hide** an identity from the identity list in the UI when the authoritative account is removed. This does not necessarily mean that the identity has been deleted. The identity will only be deleted when the above criteria are met. The deletion task run each night, so there will be a delay from when the criteria are met to when the identity will actually be deleted. +Identity Security Cloud will **hide** an identity from the identity list in the UI when the authoritative account is removed. This does not necessarily mean that the identity has been deleted. The identity will only be deleted when the above criteria are met. The deletion task run each night, so there will be a delay from when the criteria are met to when the identity will actually be deleted. ::: diff --git a/products/idn/docs/identity-now/event-triggers/early-access/img/identity-deleted-path.png b/docs/extensibility/event-triggers/early-access/img/identity-deleted-path.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/early-access/img/identity-deleted-path.png rename to docs/extensibility/event-triggers/early-access/img/identity-deleted-path.png diff --git a/products/idn/docs/identity-now/event-triggers/early-access/index.mdx b/docs/extensibility/event-triggers/early-access/index.mdx similarity index 94% rename from products/idn/docs/identity-now/event-triggers/early-access/index.mdx rename to docs/extensibility/event-triggers/early-access/index.mdx index 254a29047..70aeaa384 100644 --- a/products/idn/docs/identity-now/event-triggers/early-access/index.mdx +++ b/docs/extensibility/event-triggers/early-access/index.mdx @@ -7,7 +7,7 @@ sidebar_class_name: earlyAccessEventTriggers keywords: ['event', 'trigger', 'early access'] description: Event triggers that require a support ticket to enable. sidebar_position: 8 -slug: /docs/event-triggers/early-access +slug: /extensibility/event-triggers/early-access tags: ['Event Triggers', 'Early Access Event Triggers'] --- diff --git a/products/idn/docs/identity-now/event-triggers/early-access/source-account-created.md b/docs/extensibility/event-triggers/early-access/source-account-created.md similarity index 89% rename from products/idn/docs/identity-now/event-triggers/early-access/source-account-created.md rename to docs/extensibility/event-triggers/early-access/source-account-created.md index 6d228b735..ad100ac66 100644 --- a/products/idn/docs/identity-now/event-triggers/early-access/source-account-created.md +++ b/docs/extensibility/event-triggers/early-access/source-account-created.md @@ -6,7 +6,7 @@ sidebar_label: Source Account Created sidebar_class_name: sourceAccountCreated keywords: ['event', 'trigger', 'source', 'account', 'created', 'early access'] description: Fires after a source account is created. -slug: /docs/event-triggers/triggers/source-account-created +slug: /extensibility/event-triggers/triggers/source-account-created tags: ['Event Triggers', 'Early Access Event Triggers', 'Fire and Forget'] --- @@ -18,7 +18,7 @@ This is an early access event trigger. Please contact support to have it enabled ## Event Context -Source Account Created events occur after a new account is detected during an account aggregration and refresh from a source. This trigger cannot determine whether account creation happened on a source or in IdentityNow. It omits events related to IdentityNow accounts, such as the IdentityNow Admin. +Source Account Created events occur after a new account is detected during an account aggregration and refresh from a source. This trigger cannot determine whether account creation happened on a source or in Identity Security Cloud. It omits events related to Identity Security Cloud accounts, such as the Identity Security Cloud Admin. Use this event trigger to watch for new accounts with highly privileged access, such as an account created in Active Directory Domain Admins. diff --git a/products/idn/docs/identity-now/event-triggers/early-access/source-account-deleted.md b/docs/extensibility/event-triggers/early-access/source-account-deleted.md similarity index 88% rename from products/idn/docs/identity-now/event-triggers/early-access/source-account-deleted.md rename to docs/extensibility/event-triggers/early-access/source-account-deleted.md index 6a955fab0..80f4b289f 100644 --- a/products/idn/docs/identity-now/event-triggers/early-access/source-account-deleted.md +++ b/docs/extensibility/event-triggers/early-access/source-account-deleted.md @@ -6,7 +6,7 @@ sidebar_label: Source Account Deleted sidebar_class_name: sourceAccountDeleted keywords: ['event', 'trigger', 'source', 'account', 'deleted', 'early access'] description: Fires after a source account is deleted. -slug: /docs/event-triggers/triggers/source-account-deleted +slug: /extensibility/event-triggers/triggers/source-account-deleted tags: ['Event Triggers', 'Early Access Event Triggers', 'Fire and Forget'] --- @@ -18,7 +18,7 @@ This is an early access event trigger. Please contact support to have it enabled ## Event Context -Source Account Deleted events occur whenever an account is deleted from its source during an account aggregation operation. The account may have been manually removed or deleted as the result of a provisioning event. The trigger cannot determine whether the account deletion happened on a source or in IdentityNow. It omits events related to IdentityNow accounts, such as the IdentityNow Admin. +Source Account Deleted events occur whenever an account is deleted from its source during an account aggregation operation. The account may have been manually removed or deleted as the result of a provisioning event. The trigger cannot determine whether the account deletion happened on a source or in Identity Security Cloud. It omits events related to Identity Security Cloud accounts, such as the Identity Security Cloud Admin. Use this event trigger to watch for deletions of authoritative accounts, such as an account deleted on Workday. diff --git a/products/idn/docs/identity-now/event-triggers/early-access/source-account-updated.md b/docs/extensibility/event-triggers/early-access/source-account-updated.md similarity index 86% rename from products/idn/docs/identity-now/event-triggers/early-access/source-account-updated.md rename to docs/extensibility/event-triggers/early-access/source-account-updated.md index 68f091916..91a79ab48 100644 --- a/products/idn/docs/identity-now/event-triggers/early-access/source-account-updated.md +++ b/docs/extensibility/event-triggers/early-access/source-account-updated.md @@ -6,8 +6,7 @@ sidebar_label: Source Account Updated sidebar_class_name: sourceAccountUpdated keywords: ['event', 'trigger', 'source', 'account', 'updated', 'early access'] description: Fires after a source account is updated. -pagination_next: docs/identity-now/event-triggers/event-triggers -slug: /docs/event-triggers/triggers/source-account-updated +slug: /extensibility/event-triggers/triggers/source-account-updated tags: ['Event Triggers', 'Early Access Event Triggers', 'Fire and Forget'] --- @@ -19,7 +18,7 @@ This is an early access event trigger. Please contact support to have it enabled ## Event Context -Source Account Updated events occur whenever one or more account attributes change on a single account during an account aggregation operation. The trigger cannot determine whether the account update happened on a source or in IdentityNow. It omits events related to IdentityNow accounts, such as the IdentityNow Admin. The following actions are considered updates: +Source Account Updated events occur whenever one or more account attributes change on a single account during an account aggregation operation. The trigger cannot determine whether the account update happened on a source or in Identity Security Cloud. It omits events related to Identity Security Cloud accounts, such as the Identity Security Cloud Admin. The following actions are considered updates: - Update account attributes - Enable or disable an account diff --git a/products/idn/docs/identity-now/event-triggers/filtering-events.md b/docs/extensibility/event-triggers/filtering-events.md similarity index 92% rename from products/idn/docs/identity-now/event-triggers/filtering-events.md rename to docs/extensibility/event-triggers/filtering-events.md index 6d3e35b45..cfda93dff 100644 --- a/products/idn/docs/identity-now/event-triggers/filtering-events.md +++ b/docs/extensibility/event-triggers/filtering-events.md @@ -7,7 +7,7 @@ sidebar_position: 4 sidebar_class_name: filteringEvents keywords: ['filtering', 'events'] description: Many triggers can produce a staggering amount of events if left unfiltered. Event filtering helps you solve this problem. -slug: /docs/event-triggers/filtering-events +slug: /extensibility/event-triggers/filtering-events tags: ['Event Triggers'] --- @@ -81,7 +81,7 @@ Developing a filter can be faster when you use a tool like an online [JSONpath e ![JSONPath editor](./img/jsonpath-editor.png) -Most of the examples provided in the operator tables above can be used against the Identity Attributes Changed event trigger input, as seen below. You can find all of the input/output schemas for the other available triggers in our [API specification](/idn/api/beta/triggers#available-event-triggers). +Most of the examples provided in the operator tables above can be used against the Identity Attributes Changed event trigger input, as seen below. You can find all of the input/output schemas for the other available triggers in our [API specification](/docs/api/beta/triggers#available-event-triggers). ```json { @@ -130,7 +130,7 @@ To validate a filter using the UI, subscribe to a new event trigger or edit an e ### Validating Filters Using the API -You can validate a trigger filter by using the [test filter](/idn/api/beta/test-subscription-filter) API endpoint. You must escape any double quotes, as seen in the example payload in the API description. Also, you must provide a sample input for the validation engine to run against. It is best to use the input example included in the input/output schemas for the event trigger you want to apply your filter to. Refer to [this table](/idn/api/beta/triggers#available-event-triggers) to find the schema of your event trigger. This is an example request: +You can validate a trigger filter by using the [test filter](/docs/api/beta/test-subscription-filter) API endpoint. You must escape any double quotes, as seen in the example payload in the API description. Also, you must provide a sample input for the validation engine to run against. It is best to use the input example included in the input/output schemas for the event trigger you want to apply your filter to. Refer to [this table](/docs/api/beta/triggers#available-event-triggers) to find the schema of your event trigger. This is an example request: ```text POST https://{tenant}.api.identitynow.com/beta/trigger-subscriptions/validate-filter @@ -182,4 +182,4 @@ If SailPoint accepts your trigger filter, you must test whether it actually work Once you fire off a test event, monitor your webhook.site webpage for an incoming event. If the filter matches the test input, you will an event come in. If the filter does not match the input, then it will nott fire. Test both scenarios to make sure your filter is not always evaluating to `true`, and that it will indeed evaluate to `false` under the correct circumstances. For example, the filter `$[?($.identity.name contains "john")]` will match the test event for Identity Attributes Changed and you will see an event in webhook.site, but you also want to make sure that `$[?($.identity.name contains "archer")]` doesn't fire because the test input is always the same. -If you want to control the test input to validate your filter against a more robust set of data, use the [test invocation](/idn/api/beta/start-test-trigger-invocation) API endpoint. +If you want to control the test input to validate your filter against a more robust set of data, use the [test invocation](/docs/api/beta/start-test-trigger-invocation) API endpoint. diff --git a/products/idn/docs/identity-now/event-triggers/img/activity-log.png b/docs/extensibility/event-triggers/img/activity-log.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/img/activity-log.png rename to docs/extensibility/event-triggers/img/activity-log.png diff --git a/products/idn/docs/identity-now/event-triggers/img/available-triggers.png b/docs/extensibility/event-triggers/img/available-triggers.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/img/available-triggers.png rename to docs/extensibility/event-triggers/img/available-triggers.png diff --git a/products/idn/docs/identity-now/event-triggers/img/debug-connection.png b/docs/extensibility/event-triggers/img/debug-connection.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/img/debug-connection.png rename to docs/extensibility/event-triggers/img/debug-connection.png diff --git a/products/idn/docs/identity-now/event-triggers/img/jsonpath-editor.png b/docs/extensibility/event-triggers/img/jsonpath-editor.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/img/jsonpath-editor.png rename to docs/extensibility/event-triggers/img/jsonpath-editor.png diff --git a/products/idn/docs/identity-now/event-triggers/img/slack-workflow.png b/docs/extensibility/event-triggers/img/slack-workflow.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/img/slack-workflow.png rename to docs/extensibility/event-triggers/img/slack-workflow.png diff --git a/products/idn/docs/identity-now/event-triggers/img/test-subscription.png b/docs/extensibility/event-triggers/img/test-subscription.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/img/test-subscription.png rename to docs/extensibility/event-triggers/img/test-subscription.png diff --git a/products/idn/docs/identity-now/event-triggers/img/ui-filter.png b/docs/extensibility/event-triggers/img/ui-filter.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/img/ui-filter.png rename to docs/extensibility/event-triggers/img/ui-filter.png diff --git a/products/idn/docs/identity-now/event-triggers/img/webhook-site.png b/docs/extensibility/event-triggers/img/webhook-site.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/img/webhook-site.png rename to docs/extensibility/event-triggers/img/webhook-site.png diff --git a/products/idn/docs/identity-now/event-triggers/img/what-are-triggers.png b/docs/extensibility/event-triggers/img/what-are-triggers.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/img/what-are-triggers.png rename to docs/extensibility/event-triggers/img/what-are-triggers.png diff --git a/products/idn/docs/identity-now/event-triggers/img/zapier-webhook.png b/docs/extensibility/event-triggers/img/zapier-webhook.png similarity index 100% rename from products/idn/docs/identity-now/event-triggers/img/zapier-webhook.png rename to docs/extensibility/event-triggers/img/zapier-webhook.png diff --git a/products/idn/docs/identity-now/event-triggers/index.md b/docs/extensibility/event-triggers/index.md similarity index 73% rename from products/idn/docs/identity-now/event-triggers/index.md rename to docs/extensibility/event-triggers/index.md index 97bce895a..5f7e944dd 100644 --- a/products/idn/docs/identity-now/event-triggers/index.md +++ b/docs/extensibility/event-triggers/index.md @@ -6,14 +6,14 @@ sidebar_label: Event Triggers sidebar_position: 3 sidebar_class_name: eventTriggers keywords: ['event', 'triggers', 'webhooks'] -description: The result of any action performed in a service is called an event. Services like IdentityNow constantly generate events like an update to a setting or the completion of an account aggregation. -slug: /docs/event-triggers +description: Actions triggered by specific events. +slug: /extensibility/event-triggers tags: ['Event Triggers'] --- ## What Are Triggers -The result of any action performed in a service is called an **event**. Services like IdentityNow constantly generate events like an update to a setting or the completion of an account aggregation. Most events a service generates are of little value to clients, so services create event triggers, also known as web hooks, that allow clients to subscribe to specific events they are interested in. Similar to news letters or RSS feeds, each subscription tells the service what event a client is interested in and where to send the client the notification. +The result of any action performed in a service is called an **event**. Services like Identity Security Cloud constantly generate events like an update to a setting or the completion of an account aggregation. Most events a service generates are of little value to clients, so services create event triggers, also known as web hooks, that allow clients to subscribe to specific events they are interested in. Similar to news letters or RSS feeds, each subscription tells the service what event a client is interested in and where to send the client the notification. ## How Are Triggers Different from APIs diff --git a/products/idn/docs/identity-now/event-triggers/preparing-a-subscriber-service.md b/docs/extensibility/event-triggers/preparing-a-subscriber-service.md similarity index 93% rename from products/idn/docs/identity-now/event-triggers/preparing-a-subscriber-service.md rename to docs/extensibility/event-triggers/preparing-a-subscriber-service.md index 3b657f2aa..2ee818473 100644 --- a/products/idn/docs/identity-now/event-triggers/preparing-a-subscriber-service.md +++ b/docs/extensibility/event-triggers/preparing-a-subscriber-service.md @@ -7,7 +7,7 @@ sidebar_position: 2 sidebar_class_name: preparingSubscriberService keywords: ['event', 'triggers', 'subscriber'] description: Before you can subscribe to an event trigger, you must prepare a service that can accept incoming HTTP requests from the event trigger service. -slug: /docs/event-triggers/preparing-subscriber-service +slug: /extensibility/event-triggers/preparing-subscriber-service tags: ['Event Triggers'] --- @@ -15,7 +15,7 @@ Before you can subscribe to an event trigger, you must prepare a service that ca ## Webhook Testing Service -There are many webhook testing websites that generate a unique URL you can use to subscribe to an event trigger and explore the data sent by the trigger. One site is https://webhook.site. This site generates a unique URL whenever you open it, which you can copy and paste into the subscription configuration in IdentityNow. Any events that the trigger generates will be sent to this website for you to analyze. +There are many webhook testing websites that generate a unique URL you can use to subscribe to an event trigger and explore the data sent by the trigger. One site is https://webhook.site. This site generates a unique URL whenever you open it, which you can copy and paste into the subscription configuration in Identity Security Cloud. Any events that the trigger generates will be sent to this website for you to analyze. ![Webhook.site](./img/webhook-site.png) diff --git a/products/idn/docs/identity-now/event-triggers/responding-to-a-request-response-trigger.mdx b/docs/extensibility/event-triggers/responding-to-a-request-response-trigger.mdx similarity index 95% rename from products/idn/docs/identity-now/event-triggers/responding-to-a-request-response-trigger.mdx rename to docs/extensibility/event-triggers/responding-to-a-request-response-trigger.mdx index fc2d36c54..5a7acd65f 100644 --- a/products/idn/docs/identity-now/event-triggers/responding-to-a-request-response-trigger.mdx +++ b/docs/extensibility/event-triggers/responding-to-a-request-response-trigger.mdx @@ -7,7 +7,7 @@ sidebar_position: 6 sidebar_class_name: respondingResponseRequiredTriggers keywords: ['event', 'trigger', 'request_response'] description: Specify how your application interacts with response required type trigger services. -slug: /docs/event-triggers/responding-request-response-trigger +slug: /extensibility/event-triggers/responding-request-response-trigger tags: ['Event Triggers'] --- @@ -190,4 +190,4 @@ POST `https://{tenant}.api.identitynow.com/beta/trigger-invocations/e9103ca9-02c ## Trigger invocation status -To check the status of a particular trigger invocation, you can use the [list invocation statuses](/idn/api/beta/list-trigger-invocation-status) endpoint. The status endpoint works for both `REQUEST_RESPONSE` and `FIRE_AND_FORGET` triggers. However, the status of `FIRE_AND_FORGET` trigger invocations will contain null values in their `completeInvocationInput` since `FIRE_AND_FORGET` triggers don't need a response to complete. +To check the status of a particular trigger invocation, you can use the [list invocation statuses](/docs/api/beta/list-trigger-invocation-status) endpoint. The status endpoint works for both `REQUEST_RESPONSE` and `FIRE_AND_FORGET` triggers. However, the status of `FIRE_AND_FORGET` trigger invocations will contain null values in their `completeInvocationInput` since `FIRE_AND_FORGET` triggers don't need a response to complete. diff --git a/products/idn/docs/identity-now/event-triggers/subscribing-to-a-trigger.md b/docs/extensibility/event-triggers/subscribing-to-a-trigger.md similarity index 54% rename from products/idn/docs/identity-now/event-triggers/subscribing-to-a-trigger.md rename to docs/extensibility/event-triggers/subscribing-to-a-trigger.md index 2a7a19a56..41fe3b182 100644 --- a/products/idn/docs/identity-now/event-triggers/subscribing-to-a-trigger.md +++ b/docs/extensibility/event-triggers/subscribing-to-a-trigger.md @@ -6,25 +6,25 @@ sidebar_label: Subscribing to a Trigger sidebar_position: 3 sidebar_class_name: subscribingToTrigger keywords: ['event', 'trigger', 'subscribing'] -description: Usually, you will subscribe to event triggers using the user interface in IDN. Refer to subscribing to event triggers to learn how to subscribe to an event trigger through the IDN UI. -slug: /docs/event-triggers/subscribing-to-trigger +description: Usually, you will subscribe to event triggers using the user interface in ISC. Refer to subscribing to event triggers to learn how to subscribe to an event trigger through the ISC UI. +slug: /extensibility/event-triggers/subscribing-to-trigger tags: ['Event Triggers'] --- ## View the Available Triggers -SailPoint is continuously developing new event triggers to satisfy different use cases. Some of these triggers are considered **early access** and are only available in an IDN tenant upon request. To see a list of available event triggers in your tenant, go to the **Event Triggers** tab in the **Admin** section of IdentityNow. The first page is a list of your tenant's available event triggers. You can select each trigger to learn more about its type, what causes it to fire, and what the payload will look like. +SailPoint is continuously developing new event triggers to satisfy different use cases. Some of these triggers are considered **early access** and are only available in an ISC tenant upon request. To see a list of available event triggers in your tenant, go to the **Event Triggers** tab in the **Admin** section of Identity Security Cloud. The first page is a list of your tenant's available event triggers. You can select each trigger to learn more about its type, what causes it to fire, and what the payload will look like. ![Available triggers](./img/available-triggers.png) ## Subscribe to a Trigger from the UI -Usually, you will subscribe to event triggers using the user interface in IDN. Refer to [subscribing to event triggers](https://documentation.sailpoint.com/saas/help/common/event_triggers.html#subscribing-to-event-triggers) to learn how to subscribe to an event trigger through the IDN UI. +Usually, you will subscribe to event triggers using the user interface in ISC. Refer to [subscribing to event triggers](https://documentation.sailpoint.com/saas/help/common/event_triggers.html#subscribing-to-event-triggers) to learn how to subscribe to an event trigger through the ISC UI. ## Subscribe to a Trigger from the API Sometimes, you may need to use the API to subscribe to event triggers. This can occur when you want to programatically subscribe/unsubscribe from event triggers in a custom application or no-code solution that does not have a native integration with SailPoint. -If this is your first time calling a SailPoint API, refer to the [getting started guide](../../../api/getting-started.md) to learn how to generate a token and call the APIs. +If this is your first time calling a SailPoint API, refer to the [getting started guide](../../api/getting-started.md) to learn how to generate a token and call the APIs. -Start by reviewing the list of [available event triggers](/idn/api/beta/triggers#available-event-triggers), and take note of the **ID** of the trigger you want to subscribe to (ex `idn:access-request-dynamic-approver`). Use the [create subscription](/idn/api/beta/create-subscription) endpoint to subscribe to an event trigger of your choosing. See the API docs for the latest details about how to craft a subscription request. +Start by reviewing the list of [available event triggers](/docs/api/beta/triggers#available-event-triggers), and take note of the **ID** of the trigger you want to subscribe to (ex `idn:access-request-dynamic-approver`). Use the [create subscription](/docs/api/beta/create-subscription) endpoint to subscribe to an event trigger of your choosing. See the API docs for the latest details about how to craft a subscription request. diff --git a/products/idn/docs/identity-now/event-triggers/testing-triggers.md b/docs/extensibility/event-triggers/testing-triggers.md similarity index 92% rename from products/idn/docs/identity-now/event-triggers/testing-triggers.md rename to docs/extensibility/event-triggers/testing-triggers.md index d74164e13..742e4cefa 100644 --- a/products/idn/docs/identity-now/event-triggers/testing-triggers.md +++ b/docs/extensibility/event-triggers/testing-triggers.md @@ -7,7 +7,7 @@ sidebar_position: 5 sidebar_class_name: testingTriggers keywords: ['event', 'trigger', 'testing'] description: It is important to test your trigger subscription configuration with your actual subscribing service before enabling your subscription for production use. -slug: /docs/event-triggers/testing-triggers +slug: /extensibility/event-triggers/testing-triggers tags: ['Event Triggers'] --- @@ -21,7 +21,7 @@ The easiest way to send a test event to your subscribing service is to use the * Doing so sends a test event to your subscribing service, using the default example payload for the specific trigger you are subscribing to. This is an easy way to validate that your service can receive events, but it lacks the ability to modify the event payload to test your filter against different payloads. However, there is an API endpoint you can use to modify the test payload. -If you want to control the test input to validate your filter against a more robust set of data, you can use the [test invocation](/idn/api/beta/start-test-trigger-invocation) API endpoint. You can use this API to send an input payload with any values that you want. This is an example of an invocation of this API: +If you want to control the test input to validate your filter against a more robust set of data, you can use the [test invocation](/docs/api/beta/start-test-trigger-invocation) API endpoint. You can use this API to send an input payload with any values that you want. This is an example of an invocation of this API: ```text POST `https://{tenant}.api.identitynow.com/beta/trigger-invocations/test` @@ -69,7 +69,7 @@ Check the **Created** date with the time you sent the test events. If they are b ![debug connection](./img/debug-connection.png) -You can also view the activity log by using the [list latest invocation statuses](/idn/api/beta/list-trigger-invocation-status) endpoint. +You can also view the activity log by using the [list latest invocation statuses](/docs/api/beta/list-trigger-invocation-status) endpoint. ### Filter Issues diff --git a/products/idn/docs/identity-now/event-triggers/trigger-types.md b/docs/extensibility/event-triggers/trigger-types.md similarity index 97% rename from products/idn/docs/identity-now/event-triggers/trigger-types.md rename to docs/extensibility/event-triggers/trigger-types.md index 447c7a5ff..4301f8de1 100644 --- a/products/idn/docs/identity-now/event-triggers/trigger-types.md +++ b/docs/extensibility/event-triggers/trigger-types.md @@ -7,7 +7,7 @@ sidebar_position: 1 sidebar_class_name: triggerTypes keywords: ['event', 'trigger', 'types'] description: These are the different trigger types you can use. -slug: /docs/event-triggers/trigger-types +slug: /extensibility/event-triggers/trigger-types tags: ['Event Triggers'] --- diff --git a/products/idn/docs/identity-now/img/sp-config-export.png b/docs/extensibility/img/sp-config-export.png similarity index 100% rename from products/idn/docs/identity-now/img/sp-config-export.png rename to docs/extensibility/img/sp-config-export.png diff --git a/products/idn/docs/identity-now/img/sp-config-import.png b/docs/extensibility/img/sp-config-import.png similarity index 100% rename from products/idn/docs/identity-now/img/sp-config-import.png rename to docs/extensibility/img/sp-config-import.png diff --git a/docs/extensibility/rules/_category_.json b/docs/extensibility/rules/_category_.json new file mode 100644 index 000000000..9c10c2cb2 --- /dev/null +++ b/docs/extensibility/rules/_category_.json @@ -0,0 +1,5 @@ +{ + "customProps": { + "description": "Advanced configurations with custom logic." + } +} \ No newline at end of file diff --git a/products/idn/docs/identity-now/rules/cloud-rules/account_profile_attribute_generator.md b/docs/extensibility/rules/cloud-rules/account_profile_attribute_generator.md similarity index 88% rename from products/idn/docs/identity-now/rules/cloud-rules/account_profile_attribute_generator.md rename to docs/extensibility/rules/cloud-rules/account_profile_attribute_generator.md index a2db8614c..9d1784263 100644 --- a/products/idn/docs/identity-now/rules/cloud-rules/account_profile_attribute_generator.md +++ b/docs/extensibility/rules/cloud-rules/account_profile_attribute_generator.md @@ -6,7 +6,7 @@ sidebar_label: Account Profile Attribute Generator sidebar_class_name: accountProfileAttributeGenerator keywords: ['cloud', 'rules', 'account profile', 'attribute generator'] description: This rule generates complex account attribute values during provisioning, e.g. when creating an account. -slug: /docs/rules/cloud-rules/account-profile-attribute-generator +slug: /extensibility/rules/cloud-rules/account-profile-attribute-generator tags: ['Rules'] --- @@ -16,7 +16,7 @@ This rule generates complex account attribute values during provisioning, e.g. w ## Execution -- **Cloud Execution** - This rule executes in the IdentityNow cloud, and it has read-only access to IdentityNow data models, but it does not have access to on-premise sources or connectors. +- **Cloud Execution** - This rule executes in the Identity Security Cloud cloud, and it has read-only access to Identity Security Cloud data models, but it does not have access to on-premise sources or connectors. - **Logging** - Logging statements are currently only visible to SailPoint personnel. ![Rule Execution](../img/cloud_execution.png) @@ -26,7 +26,7 @@ This rule generates complex account attribute values during provisioning, e.g. w | Argument | Type | Purpose | | --- | --- | --- | | log | org.apache.log4j.Logger | Logger to log statements. _Note: This executes in the cloud, and logging is currently not exposed to anyone other than SailPoint._ | -| idn | sailpoint.server.IdnRuleUtil | Provides a read-only starting point for using the SailPoint API. From this passed reference, the rule can interrogate the IdentityNow data model including identities or account information via helper methods as described in [IdnRuleUtil](../idn_rule_utility.md). | +| idn | sailpoint.server.IdnRuleUtil | Provides a read-only starting point for using the SailPoint API. From this passed reference, the rule can interrogate the Identity Security Cloud data model including identities or account information via helper methods as described in [IdnRuleUtil](../idn_rule_utility.md). | | identity | sailpoint.object.Identity | Reference to identity object representing the identity being calculated. | | application | sailpoint.object.Application | Read-only reference to application object that represents the source to which provisioning is being done. | | field | sailpoint.object.Field | Field object used to get information about the attribute being generated. | diff --git a/products/idn/docs/identity-now/rules/cloud-rules/account_profile_attribute_generator_from_template.md b/docs/extensibility/rules/cloud-rules/account_profile_attribute_generator_from_template.md similarity index 89% rename from products/idn/docs/identity-now/rules/cloud-rules/account_profile_attribute_generator_from_template.md rename to docs/extensibility/rules/cloud-rules/account_profile_attribute_generator_from_template.md index 2918bb2db..4e4043a4b 100644 --- a/products/idn/docs/identity-now/rules/cloud-rules/account_profile_attribute_generator_from_template.md +++ b/docs/extensibility/rules/cloud-rules/account_profile_attribute_generator_from_template.md @@ -6,7 +6,7 @@ sidebar_label: Account Profile Attribute Generator (from Template) sidebar_class_name: accountProfileAttributeGeneratorTemplate keywords: ['cloud', 'rules', 'account profile', 'attribute generator'] description: This rule generates complex account attribute values during provisioning, e.g. when creating an account. The rule's configuration comes from a template of values. -slug: /docs/rules/cloud-rules/account-profile-attribute-generator-template +slug: /extensibility/rules/cloud-rules/account-profile-attribute-generator-template tags: ['Rules'] --- @@ -41,7 +41,7 @@ In the following example, the template is `${firstname}.${lastname}${uniqueCount ## Execution -- **Cloud Execution** - This rule executes in the IdentityNow cloud, and it has read-only access to IdentityNow data models, but it does not have access to on-premise sources or connectors. +- **Cloud Execution** - This rule executes in the Identity Security Cloud cloud, and it has read-only access to Identity Security Cloud data models, but it does not have access to on-premise sources or connectors. - **Logging** - Logging statements are currently only visible to SailPoint personnel. ![Rule Execution](../img/cloud_execution.png) @@ -51,7 +51,7 @@ In the following example, the template is `${firstname}.${lastname}${uniqueCount | Argument | Type | Purpose | | --- | --- | --- | | log | org.apache.log4j.Logger | Logger to log statements. _Note: This executes in the cloud, and logging is currently not exposed to anyone other than SailPoint._ | -| idn | sailpoint.server.IdnRuleUtil | Provides a read-only starting point for using the SailPoint API. From this passed reference, the rule can interrogate the IdentityNow data model including identities or account information via helper methods as described in [IdnRuleUtil](../idn_rule_utility.md). | +| idn | sailpoint.server.IdnRuleUtil | Provides a read-only starting point for using the SailPoint API. From this passed reference, the rule can interrogate the Identity Security Cloud data model including identities or account information via helper methods as described in [IdnRuleUtil](../idn_rule_utility.md). | | identity | sailpoint.object.Identity | Reference to identity object representing the identity being calculated. | | field | sailpoint.object.Field | Field object used to get information about the attribute being generated. | diff --git a/products/idn/docs/identity-now/rules/cloud-rules/before_provisioning_rule.md b/docs/extensibility/rules/cloud-rules/before_provisioning_rule.md similarity index 86% rename from products/idn/docs/identity-now/rules/cloud-rules/before_provisioning_rule.md rename to docs/extensibility/rules/cloud-rules/before_provisioning_rule.md index 04934e4f2..dcffd7bd1 100644 --- a/products/idn/docs/identity-now/rules/cloud-rules/before_provisioning_rule.md +++ b/docs/extensibility/rules/cloud-rules/before_provisioning_rule.md @@ -6,7 +6,7 @@ sidebar_label: Before Provisioning Rule sidebar_class_name: beforeProvisioningRule keywords: ['cloud', 'rules', 'before provisioning'] description: This rule runs before provisioning to a source. -slug: /docs/rules/cloud-rules/before-provisioning-rule +slug: /extensibility/rules/cloud-rules/before-provisioning-rule tags: ['Rules'] --- @@ -22,7 +22,7 @@ These are some examples of when to use this rule: ## Execution -- **Cloud Execution** - This rule executes in the IdentityNow cloud, and it has read-only access to IdentityNow data models, but it does not have access to on-premise sources or connectors. +- **Cloud Execution** - This rule executes in the Identity Security Cloud cloud, and it has read-only access to Identity Security Cloud data models, but it does not have access to on-premise sources or connectors. - **Logging** - Logging statements are currently only visible to SailPoint personnel. ![Rule Execution](../img/cloud_execution.png) @@ -32,7 +32,7 @@ These are some examples of when to use this rule: | Argument | Type | Purpose | | --- | --- | --- | | log | org.apache.log4j.Logger | Logger to log statements. _Note: This executes in the cloud, and logging is currently not exposed to anyone other than SailPoint._ | -| idn | sailpoint.server.IdnRuleUtil | Provides a read-only starting point for using the SailPoint API. From this passed reference, the rule can interrogate the IdentityNow data model including identities or account information via helper methods as described in [IdnRuleUtil](../idn_rule_utility.md). | +| idn | sailpoint.server.IdnRuleUtil | Provides a read-only starting point for using the SailPoint API. From this passed reference, the rule can interrogate the Identity Security Cloud data model including identities or account information via helper methods as described in [IdnRuleUtil](../idn_rule_utility.md). | | plan | sailpoint.object.ProvisioningPlan | A set of provisioning instructions which are sent to the source connectors. | | application | sailpoint.object.Application | Read-only reference to application object that represents the source to which provisioning is being done. | diff --git a/products/idn/docs/identity-now/rules/cloud-rules/build_map_rule.md b/docs/extensibility/rules/cloud-rules/build_map_rule.md similarity index 89% rename from products/idn/docs/identity-now/rules/cloud-rules/build_map_rule.md rename to docs/extensibility/rules/cloud-rules/build_map_rule.md index 48035f063..9957a869b 100644 --- a/products/idn/docs/identity-now/rules/cloud-rules/build_map_rule.md +++ b/docs/extensibility/rules/cloud-rules/build_map_rule.md @@ -6,7 +6,7 @@ sidebar_label: BuildMap Rule sidebar_class_name: buildMapRule keywords: ['cloud', 'rules'] description: This rule manipulates raw input data provided by the rows and columns in a file and builds a map from the incoming data. -slug: /docs/rules/cloud-rules/buildmap-rule +slug: /extensibility/rules/cloud-rules/buildmap-rule tags: ['Rules'] --- @@ -22,7 +22,7 @@ This rule runs in the cloud, but it's really a connector rule because it execute ## Execution -- **Cloud Execution** - This rule executes in the IdentityNow cloud, and has read-only access to the records from the Delimited File being imported. However, it doesn't have access to on-premise sources or connectors. +- **Cloud Execution** - This rule executes in the Identity Security Cloud cloud, and has read-only access to the records from the Delimited File being imported. However, it doesn't have access to on-premise sources or connectors. - **Logging** - Logging statements are currently only visible to SailPoint personnel. ![Rule Execution](../img/cloud_execution.png) diff --git a/products/idn/docs/identity-now/rules/cloud-rules/correlation_rule.md b/docs/extensibility/rules/cloud-rules/correlation_rule.md similarity index 84% rename from products/idn/docs/identity-now/rules/cloud-rules/correlation_rule.md rename to docs/extensibility/rules/cloud-rules/correlation_rule.md index bfaf265f6..2d2e0f1cd 100644 --- a/products/idn/docs/identity-now/rules/cloud-rules/correlation_rule.md +++ b/docs/extensibility/rules/cloud-rules/correlation_rule.md @@ -6,7 +6,7 @@ sidebar_label: Correlation Rule sidebar_class_name: Correlation Rule keywords: ['cloud', 'rules', 'correlation'] description: This rule associates or correlates an account to an identity, based on complex logic. -slug: /docs/rules/cloud-rules/correlation-rule +slug: /extensibility/rules/cloud-rules/correlation-rule tags: ['Rules'] --- @@ -16,7 +16,7 @@ This rule associates or correlates an account to an identity, based on complex l ## Execution -- **Cloud Execution** - This rule executes in the IdentityNow cloud, and it has read-only access to IdentityNow data models, but it does not have access to on-premise sources or connectors. +- **Cloud Execution** - This rule executes in the Identity Security Cloud cloud, and it has read-only access to Identity Security Cloud data models, but it does not have access to on-premise sources or connectors. - **Logging** - Logging statements are currently only visible to SailPoint personnel. ![Rule Execution](../img/cloud_execution.png) @@ -26,7 +26,7 @@ This rule associates or correlates an account to an identity, based on complex l | Argument | Type | Purpose | | --- | --- | --- | | log | org.apache.log4j.Logger | Logger to log statements. _Note: This executes in the cloud, and logging is currently not exposed to anyone other than SailPoint._ | -| idn | sailpoint.server.IdnRuleUtil | Provides a read-only starting point for using the SailPoint API. From this passed reference, the rule can interrogate the IdentityNow data model including identities or account information via helper methods as described in [IdnRuleUtil](../idn_rule_utility.md). | +| idn | sailpoint.server.IdnRuleUtil | Provides a read-only starting point for using the SailPoint API. From this passed reference, the rule can interrogate the Identity Security Cloud data model including identities or account information via helper methods as described in [IdnRuleUtil](../idn_rule_utility.md). | | account | sailpoint.object.ResourceObject | Read-only representation of account data that has been aggregated. Use this as a basis to determine correlation linkages with a specific identity. | | application | sailpoint.object.Application | Read-only reference to application object that represents the source to which account correlation is being done. | diff --git a/products/idn/docs/identity-now/rules/cloud-rules/generic_rule.md b/docs/extensibility/rules/cloud-rules/generic_rule.md similarity index 92% rename from products/idn/docs/identity-now/rules/cloud-rules/generic_rule.md rename to docs/extensibility/rules/cloud-rules/generic_rule.md index 9dc928548..3496544dc 100644 --- a/products/idn/docs/identity-now/rules/cloud-rules/generic_rule.md +++ b/docs/extensibility/rules/cloud-rules/generic_rule.md @@ -6,7 +6,7 @@ sidebar_label: Generic Rule sidebar_class_name: Generic Rule keywords: ['cloud', 'rules', 'generic'] description: This rule performs transforms. -slug: /docs/rules/cloud-rules/generic-rule +slug: /extensibility/rules/cloud-rules/generic-rule tags: ['Rules'] --- @@ -45,7 +45,7 @@ return result[index]; ## Execution -- **Cloud Execution** - This rule executes in the IdentityNow cloud, and it has read-only access to IdentityNow data models, but it does not have access to on-premise sources or connectors. +- **Cloud Execution** - This rule executes in the Identity Security Cloud cloud, and it has read-only access to Identity Security Cloud data models, but it does not have access to on-premise sources or connectors. - **Logging** - Logging statements are currently only visible to SailPoint personnel. ![Rule Execution](../img/cloud_execution.png) @@ -55,7 +55,7 @@ return result[index]; | Argument | Type | Purpose | | --- | --- | --- | | log | org.apache.log4j.Logger | Logger to log statements. _Note: This executes in the cloud, and logging is currently not exposed to anyone other than SailPoint._ | -| idn | sailpoint.server.IdnRuleUtil | Provides a read-only starting point for using the SailPoint API. From this passed reference, the rule can interrogate the IdentityNow data model including identities or account information via helper methods as described in [IdnRuleUtil](../idn_rule_utility.md). | +| idn | sailpoint.server.IdnRuleUtil | Provides a read-only starting point for using the SailPoint API. From this passed reference, the rule can interrogate the Identity Security Cloud data model including identities or account information via helper methods as described in [IdnRuleUtil](../idn_rule_utility.md). | ## Output diff --git a/products/idn/docs/identity-now/rules/cloud-rules/identity_attribute_rule.md b/docs/extensibility/rules/cloud-rules/identity_attribute_rule.md similarity index 73% rename from products/idn/docs/identity-now/rules/cloud-rules/identity_attribute_rule.md rename to docs/extensibility/rules/cloud-rules/identity_attribute_rule.md index 76c51b5f7..37627437f 100644 --- a/products/idn/docs/identity-now/rules/cloud-rules/identity_attribute_rule.md +++ b/docs/extensibility/rules/cloud-rules/identity_attribute_rule.md @@ -6,7 +6,7 @@ sidebar_label: Identity Attribute Rule sidebar_class_name: identityAttributeRule keywords: ['cloud', 'rules', 'identity attribute'] description: This rule calculates and returns an identity attribute for a specific identity. -slug: /docs/rules/cloud-rules/identity-attribute-rule +slug: /extensibility/rules/cloud-rules/identity-attribute-rule tags: ['Rules'] --- @@ -16,11 +16,11 @@ tags: ['Rules'] This rule calculates and returns an identity attribute for a specific identity. This rule is known as a "complex" rule on the identity profile. -An important consideration with IdentityAttribute rules is whether generation logic that includes uniqueness checks is acceptable. While not explicitly disallowed, this type of logic is firmly against SailPoint's [best practices](https://community.sailpoint.com/t5/IdentityNow-Articles/Best-Practices-Generating-Usernames-in-IdentityNow/ta-p/153749). When calculating and promoting identity attributes via a transform or a rule, the logic contained within the attribute is always re-run and new values might end up being generated where such behavior is not desired. Additionally, the attribute calculation process is multi-threaded, so the uniqueness logic contained on a single attribute is not always guaranteed to be accurate. For this reason, SailPoint strongly discourages the use of logic that conducts uniqueness checks within an IdentityAttribute rule. The recommendation is to execute this check during account generation for the target system where the value is needed. +An important consideration with IdentityAttribute rules is whether generation logic that includes uniqueness checks is acceptable. While not explicitly disallowed, this type of logic is firmly against SailPoint's [best practices](https://community.sailpoint.com/t5/Identity Security Cloud-Articles/Best-Practices-Generating-Usernames-in-Identity Security Cloud/ta-p/153749). When calculating and promoting identity attributes via a transform or a rule, the logic contained within the attribute is always re-run and new values might end up being generated where such behavior is not desired. Additionally, the attribute calculation process is multi-threaded, so the uniqueness logic contained on a single attribute is not always guaranteed to be accurate. For this reason, SailPoint strongly discourages the use of logic that conducts uniqueness checks within an IdentityAttribute rule. The recommendation is to execute this check during account generation for the target system where the value is needed. ## Execution -- **Cloud Execution** - This rule executes in the IdentityNow cloud, and it has read-only access to IdentityNow data models, but it does not have access to on-premise sources or connectors. +- **Cloud Execution** - This rule executes in the Identity Security Cloud cloud, and it has read-only access to Identity Security Cloud data models, but it does not have access to on-premise sources or connectors. - **Logging** - Logging statements are currently only visible to SailPoint personnel. - **Usage** - To use this rule once installed, first select "Complex Data Source" option under the Source dropdown, then select the rule name under the Transform drop down. @@ -31,7 +31,7 @@ An important consideration with IdentityAttribute rules is whether generation lo | Argument | Type | Purpose | | --- | --- | --- | | log | org.apache.log4j.Logger | Logger to log statements. _Note: This executes in the cloud, and logging is currently not exposed to anyone other than SailPoint._ | -| idn | sailpoint.server.IdnRuleUtil | Provides a read-only starting point for using the SailPoint API. From this passed reference, the rule can interrogate the IdentityNow data model including identities or account information via helper methods as described in [IdnRuleUtil](../idn_rule_utility.md). | +| idn | sailpoint.server.IdnRuleUtil | Provides a read-only starting point for using the SailPoint API. From this passed reference, the rule can interrogate the Identity Security Cloud data model including identities or account information via helper methods as described in [IdnRuleUtil](../idn_rule_utility.md). | | identity | sailpoint.object.Identity | Reference to identity object representing the identity being calculated. | | oldValue | java.lang.Object | Attribute value for the identity attribute before the rule runs. | diff --git a/products/idn/docs/identity-now/rules/cloud-rules/index.md b/docs/extensibility/rules/cloud-rules/index.md similarity index 96% rename from products/idn/docs/identity-now/rules/cloud-rules/index.md rename to docs/extensibility/rules/cloud-rules/index.md index c5dfe93cf..9897ac30c 100644 --- a/products/idn/docs/identity-now/rules/cloud-rules/index.md +++ b/docs/extensibility/rules/cloud-rules/index.md @@ -7,7 +7,7 @@ sidebar_position: 2 sidebar_class_name: cloudExecutedRules keywords: ['cloud', 'rules'] description: Overview of cloud-executed rules -slug: /docs/rules/cloud-rules +slug: /extensibility/rules/cloud-rules tags: ['Rules'] --- @@ -93,7 +93,7 @@ Once you have submitted your rule and you are in the review process, remember th - **Timing:** SailPoint will examine your rule as soon as possible. Most rules are reviewed within 24 hours of submission. However, if your rule is complex, poorly documented, hard to read, or if it presents new issues, it may require greater scrutiny and consideration. If your rule is repeatedly rejected for the same guideline violation, your rule's review may take longer to complete. - **Status Updates:** Your rule's current status will be reflected in your [SailPoint Expert Services request](https://www.sailpoint.com/services/professional/#contact-form), so you can monitor its progress there. - **Expedite Requests:** If you have a critical timing issue, you can request an expedited review. Respect your fellow implementers by seeking expedited review only when you truly need it. If you are found to be abusing this system, SailPoint may reject further requests going forward. -- **Rejections:** SailPoint's goal is to apply these guidelines fairly and consistently, but mistaken rejections can happen. If your rule has been rejected and you have questions or you would like to provide additional information, communicate directly with the rule review team. This may help get your rule into IdentityNow, and it can help SailPoint improve the process or identify a need for clarity in its policies. If you still disagree with the outcome, let SailPoint know and someone can look into it. +- **Rejections:** SailPoint's goal is to apply these guidelines fairly and consistently, but mistaken rejections can happen. If your rule has been rejected and you have questions or you would like to provide additional information, communicate directly with the rule review team. This may help get your rule into Identity Security Cloud, and it can help SailPoint improve the process or identify a need for clarity in its policies. If you still disagree with the outcome, let SailPoint know and someone can look into it. - **Changes:** Rule changes or modifications to meet guidelines are not the reviewer's responsibility. They are the responsibility of the person(s) submitting the rule. Reviewers may give advice, examples, etc. to help, but doing so does not guarantee a solution. You should test the rules with the changes before resubmission. ``` diff --git a/products/idn/docs/identity-now/rules/cloud-rules/manager_correlation_rule.md b/docs/extensibility/rules/cloud-rules/manager_correlation_rule.md similarity index 85% rename from products/idn/docs/identity-now/rules/cloud-rules/manager_correlation_rule.md rename to docs/extensibility/rules/cloud-rules/manager_correlation_rule.md index 8ea71fe5d..4b666f5e6 100644 --- a/products/idn/docs/identity-now/rules/cloud-rules/manager_correlation_rule.md +++ b/docs/extensibility/rules/cloud-rules/manager_correlation_rule.md @@ -6,7 +6,7 @@ sidebar_label: Manager Correlation Rule sidebar_class_name: managerCorrelationRule keywords: ['cloud', 'rules', 'manager correlation'] description: This rule calculates a manager relationship between identities. -slug: /docs/rules/cloud-rules/manager-correlation-rule +slug: /extensibility/rules/cloud-rules/manager-correlation-rule tags: ['Rules'] --- @@ -24,7 +24,7 @@ The manager correlation rule runs before configured manager account correlation. ## Execution -- **Cloud Execution** - This rule executes in the IdentityNow cloud, and it has read-only access to IdentityNow data models, but it does not have access to on-premise sources or connectors. +- **Cloud Execution** - This rule executes in the Identity Security Cloud cloud, and it has read-only access to Identity Security Cloud data models, but it does not have access to on-premise sources or connectors. - **Logging** - Logging statements are currently only visible to SailPoint personnel. ![Rule Execution](../img/cloud_execution.png) @@ -34,7 +34,7 @@ The manager correlation rule runs before configured manager account correlation. | Argument | Type | Purpose | | --- | --- | --- | | log | org.apache.log4j.Logger | Logger to log statements. _Note: This executes in the cloud, and logging is currently not exposed to anyone other than SailPoint._ | -| idn | sailpoint.server.IdnRuleUtil | Provides a read-only starting point for using the SailPoint API. From this passed reference, the rule can interrogate the IdentityNow data model including identities or account information via helper methods as described in [IdnRuleUtil](../idn_rule_utility.md). | +| idn | sailpoint.server.IdnRuleUtil | Provides a read-only starting point for using the SailPoint API. From this passed reference, the rule can interrogate the Identity Security Cloud data model including identities or account information via helper methods as described in [IdnRuleUtil](../idn_rule_utility.md). | | link | sailpoint.object.Link | Read-only representation of account data that has been aggregated. Use this as a basis to determine manager linkages to a specific manager identity. | | managerAttributeValue | java.lang.Object | Attribute value stored in the manager attribute. | diff --git a/products/idn/docs/identity-now/rules/connector-rules/before_after_operation_rule.md b/docs/extensibility/rules/connector-rules/before_after_operation_rule.md similarity index 98% rename from products/idn/docs/identity-now/rules/connector-rules/before_after_operation_rule.md rename to docs/extensibility/rules/connector-rules/before_after_operation_rule.md index 97ada8755..2c8a235f7 100644 --- a/products/idn/docs/identity-now/rules/connector-rules/before_after_operation_rule.md +++ b/docs/extensibility/rules/connector-rules/before_after_operation_rule.md @@ -6,7 +6,7 @@ sidebar_label: Before and After Rule Operations sidebar_class_name: beforeAndAfterRuleOperations keywords: ['cloud', 'rules'] description: This rule executes PowerShell commands on the IQService component after a source account has an operation performed on it. -slug: /docs/rules/connector-rules/before-and-after-rule-operations +slug: /extensibility/rules/connector-rules/before-and-after-rule-operations tags: ['Rules'] --- @@ -44,7 +44,7 @@ The following operations can be performed on a source: ## Architecture Best Practices -For supportability, it is recommended that you write these operation rules with only the most basic logic necessary to trigger a PowerShell script and shift the bulk of the downstream events and/or modifications to the PowerShell script itself. This script would reside on the client's servers and can therefore be easily maintained or modified by the client as needed. It also allows the client to implement changes to the PowerShell scripted functionality without requiring code review by SailPoint because the code runs outside of the IdentityNow platform. +For supportability, it is recommended that you write these operation rules with only the most basic logic necessary to trigger a PowerShell script and shift the bulk of the downstream events and/or modifications to the PowerShell script itself. This script would reside on the client's servers and can therefore be easily maintained or modified by the client as needed. It also allows the client to implement changes to the PowerShell scripted functionality without requiring code review by SailPoint because the code runs outside of the Identity Security Cloud platform. ## Rule Template diff --git a/products/idn/docs/identity-now/rules/connector-rules/index.md b/docs/extensibility/rules/connector-rules/index.md similarity index 86% rename from products/idn/docs/identity-now/rules/connector-rules/index.md rename to docs/extensibility/rules/connector-rules/index.md index 907593333..0c07ca463 100644 --- a/products/idn/docs/identity-now/rules/connector-rules/index.md +++ b/docs/extensibility/rules/connector-rules/index.md @@ -7,13 +7,13 @@ sidebar_position: 3 sidebar_class_name: cloudExecutedRules keywords: ['connector', 'rules'] description: Overview of connector-executed rules. -slug: /docs/rules/connector-rules +slug: /extensibility/rules/connector-rules tags: ['Rules'] --- -**Connector-Executed Rules** or **Connector Rules** are rules that are executed in the IdentityNow virtual appliance, and they are usually extensions of the connector itself. The rules are commonly used to perform complex connector-related functions, so they are specific to only certain connectors. Because these rules execute in the virtual appliance, they do not have access to query the IdentityNow data model or fetch information from IdentityNow. They rely instead on contextual information sent from IdentityNow. Connector-executed rules may also have managed connections provided in their contexts to support querying end systems or sources. Though these managed connections may be used, making additional connections or call-outs is not allowed. +**Connector-Executed Rules** or **Connector Rules** are rules that are executed in the Identity Security Cloud virtual appliance, and they are usually extensions of the connector itself. The rules are commonly used to perform complex connector-related functions, so they are specific to only certain connectors. Because these rules execute in the virtual appliance, they do not have access to query the Identity Security Cloud data model or fetch information from Identity Security Cloud. They rely instead on contextual information sent from Identity Security Cloud. Connector-executed rules may also have managed connections provided in their contexts to support querying end systems or sources. Though these managed connections may be used, making additional connections or call-outs is not allowed. -Unlike cloud rules, connector rules do not have a rule review process and are directly editable with the [Connector Rule REST APIs](https://developer.sailpoint.com/idn/api/beta/connector-rule-management). For more details, see [Configuration Process](#configuration-process). +Unlike cloud rules, connector rules do not have a rule review process and are directly editable with the [Connector Rule REST APIs](https://developer.sailpoint.com/docs/api/beta/connector-rule-management). For more details, see [Configuration Process](#configuration-process). ## Supported Connector Rules @@ -35,16 +35,16 @@ Unlike cloud rules, connector rules do not have a rule review process and are di ## Configuration Process -Connector Rules are directly editable with the [Connector Rule REST APIs](https://developer.sailpoint.com/idn/api/beta/connector-rule-management), which provide ability to interact with rules directly. +Connector Rules are directly editable with the [Connector Rule REST APIs](https://developer.sailpoint.com/docs/api/beta/connector-rule-management), which provide ability to interact with rules directly. | Name | Path | | --- | --- | -| [List Connector Rules](/idn/api/beta/get-connector-rule-list) | `GET /beta/connector-rules/` | -| [Get Connector Rule](/idn/api/beta/get-connector-rule) | `GET /beta/connector-rules/{id}` | -| [Create Connector Rule](/idn/api/beta/create-connector-rule) | `POST /beta/connector-rules/` | -| [Update Connector Rule](/idn/api/beta/update-connector-rule) | `PUT /beta/connector-rules/{id}` | -| [Delete Connector Rule](/idn/api/beta/delete-connector-rule) | `DELETE /beta/connector-rules/{id}` | -| [Validate Connector Rule](/idn/api/beta/validate-connector-rule) | `POST /beta/connector-rules/validate` | +| [List Connector Rules](/docs/api/beta/get-connector-rule-list) | `GET /beta/connector-rules/` | +| [Get Connector Rule](/docs/api/beta/get-connector-rule) | `GET /beta/connector-rules/{id}` | +| [Create Connector Rule](/docs/api/beta/create-connector-rule) | `POST /beta/connector-rules/` | +| [Update Connector Rule](/docs/api/beta/update-connector-rule) | `PUT /beta/connector-rules/{id}` | +| [Delete Connector Rule](/docs/api/beta/delete-connector-rule) | `DELETE /beta/connector-rules/{id}` | +| [Validate Connector Rule](/docs/api/beta/validate-connector-rule) | `POST /beta/connector-rules/validate` | SailPoint architectural optimizations have added resiliency and protections against malformed or long-running rules. These APIs also offer built-in protection and checking against potentially harmful code. For more information, see [Rule Code Restrictions](../../rules/index.md#rule-code-restrictions). diff --git a/products/idn/docs/identity-now/rules/connector-rules/jdbc_build_map_rule.md b/docs/extensibility/rules/connector-rules/jdbc_build_map_rule.md similarity index 97% rename from products/idn/docs/identity-now/rules/connector-rules/jdbc_build_map_rule.md rename to docs/extensibility/rules/connector-rules/jdbc_build_map_rule.md index fa937030e..19b184a77 100644 --- a/products/idn/docs/identity-now/rules/connector-rules/jdbc_build_map_rule.md +++ b/docs/extensibility/rules/connector-rules/jdbc_build_map_rule.md @@ -6,7 +6,7 @@ sidebar_label: JDBC BuildMap Rule sidebar_class_name: jdbcBuildMapRule keywords: ['cloud', 'rules'] description: This rule manipulates raw input data provided by the rows and columns in a file and builds a map from the incoming data. -slug: /docs/rules/connector-rules/jdbc-buildmap-rule +slug: /extensibility/rules/connector-rules/jdbc-buildmap-rule tags: ['Rules'] --- diff --git a/products/idn/docs/identity-now/rules/connector-rules/jdbc_provision_rule.md b/docs/extensibility/rules/connector-rules/jdbc_provision_rule.md similarity index 99% rename from products/idn/docs/identity-now/rules/connector-rules/jdbc_provision_rule.md rename to docs/extensibility/rules/connector-rules/jdbc_provision_rule.md index 2019881c5..a197c199d 100644 --- a/products/idn/docs/identity-now/rules/connector-rules/jdbc_provision_rule.md +++ b/docs/extensibility/rules/connector-rules/jdbc_provision_rule.md @@ -6,7 +6,7 @@ sidebar_label: JDBC Provision Rule sidebar_class_name: jdbcProvisionRule keywords: ['cloud', 'rules', 'jdbc'] description: This rule performs provisioning actions from a provisioning plan provided by a supplied JDBC connection. These actions typically issue SQL commands, such as insert, update, select, and delete. -slug: /docs/rules/connector-rules/jdbc-provisioning-rule +slug: /extensibility/rules/connector-rules/jdbc-provisioning-rule tags: ['Rules'] --- diff --git a/products/idn/docs/identity-now/rules/connector-rules/sap_buildmap_rule.md b/docs/extensibility/rules/connector-rules/sap_buildmap_rule.md similarity index 98% rename from products/idn/docs/identity-now/rules/connector-rules/sap_buildmap_rule.md rename to docs/extensibility/rules/connector-rules/sap_buildmap_rule.md index 9ba5b7540..0890eed7c 100644 --- a/products/idn/docs/identity-now/rules/connector-rules/sap_buildmap_rule.md +++ b/docs/extensibility/rules/connector-rules/sap_buildmap_rule.md @@ -6,7 +6,7 @@ sidebar_label: SAP BuildMap Rule sidebar_class_name: sapBuildMapRule keywords: ['cloud', 'rules', 'sap'] description: This rule gathers additional attributes from SAP systems to build accounts. This rule is implemented using SAP's Java Connector (JCo) framework provided by a supplied SAP connection. -slug: /docs/rules/connector-rules/sap-buildmap-rule +slug: /extensibility/rules/connector-rules/sap-buildmap-rule tags: ['Rules'] --- diff --git a/products/idn/docs/identity-now/rules/connector-rules/sap_hr_provisioning_modify_rule.md b/docs/extensibility/rules/connector-rules/sap_hr_provisioning_modify_rule.md similarity index 99% rename from products/idn/docs/identity-now/rules/connector-rules/sap_hr_provisioning_modify_rule.md rename to docs/extensibility/rules/connector-rules/sap_hr_provisioning_modify_rule.md index 2fe909fad..b40d4b48e 100644 --- a/products/idn/docs/identity-now/rules/connector-rules/sap_hr_provisioning_modify_rule.md +++ b/docs/extensibility/rules/connector-rules/sap_hr_provisioning_modify_rule.md @@ -6,7 +6,7 @@ sidebar_label: SAP HR Provisioning Modify Rule sidebar_class_name: sapHRProvisioningModifyRule keywords: ['cloud', 'rules', 'sap'] description: This rule performs SAP HR modification operations during provisioning. This rule is typically used for attribute sync to custom SAP HR attributes. -slug: /docs/rules/connector-rules/sap-provisioning-modify-rule +slug: /extensibility/rules/connector-rules/sap-provisioning-modify-rule tags: ['Rules'] --- diff --git a/products/idn/docs/identity-now/rules/connector-rules/web_services_after_operation_rule.md b/docs/extensibility/rules/connector-rules/web_services_after_operation_rule.md similarity index 98% rename from products/idn/docs/identity-now/rules/connector-rules/web_services_after_operation_rule.md rename to docs/extensibility/rules/connector-rules/web_services_after_operation_rule.md index 8c2f19ca1..f40c05dc1 100644 --- a/products/idn/docs/identity-now/rules/connector-rules/web_services_after_operation_rule.md +++ b/docs/extensibility/rules/connector-rules/web_services_after_operation_rule.md @@ -6,7 +6,7 @@ sidebar_label: Web Services After Operation Rule sidebar_class_name: webServicesAfterOperationRule keywords: ['cloud', 'rules', 'webservices'] description: This rule calculates attributes after a web-service operation call. -slug: /docs/rules/connector-rules/webservices-after-provisioning-rule +slug: /extensibility/rules/connector-rules/webservices-after-provisioning-rule tags: ['Rules'] --- diff --git a/products/idn/docs/identity-now/rules/connector-rules/web_services_before_operation_rule.md b/docs/extensibility/rules/connector-rules/web_services_before_operation_rule.md similarity index 98% rename from products/idn/docs/identity-now/rules/connector-rules/web_services_before_operation_rule.md rename to docs/extensibility/rules/connector-rules/web_services_before_operation_rule.md index 9f2f2622a..e1c0651bd 100644 --- a/products/idn/docs/identity-now/rules/connector-rules/web_services_before_operation_rule.md +++ b/docs/extensibility/rules/connector-rules/web_services_before_operation_rule.md @@ -6,7 +6,7 @@ sidebar_label: Web Services Before Operation Rule sidebar_class_name: webServicesBeforeOperationRule keywords: ['cloud', 'rules', 'webservices'] description: This rule calculates attributes before a web-service operation call. -slug: /docs/rules/connector-rules/webservices-before-provisioning-rule +slug: /extensibility/rules/connector-rules/webservices-before-provisioning-rule tags: ['Rules'] --- diff --git a/products/idn/docs/identity-now/rules/guides/img/account-create.png b/docs/extensibility/rules/guides/img/account-create.png similarity index 100% rename from products/idn/docs/identity-now/rules/guides/img/account-create.png rename to docs/extensibility/rules/guides/img/account-create.png diff --git a/products/idn/docs/identity-now/rules/guides/index.md b/docs/extensibility/rules/guides/index.md similarity index 93% rename from products/idn/docs/identity-now/rules/guides/index.md rename to docs/extensibility/rules/guides/index.md index fbe78d20e..5e1d9bca2 100644 --- a/products/idn/docs/identity-now/rules/guides/index.md +++ b/docs/extensibility/rules/guides/index.md @@ -7,7 +7,7 @@ sidebar_position: 1 sidebar_class_name: Rules keywords: ['rules', 'guides'] description: Rule Guides -slug: /docs/rules/guides +slug: /extensibility/rules/guides tags: ['Rules', 'Guides'] --- diff --git a/products/idn/docs/identity-now/rules/guides/your_first_rule.md b/docs/extensibility/rules/guides/your_first_rule.md similarity index 97% rename from products/idn/docs/identity-now/rules/guides/your_first_rule.md rename to docs/extensibility/rules/guides/your_first_rule.md index 888700355..fb8bd7b06 100644 --- a/products/idn/docs/identity-now/rules/guides/your_first_rule.md +++ b/docs/extensibility/rules/guides/your_first_rule.md @@ -7,7 +7,7 @@ sidebar_class_name: yourFirstRule keywords: ['rules', 'guides', 'first'] description: Learn to build your first rule! sidebar_position: 1 -slug: /docs/rules/guides/your-first-rule +slug: /extensibility/rules/guides/your-first-rule tags: ['Rules', 'Guides', 'First'] --- @@ -25,7 +25,7 @@ In this guide you'll learn the end to end process of writing a cloud rule to gen This rule generates complex account attribute values during provisioning, e.g. when creating an account. You would typically use this rule when you are creating an account to generate attributes like usernames. -This rule executes in the IdentityNow (IDN) cloud, and it has read-only access to IDN data models, but it doesn't have access to on-premise sources or connectors. +This rule executes in the Identity Security Cloud (ISC) cloud, and it has read-only access to ISC data models, but it doesn't have access to on-premise sources or connectors. Refer to [Attribute Generator Rule](../cloud-rules/account_profile_attribute_generator.md) to learn more about the inputs available to you during the rule execution. @@ -105,7 +105,7 @@ flowchart TD ## Write the Rule -Create a new xml file with this naming scheme [rule file naming](/idn/docs/rules/cloud-rules#review-guidelines). +Create a new xml file with this naming scheme [rule file naming](/docs/extensibility/rules/cloud-rules#review-guidelines). Open that file in your preferred editor. @@ -209,7 +209,7 @@ Add a description and the necessary imports for your rule. This rule will need ` ### Logic if the Proposed Username Exceeds the Max Length -If the full name exceeds the `MAX_USERNAME_LENGTH` the rule will check whether the length of the first name is greater than the MAX_USERNAME_LENGTH minus 2 (in the case below 10) characters of the first name - this allows for the period `.` and the first character of the last name to take up the remaining two characters. If the first name is less than the `MAX_USERNAME_LENGTH` the rule will use the full first name for the username with the period `.` and the first character of the last name appended. After the username is determined, a call to `isUnique( username )` is made. This uses the IDNRuleUtil class to check Active Directory if the username exists. You will add in that function shortly. +If the full name exceeds the `MAX_USERNAME_LENGTH` the rule will check whether the length of the first name is greater than the MAX_USERNAME_LENGTH minus 2 (in the case below 10) characters of the first name - this allows for the period `.` and the first character of the last name to take up the remaining two characters. If the first name is less than the `MAX_USERNAME_LENGTH` the rule will use the full first name for the username with the period `.` and the first character of the last name appended. After the username is determined, a call to `isUnique( username )` is made. This uses the ISCRuleUtil class to check Active Directory if the username exists. You will add in that function shortly. ```java if(fullName.length() > MAX_USERNAME_LENGTH) { @@ -280,7 +280,7 @@ else{ ### Add Function `isUnique()` To Check Active Directory for Username -The `isUnique()` function takes the username as a string and uses the `accountExistsByDisplayName()` function from the IDNRuleUtil class to search Active Directory and return a true or false result, depending on whether the username is taken. The function takes an application name and username to test against. The variables `idn` and `application` are included as inputs to the attribute generator rule and are already initialized. Refer to [inputs](../cloud-rules/account_profile_attribute_generator.md#input) to see all inputs available to attribute generator rules. +The `isUnique()` function takes the username as a string and uses the `accountExistsByDisplayName()` function from the ISCRuleUtil class to search Active Directory and return a true or false result, depending on whether the username is taken. The function takes an application name and username to test against. The variables `idn` and `application` are included as inputs to the attribute generator rule and are already initialized. Refer to [inputs](../cloud-rules/account_profile_attribute_generator.md#input) to see all inputs available to attribute generator rules. ```java public boolean isUnique ( String username ) throws GeneralException { @@ -428,7 +428,7 @@ return generateUsername( identity.getFirstname(), identity.getLastname() ); Before you send the rule to the professional services team to upload your rule to your tenant for use, you can send it through the rule validator to check for any errors. -Refer to [Rule Validator](https://community.sailpoint.com/t5/Professional-Services/IdentityNow-Rule-Validator/ta-p/166116) for installation. +Refer to [Rule Validator](https://community.sailpoint.com/t5/Professional-Services/Identity Security Cloud-Rule-Validator/ta-p/166116) for installation. Run the rule validator against your newly written rule. @@ -488,7 +488,7 @@ To submit your Cloud Rule for review, approval, and inclusion in the SailPoint p ## Add Rule To Account Creation -Log into your IDN tenant and navigate to **Admin** -> **Connections** -> **Sources** -> **{Source Name}** -> **Accounts** -> **Create Account**. Scroll to the attribute you wish to use the rule for generating the username. Check the generator radio button and pick your new rule from the drop down. +Log into your ISC tenant and navigate to **Admin** -> **Connections** -> **Sources** -> **{Source Name}** -> **Accounts** -> **Create Account**. Scroll to the attribute you wish to use the rule for generating the username. Check the generator radio button and pick your new rule from the drop down. ![Account Create](./img/account-create.png) diff --git a/products/idn/docs/identity-now/rules/idn_rule_utility.md b/docs/extensibility/rules/idn_rule_utility.md similarity index 93% rename from products/idn/docs/identity-now/rules/idn_rule_utility.md rename to docs/extensibility/rules/idn_rule_utility.md index c4489ca68..62af2606f 100644 --- a/products/idn/docs/identity-now/rules/idn_rule_utility.md +++ b/docs/extensibility/rules/idn_rule_utility.md @@ -1,31 +1,31 @@ --- id: rule-utility -title: Using IDNRuleUtil as a Wrapper for Common Rule Operations -pagination_label: IdentityNow Rule Utility -sidebar_label: IdentityNow Rule Utility +title: Using ISCRuleUtil as a Wrapper for Common Rule Operations +pagination_label: Identity Security Cloud Rule Utility +sidebar_label: Identity Security Cloud Rule Utility sidebar_position: 4 sidebar_class_name: ruleUtility keywords: ['rule', 'utility'] -description: Using IDNRuleUtil as a Wrapper for Common Rule Operations -slug: /docs/rules/rule-utility +description: Using ISCRuleUtil as a Wrapper for Common Rule Operations +slug: /extensibility/rules/rule-utility tags: ['Rules'] --- ## Overview -Use this guide to learn how to configure searchable account attributes within IdentityNow and then leverage them within the IDNRuleUtil wrapper class when searching accounts for attributes such as uniqueness checks. There are also methods in the IDNRuleUtil wrapper class you can use without the additional searchable attributes. +Use this guide to learn how to configure searchable account attributes within Identity Security Cloud and then leverage them within the ISCRuleUtil wrapper class when searching accounts for attributes such as uniqueness checks. There are also methods in the ISCRuleUtil wrapper class you can use without the additional searchable attributes. -Search attributes allow you to search across accounts and sources to determine whether a specific attribute value is being used in your IdentityNow environment. +Search attributes allow you to search across accounts and sources to determine whether a specific attribute value is being used in your Identity Security Cloud environment. There are three critical components involves with working with searchable attributes: -- [Configuration of search attributes within IdentityNow](#configuration-of-search-attributes-within-identitynow) +- [Configuration of search attributes within Identity Security Cloud](#configuration-of-search-attributes-within-identitynow) - Seed data for accounts already aggregated into the system. - Ensure attribute promotion happens for new/changed accounts that are aggregated. - [Create rules that can be used to query the newly created attribute values](#create-rules-that-can-be-used-to-query-the-newly-created-attribute-values) - [Implement rules within the Create Profile section of each source an account is being provisioned for](#implement-rules-within-the-create-profile-section-of-each-source-for-which-an-account-is-being-provisioned) -## Configuration of Search Attributes within IdentityNow +## Configuration of Search Attributes within Identity Security Cloud When you are planning to implement search attributes, it is important that you consider the way new accounts' values will be generated and which attributes should be used as references. @@ -39,9 +39,9 @@ You need the following information to create search attributes: - Display name for the new attribute configuration. -The following example shows how to create a new attribute with the [Search Attributes API](/idn/api/beta/create-search-attribute-config): +The following example shows how to create a new attribute with the [Search Attributes API](/docs/api/beta/create-search-attribute-config): -Your company has two sources. The first is Active Directory, and the second is Workday. When the system aggregates new accounts, the company wants to query IdentityNow to see whether an email address already exists. If the email address is not in use, you can assign it to the new account. If it is in use, you can iterate on the email address value (add a 1 for example). You can then query IdentityNow once more to see whether your incremented email address is in use. You can repeat this procedure until you have determined that an email address is unique. +Your company has two sources. The first is Active Directory, and the second is Workday. When the system aggregates new accounts, the company wants to query Identity Security Cloud to see whether an email address already exists. If the email address is not in use, you can assign it to the new account. If it is in use, you can iterate on the email address value (add a 1 for example). You can then query Identity Security Cloud once more to see whether your incremented email address is in use. You can repeat this procedure until you have determined that an email address is unique. The following information is necessary to create your search attribute: @@ -62,9 +62,9 @@ The following information is necessary to create your search attribute: - Display name for the new attribute configuration: - `Promoted Email Address` -### Create the New Search Attribute in IdentityNow +### Create the New Search Attribute in Identity Security Cloud -To call the APIs for search attributes, you need a personal access token and the name of your tenant to provide with the request. To retrieve a personal access token, see [Personal Access Tokens](../../../api/authentication.md#personal-access-tokens). To get the name of your tenant, see [Finding Your Organization Tenant Name](../../../api/getting-started.md#find-your-tenant-name) +To call the APIs for search attributes, you need a personal access token and the name of your tenant to provide with the request. To retrieve a personal access token, see [Personal Access Tokens](../../api/authentication.md#personal-access-tokens). To get the name of your tenant, see [Finding Your Organization Tenant Name](../../api/getting-started.md#find-your-tenant-name) Doing so creates an account search configuration for the two sources/attributes specified. All new/changed accounts that are aggregated have this new attribute(“promotedEmailAddress”) created in the account schema and the value of the attribute(“mail” or “emailAddress”), depending on the source, is promoted to that new attribute. @@ -91,7 +91,7 @@ Aggregation only processes new and/or changed accounts for many sources. If an a If this source has already been aggregated before the account search configuration was created, a non-optimized aggregation must now be performed to seed the new attribute data for all existing accounts. -At this point, the configuration exists to promote attributes on any new/changed account that comes into IdentityNow. These attributes and their associated values are stored for use in custom rules. Each account that exists on either of these sources will now have a new attribute called “promotedEmailAddress”. _The value of this attribute will be the value of `mail` if it is the Active Directory Source or `emailAddress` if it is the Workday source._ +At this point, the configuration exists to promote attributes on any new/changed account that comes into Identity Security Cloud. These attributes and their associated values are stored for use in custom rules. Each account that exists on either of these sources will now have a new attribute called “promotedEmailAddress”. _The value of this attribute will be the value of `mail` if it is the Active Directory Source or `emailAddress` if it is the Workday source._ ## Create Rules that Can Be Used to Query the Newly Created Attribute values diff --git a/products/idn/docs/identity-now/rules/img/cloud_execution.png b/docs/extensibility/rules/img/cloud_execution.png similarity index 100% rename from products/idn/docs/identity-now/rules/img/cloud_execution.png rename to docs/extensibility/rules/img/cloud_execution.png diff --git a/products/idn/docs/identity-now/rules/img/connector_execution.png b/docs/extensibility/rules/img/connector_execution.png similarity index 100% rename from products/idn/docs/identity-now/rules/img/connector_execution.png rename to docs/extensibility/rules/img/connector_execution.png diff --git a/products/idn/docs/identity-now/rules/img/rule_execution.png b/docs/extensibility/rules/img/rule_execution.png similarity index 100% rename from products/idn/docs/identity-now/rules/img/rule_execution.png rename to docs/extensibility/rules/img/rule_execution.png diff --git a/products/idn/docs/identity-now/rules/index.md b/docs/extensibility/rules/index.md similarity index 84% rename from products/idn/docs/identity-now/rules/index.md rename to docs/extensibility/rules/index.md index 010d01bbe..791396ec8 100644 --- a/products/idn/docs/identity-now/rules/index.md +++ b/docs/extensibility/rules/index.md @@ -6,8 +6,8 @@ sidebar_label: Rules sidebar_position: 2 sidebar_class_name: rules keywords: ['rules'] -description: Documentation for rule development in IdentityNow. -slug: /docs/rules +description: Advanced configurations with custom logic. +slug: /extensibility/rules tags: ['Rules'] --- @@ -17,40 +17,40 @@ In SailPoint solutions, rules serve as a flexible configuration framework implem ## Java Beanshell -Rules in IdentityNow are written in Java Beanshell, a lightweight scripting language that allows you to define custom logic and behavior within the rules. Java Beanshell provides a familiar syntax similar to Java, making it easier for implementers to create and maintain rule configurations. +Rules in Identity Security Cloud are written in Java Beanshell, a lightweight scripting language that allows you to define custom logic and behavior within the rules. Java Beanshell provides a familiar syntax similar to Java, making it easier for implementers to create and maintain rule configurations. For more information about Java Beanshell, you can refer to the [Java Beanshell Documentation](https://github.com/beanshell/beanshell/wiki). ## Rule Execution -IdentityNow (IDN) is a multi-tenant cloud solution, and its architecture varies differently from other SailPoint products like IdentityIQ (IIQ). Therefore, the way rules execute within IDN reflects the architectural design considerations the platform was built on. These considerations determine the rule's limitations. +Identity Security Cloud (ISC) is a multi-tenant cloud solution, and its architecture varies differently from other SailPoint products like IdentityIQ (IIQ). Therefore, the way rules execute within ISC reflects the architectural design considerations the platform was built on. These considerations determine the rule's limitations. There are two primary places where you can execute rules: -- **Cloud Execution** - These rules are executed in the IDN multi-tenant cloud. -- **Connector Execution** - These rules are executed on the on-premise IDN virtual appliance. +- **Cloud Execution** - These rules are executed in the ISC multi-tenant cloud. +- **Connector Execution** - These rules are executed on the on-premise ISC virtual appliance. ![Rule Execution](./img/rule_execution.png) -**Cloud-Executed Rules** or **Cloud Rules** typically only perform a specific function, such as calculating attribute values. Many of these rules may be able to query the IDN data-model in a read-only fashion, but they do not have the ability to commit transactions, save objects, etc. +**Cloud-Executed Rules** or **Cloud Rules** typically only perform a specific function, such as calculating attribute values. Many of these rules may be able to query the ISC data-model in a read-only fashion, but they do not have the ability to commit transactions, save objects, etc. Because these rules execute in a multi-tenant cloud environment, they have a restricted context, and they are closely scrutinized to ensure that they execute in an efficient and secure manner. For more details, see [Cloud Rules](./cloud-rules/index.md). -**Connector-Executed Rules** or **Connector Rules** are rules executed in the IDN virtual appliance, and they are often an extension connector itself. The rules are commonly used for performing complex connector-related functions, so they are specific to only certain connectors. Because these rules execute in the virtual appliance, they do not have access to query the IDN data model or fetch information from IDN. They rely instead on contextual information sent from IDN. Connector-executed rules may also have managed connections supplied in their contexts to support querying end systems or sources. Though you may use these managed connections, you cannot make making additional connections or call-outs. +**Connector-Executed Rules** or **Connector Rules** are rules executed in the ISC virtual appliance, and they are often an extension connector itself. The rules are commonly used for performing complex connector-related functions, so they are specific to only certain connectors. Because these rules execute in the virtual appliance, they do not have access to query the ISC data model or fetch information from ISC. They rely instead on contextual information sent from ISC. Connector-executed rules may also have managed connections supplied in their contexts to support querying end systems or sources. Though you may use these managed connections, you cannot make making additional connections or call-outs. For more details, see the [Connector Rules](./connector-rules/index.md). ## Support Considerations -Though IDN shares some common functionality with other SailPoint products like IIQ, the same rules are not necessarily supported, nor do they necessarily execute the same way or with the same context and variables. SailPoint recommends that you become familiar with which rules execute with which products, as well as the nuances in their execution contexts. +Though ISC shares some common functionality with other SailPoint products like IIQ, the same rules are not necessarily supported, nor do they necessarily execute the same way or with the same context and variables. SailPoint recommends that you become familiar with which rules execute with which products, as well as the nuances in their execution contexts. -From a SailPoint support perspective, rules are considered configurations. SailPoint supports the underlying platform but not the rule configurations themselves. Any problems with the way rules are implemented or run over time are the responsibilities the customer or implementer must manage. SailPoint's IDN Expert Services need hours to cover any rule configuration work (e.g., creating rules, best practices reviews, application to your IDN environment, and promotion between sandbox & prod environments). Contact your Customer Success Manager with any questions. While rules allow some advanced flexibility, you must consider these support implications when you are deciding whether to implement rules. Consider rule usage a last resort, and use IdentityNow features instead whenever you can. +From a SailPoint support perspective, rules are considered configurations. SailPoint supports the underlying platform but not the rule configurations themselves. Any problems with the way rules are implemented or run over time are the responsibilities the customer or implementer must manage. SailPoint's ISC Expert Services need hours to cover any rule configuration work (e.g., creating rules, best practices reviews, application to your ISC environment, and promotion between sandbox & prod environments). Contact your Customer Success Manager with any questions. While rules allow some advanced flexibility, you must consider these support implications when you are deciding whether to implement rules. Consider rule usage a last resort, and use Identity Security Cloud features instead whenever you can. ## Best Practices for Rule deployments -SailPoint IDN deployments often require the deployment of rules to the client’s IDN tenants. Because IDN is a multi-tenant solution, rules that are poorly written can have negative performance implications on other tenants in the same cloud. As such, SailPoint requires all rules to be reviewed prior to deployment. The time to complete these reviews requires an expert services contract to leverage billable hours. +SailPoint ISC deployments often require the deployment of rules to the client’s ISC tenants. Because ISC is a multi-tenant solution, rules that are poorly written can have negative performance implications on other tenants in the same cloud. As such, SailPoint requires all rules to be reviewed prior to deployment. The time to complete these reviews requires an expert services contract to leverage billable hours. This article covers common topics around this process including best practices, rule review expectations, and more. @@ -76,11 +76,11 @@ In the case of rejection, we recommend submitting a new ticket to avoid a scenar ## Promote Rules from Sandbox to Production -A rule that has been approved in a sandbox tenant through the SailPoint rule review process, like an IdentityAttribute, Correlation or ManagerCorrelation rule or any other rule type, for example, can be migrated to the production IDN tenant. +A rule that has been approved in a sandbox tenant through the SailPoint rule review process, like an IdentityAttribute, Correlation or ManagerCorrelation rule or any other rule type, for example, can be migrated to the production ISC tenant. This applies to all rule types, as the signature has been approved/verified during the SailPoint rule review process, the sp-config API allows you to import ANY ‘approved’ tenant rules. (this includes cloud rules!) -For more details on the sp-config API see [sp-config](/idn/api/beta/export-sp-config) +For more details on the sp-config API see [sp-config](/docs/api/beta/export-sp-config) ## Rule Guidelines @@ -198,7 +198,7 @@ Log4j Logger.getLogger​ ``` -Note that the earlier code fragments are not allowed within [connector-executed rules](./connector-rules/index.md#supported-connector-rules) because they are not valid at the connector level. They will, for a short time, still be allowed for pre-existing [cloud-executed rules](./cloud-rules/index.md) as a review exception. However, any new rules using these constructs will be returned to the submitter, and the submitter will be asked to rewrite the rule, using the [IDN Rule Utility](./idn_rule_utility.md) helper methods instead: +Note that the earlier code fragments are not allowed within [connector-executed rules](./connector-rules/index.md#supported-connector-rules) because they are not valid at the connector level. They will, for a short time, still be allowed for pre-existing [cloud-executed rules](./cloud-rules/index.md) as a review exception. However, any new rules using these constructs will be returned to the submitter, and the submitter will be asked to rewrite the rule, using the [ISC Rule Utility](./idn_rule_utility.md) helper methods instead: - context - .getObjectById() @@ -209,11 +209,11 @@ Note that the earlier code fragments are not allowed within [connector-executed ## Other Rules -While IDN shares some common functionality with other SailPoint products like IIQ, the same rules are not necessarily supported, nor do they necessarily execute the same way. SailPoint recommends that you become familiar with which rules execute with which products, as well as the nuances in their execution contexts. IDN considers any other rules not mentioned in the Cloud-Executed Rules or Connector-Executed Rules sections to be unsupported. +While ISC shares some common functionality with other SailPoint products like IIQ, the same rules are not necessarily supported, nor do they necessarily execute the same way. SailPoint recommends that you become familiar with which rules execute with which products, as well as the nuances in their execution contexts. ISC considers any other rules not mentioned in the Cloud-Executed Rules or Connector-Executed Rules sections to be unsupported. ## Deprecated Rules -The following rules have been deprecated in IDN. SailPoint recommends using supported product functionality instead of these rules: +The following rules have been deprecated in ISC. SailPoint recommends using supported product functionality instead of these rules: - **Certification Exclusion Rules** - Use configurable certification campaign filters instead. - **Identity Selector Rules** - Use role standard assignment criteria instead. diff --git a/products/idn/docs/identity-now/rules/rule-java-docs/index.mdx b/docs/extensibility/rules/rule-java-docs/index.mdx similarity index 91% rename from products/idn/docs/identity-now/rules/rule-java-docs/index.mdx rename to docs/extensibility/rules/rule-java-docs/index.mdx index 83abaa998..7f45e331c 100644 --- a/products/idn/docs/identity-now/rules/rule-java-docs/index.mdx +++ b/docs/extensibility/rules/rule-java-docs/index.mdx @@ -7,7 +7,7 @@ sidebar_position: 6 sidebar_class_name: ruleJavaDocs keywords: ['rules', 'java', 'docs'] description: Documentation for rule development in IdentityNow. -slug: /docs/rules/java-docs +slug: /extensibility/rules/java-docs tags: ['Rules', 'Java', 'Docs'] --- diff --git a/docs/extensibility/transforms/_category_.json b/docs/extensibility/transforms/_category_.json new file mode 100644 index 000000000..17d3fb707 --- /dev/null +++ b/docs/extensibility/transforms/_category_.json @@ -0,0 +1,5 @@ +{ + "customProps": { + "description": "Modify attribute data without code." + } +} \ No newline at end of file diff --git a/products/idn/docs/identity-now/transforms/guides/identity-context.md b/docs/extensibility/transforms/guides/identity-context.md similarity index 96% rename from products/idn/docs/identity-now/transforms/guides/identity-context.md rename to docs/extensibility/transforms/guides/identity-context.md index dff00cec2..6e0a4dc7a 100644 --- a/products/idn/docs/identity-now/transforms/guides/identity-context.md +++ b/docs/extensibility/transforms/guides/identity-context.md @@ -7,7 +7,7 @@ sidebar_class_name: identityContextTransform keywords: ['transforms', 'guides', 'nested', 'lifecycle'] description: Examples on how you might use the identity attribute context. sidebar_position: 5 -slug: /docs/transforms/guides/identity-context-examples +slug: /extensibility/transforms/guides/identity-context-examples tags: ['Transforms', 'Guides', 'identity'] --- @@ -23,7 +23,7 @@ The following variables are available to the Apache Velocity template engine whe | attributeDefinition | sailpoint.object.ObjectAttribute | This is the definition of the attribute being promoted. | | oldValue | Object | This is the attribute's previous value. | -For available methods on these objects see our [Rules Java Docs](https://developer.sailpoint.com/idn/docs/rules/java-docs). +For available methods on these objects see our [Rules Java Docs](https://developer.sailpoint.com/docs/extensibility/rules/java-docs). ## Examples diff --git a/products/idn/docs/identity-now/transforms/guides/img/account_schema.png b/docs/extensibility/transforms/guides/img/account_schema.png similarity index 100% rename from products/idn/docs/identity-now/transforms/guides/img/account_schema.png rename to docs/extensibility/transforms/guides/img/account_schema.png diff --git a/products/idn/docs/identity-now/transforms/guides/img/account_summary.png b/docs/extensibility/transforms/guides/img/account_summary.png similarity index 100% rename from products/idn/docs/identity-now/transforms/guides/img/account_summary.png rename to docs/extensibility/transforms/guides/img/account_summary.png diff --git a/products/idn/docs/identity-now/transforms/guides/img/create_source.png b/docs/extensibility/transforms/guides/img/create_source.png similarity index 100% rename from products/idn/docs/identity-now/transforms/guides/img/create_source.png rename to docs/extensibility/transforms/guides/img/create_source.png diff --git a/products/idn/docs/identity-now/transforms/guides/img/identity_profile.png b/docs/extensibility/transforms/guides/img/identity_profile.png similarity index 100% rename from products/idn/docs/identity-now/transforms/guides/img/identity_profile.png rename to docs/extensibility/transforms/guides/img/identity_profile.png diff --git a/products/idn/docs/identity-now/transforms/guides/img/mappings_tab.png b/docs/extensibility/transforms/guides/img/mappings_tab.png similarity index 100% rename from products/idn/docs/identity-now/transforms/guides/img/mappings_tab.png rename to docs/extensibility/transforms/guides/img/mappings_tab.png diff --git a/products/idn/docs/identity-now/transforms/guides/img/temporary_password_attribute_mapping.png b/docs/extensibility/transforms/guides/img/temporary_password_attribute_mapping.png similarity index 100% rename from products/idn/docs/identity-now/transforms/guides/img/temporary_password_attribute_mapping.png rename to docs/extensibility/transforms/guides/img/temporary_password_attribute_mapping.png diff --git a/products/idn/docs/identity-now/transforms/guides/index.md b/docs/extensibility/transforms/guides/index.md similarity index 93% rename from products/idn/docs/identity-now/transforms/guides/index.md rename to docs/extensibility/transforms/guides/index.md index d72b6db49..ec6dab248 100644 --- a/products/idn/docs/identity-now/transforms/guides/index.md +++ b/docs/extensibility/transforms/guides/index.md @@ -6,7 +6,7 @@ sidebar_label: Guides sidebar_class_name: transforms keywords: ['transforms', 'guides'] description: Transform Guides -slug: /docs/transforms/guides +slug: /extensibility/transforms/guides tags: ['Transforms', 'Guides'] --- diff --git a/products/idn/docs/identity-now/transforms/guides/lifecycle-state-transforms.md b/docs/extensibility/transforms/guides/lifecycle-state-transforms.md similarity index 98% rename from products/idn/docs/identity-now/transforms/guides/lifecycle-state-transforms.md rename to docs/extensibility/transforms/guides/lifecycle-state-transforms.md index 72ba74957..d5739a089 100644 --- a/products/idn/docs/identity-now/transforms/guides/lifecycle-state-transforms.md +++ b/docs/extensibility/transforms/guides/lifecycle-state-transforms.md @@ -7,7 +7,7 @@ sidebar_class_name: lifecycleStateTransform keywords: ['transforms', 'guides', 'nested', 'lifecycle'] description: Learn how to build a lifecycle state transform. sidebar_position: 4 -slug: /docs/transforms/guides/lifecycle-state-transform +slug: /extensibility/transforms/guides/lifecycle-state-transform tags: ['Transforms', 'Guides', 'Lifecycle'] --- @@ -15,7 +15,7 @@ tags: ['Transforms', 'Guides', 'Lifecycle'] In this guide, you will walk through a lifecycle state transform that requires you to nest multiple transforms together to achieve your desired result. -A lifecycle state is a status an identity can be in, such as `active`, `inactive` and `terminated`, for example. You can then use this lifecycle state in IdentityNow to determine an identity's access. +A lifecycle state is a status an identity can be in, such as `active`, `inactive` and `terminated`, for example. You can then use this lifecycle state in Identity Security Cloud to determine an identity's access. ## Determine lifecycle state from end date attribute diff --git a/products/idn/docs/identity-now/transforms/guides/provisioning-policy-transform.md b/docs/extensibility/transforms/guides/provisioning-policy-transform.md similarity index 89% rename from products/idn/docs/identity-now/transforms/guides/provisioning-policy-transform.md rename to docs/extensibility/transforms/guides/provisioning-policy-transform.md index b04033b68..71b88e8d6 100644 --- a/products/idn/docs/identity-now/transforms/guides/provisioning-policy-transform.md +++ b/docs/extensibility/transforms/guides/provisioning-policy-transform.md @@ -7,19 +7,19 @@ sidebar_class_name: transformsInProvisioningPolicies keywords: ['transforms', 'guides', 'provisioning', 'policies'] description: Learn how to use transforms in your provisioning policies! sidebar_position: 3 -slug: /docs/transforms/guides/transforms-in-provisioning-policies +slug: /extensibility/transforms/guides/transforms-in-provisioning-policies tags: ['Transforms', 'Guides', 'Provisioning', 'Policies'] --- ## Overview -In this guide, you will learn how to use [IdentityNow's Transforms](/idn/api/v3/transforms) in a provisioning policy for a source. This can be useful if you need to hide the attribute in your identity attribute list but still need the attribute during provisioning. +In this guide, you will learn how to use [Identity Security Cloud's Transforms](/docs/api/v3/transforms) in a provisioning policy for a source. This can be useful if you need to hide the attribute in your identity attribute list but still need the attribute during provisioning. ## Create provisioning policy Use the Create provisioning policy for new users who have been granted access to a source and need to be provisioned on that source. You can define the custom attributes you want to create during the provisioning process. You can use transforms to modify the data before sending it to the source. -First, call the [Get Provisioning Policy API](/idn/api/v3/get-provisioning-policy) for the source you want to add your transform to. +First, call the [Get Provisioning Policy API](/docs/api/v3/get-provisioning-policy) for the source you want to add your transform to. This is an example create provisioning policy response for a source: @@ -195,7 +195,7 @@ If you assume the given attributes have the following values, this transform wou ## Add the transform to your existing policy -Upload your complete CREATE provisioning policy by using the [Create Provisioning Policy API](/idn/api/v3/create-provisioning-policy), or use the [Update Provisioning Policy API](/idn/api/v3/put-provisioning-policy) to update an existing provisioning policy. +Upload your complete CREATE provisioning policy by using the [Create Provisioning Policy API](/docs/api/v3/create-provisioning-policy), or use the [Update Provisioning Policy API](/docs/api/v3/put-provisioning-policy) to update an existing provisioning policy. This is the example response with the full policy, along with the new attribute: @@ -352,4 +352,4 @@ This is the example response with the full policy, along with the new attribute: ## Next Steps -For more information on all available transforms, refer to [Transform Operations](/idn/docs/transforms/operations). If you're having trouble creating your transform in provisioning policies, reach out with your question in the [Developer Community Forum](https://developer.sailpoint.com/discuss/)! +For more information on all available transforms, refer to [Transform Operations](/docs/extensibility/transforms/operations). If you're having trouble creating your transform in provisioning policies, reach out with your question in the [Developer Community Forum](https://developer.sailpoint.com/discuss/)! diff --git a/products/idn/docs/identity-now/transforms/guides/temporary-password.md b/docs/extensibility/transforms/guides/temporary-password.md similarity index 93% rename from products/idn/docs/identity-now/transforms/guides/temporary-password.md rename to docs/extensibility/transforms/guides/temporary-password.md index 6117d811d..d3702b4bb 100644 --- a/products/idn/docs/identity-now/transforms/guides/temporary-password.md +++ b/docs/extensibility/transforms/guides/temporary-password.md @@ -7,7 +7,7 @@ sidebar_class_name: generateTemporaryPassword keywords: ['transforms', 'guides', 'password'] description: Generate a temporary password for all users. sidebar_position: 2 -slug: /docs/transforms/guides/temporary-password +slug: /extensibility/transforms/guides/temporary-password tags: ['Transforms', 'Guides', 'Password'] --- @@ -129,7 +129,7 @@ The first part of the password is the user's first intitial in lowercase. You ca ### The User's Last Name Comes Next with the First Character in Uppercase -Adding to the transform, you can create a variable for the first character of the last name. You can do so by using the [substring operation](/idn/docs/transforms/operations/substring) and the [upper operation](/idn/docs/transforms/operations/upper). Once you have the variable `lastInitialUppercase` created, you can add that variable to the end of the static string in the value key. +Adding to the transform, you can create a variable for the first character of the last name. You can do so by using the [substring operation](/docs/extensibility/transforms/operations/substring) and the [upper operation](/docs/extensibility/transforms/operations/upper). Once you have the variable `lastInitialUppercase` created, you can add that variable to the end of the static string in the value key. **Last Initial Variable** @@ -290,7 +290,7 @@ You also need the end of the last name without the first character you already h ### The User's Two-Digit Start Month Comes Next, Taken from the Hire_Date -To get the two-digit start month, use the [split operation](/idn/docs/transforms/operations/split). The `hire_date` is in the format of `YYYY-MM-DD`. To to get the month, split on `-` and set the index to return as 1. +To get the two-digit start month, use the [split operation](/docs/extensibility/transforms/operations/split). The `hire_date` is in the format of `YYYY-MM-DD`. To to get the month, split on `-` and set the index to return as 1. **Hire Date Month Variable** @@ -492,7 +492,7 @@ To add the final part of the password, which is the static string `RstP\*!7`, us To verify your transform is working, create the transfrom through the REST API. -To call the APIs for transforms, you need a personal access token and your tenant's name to provide with the request. For more information about how to get a personal access token, see [Personal Access Tokens](../../../../api/authentication.md#personal-access-tokens). For more information about how to get the name of your tenant, see [Finding Your Organization Tenant Name](../../../../api/getting-started.md#find-your-tenant-name). +To call the APIs for transforms, you need a personal access token and your tenant's name to provide with the request. For more information about how to get a personal access token, see [Personal Access Tokens](../../../api/authentication.md#personal-access-tokens). For more information about how to get the name of your tenant, see [Finding Your Organization Tenant Name](../../../api/getting-started.md#find-your-tenant-name). ```bash curl --location --request POST 'https://{tenant}.api.identitynow.com/v3/transforms' \ @@ -580,7 +580,7 @@ curl --location --request POST 'https://{tenant}.api.identitynow.com/v3/transfor Once you have created the transform successfully, you can apply the new transform and preview what the password will look like for each user. -Log in to your IdentityNow tenant and go to **Admin** > **Identities** > **Identity Profiles**. Select the name of the profile you created earlier, Transform Example. Select the **Mappings** tab, scroll to the bottom and select **Add New Attribute**. Name the attribute `Temporary Password`. To save the new mappings, you must fill out the id, email, first name and last name mappings. +Log in to your Identity Security Cloud tenant and go to **Admin** > **Identities** > **Identity Profiles**. Select the name of the profile you created earlier, Transform Example. Select the **Mappings** tab, scroll to the bottom and select **Add New Attribute**. Name the attribute `Temporary Password`. To save the new mappings, you must fill out the id, email, first name and last name mappings. ![Attribute Mapping](./img/temporary_password_attribute_mapping.png) diff --git a/products/idn/docs/identity-now/transforms/guides/your-first-transform.md b/docs/extensibility/transforms/guides/your-first-transform.md similarity index 86% rename from products/idn/docs/identity-now/transforms/guides/your-first-transform.md rename to docs/extensibility/transforms/guides/your-first-transform.md index b152a8413..4d8a0270e 100644 --- a/products/idn/docs/identity-now/transforms/guides/your-first-transform.md +++ b/docs/extensibility/transforms/guides/your-first-transform.md @@ -7,25 +7,25 @@ sidebar_class_name: yourFirstTransform keywords: ['transforms', 'guides', 'first'] description: Learn to build your first transform! sidebar_position: 1 -slug: /docs/transforms/guides/your-first-transform +slug: /extensibility/transforms/guides/your-first-transform tags: ['Transforms', 'Guides', 'First'] --- ## Overview -In this guide, you will learn how to use [IdentityNow's Transform REST APIs](/idn/api/v3/transforms) to do the following: +In this guide, you will learn how to use [Identity Security Cloud's Transform REST APIs](/docs/api/v3/transforms) to do the following: -- [List Transforms in Your IdentityNow Tenant](#list-transforms-in-your-identitynow-tenant) +- [List Transforms in Your Identity Security Cloud Tenant](#list-transforms-in-your-identitynow-tenant) - [Create a Transform](#create-a-transform) - [Get Transform by ID](#get-transform-by-id) - [Update a Transform](#update-a-transform) - [Delete a Transform](#delete-a-transform) -## List Transforms in your IdentityNow Tenant +## List Transforms in your Identity Security Cloud Tenant -To call the APIs for transforms, you need a personal access token and your tenant's name to provide with the request. For more information about how to get a personal access token, see [Personal Access Tokens](../../../../api/authentication.md#personal-access-tokens). For more information about how to get the name of your tenant, see [Finding Your Organization Tenant Name](../../../../api/getting-started.md#finding-your-orgtenant-name). +To call the APIs for transforms, you need a personal access token and your tenant's name to provide with the request. For more information about how to get a personal access token, see [Personal Access Tokens](../../../api/authentication.md#personal-access-tokens). For more information about how to get the name of your tenant, see [Finding Your Organization Tenant Name](../../../api/getting-started.md#finding-your-orgtenant-name). -Before you create your first custom transform, see what transforms are already in the tenant. You can get this information by calling the [List Transforms API](/idn/api/v3/list-transforms). +Before you create your first custom transform, see what transforms are already in the tenant. You can get this information by calling the [List Transforms API](/docs/api/v3/list-transforms). ```bash curl --location --request GET 'https://{tenant}.api.identitynow.com/v3/transforms' --header 'Authorization: Bearer {token}' @@ -118,11 +118,11 @@ curl --location --request POST 'https://{tenant}.api.identitynow.com/v3/transfor } ``` -Once you have created the transform, you can find it in IdentityNow by going to **Admin** > **Identities** > **Identity Profiles** > (An Identity Profile) > **Mappings** (tab). +Once you have created the transform, you can find it in Identity Security Cloud by going to **Admin** > **Identities** > **Identity Profiles** > (An Identity Profile) > **Mappings** (tab). ![Mappings Tab](./img/mappings_tab.png) -For more information about creating transforms, see [Create Transform](/idn/api/v3/create-transform). +For more information about creating transforms, see [Create Transform](/docs/api/v3/create-transform). ## Get Transform by ID @@ -152,7 +152,7 @@ curl --location --request GET 'https://{tenant}.api.identitynow.com/v3/transform } ``` -For more information about getting a transform by its `id` see the API [Transform by ID](/idn/api/v3/get-transform). +For more information about getting a transform by its `id` see the API [Transform by ID](/docs/api/v3/get-transform). ## Update a Transform @@ -203,7 +203,7 @@ curl --location --request PUT 'https://{tenant}.api.identitynow.com/v3/transform } ``` -For more information about updating transforms, see [Update a transform](/idn/api/v3/update-transform). +For more information about updating transforms, see [Update a transform](/docs/api/v3/update-transform). ## Delete a Transform @@ -214,7 +214,7 @@ curl --location --request DELETE 'https://{tenant}.api.identitynow.com/v3/transf --header 'Authorization: Bearer {token}' ``` -For more information about deleting transforms, see the API [Delete Transform](/idn/api/v3/delete-transform). +For more information about deleting transforms, see the API [Delete Transform](/docs/api/v3/delete-transform). ## Next Steps diff --git a/products/idn/docs/identity-now/transforms/img/account_schema.png b/docs/extensibility/transforms/img/account_schema.png similarity index 100% rename from products/idn/docs/identity-now/transforms/img/account_schema.png rename to docs/extensibility/transforms/img/account_schema.png diff --git a/products/idn/docs/identity-now/transforms/img/account_summary.png b/docs/extensibility/transforms/img/account_summary.png similarity index 100% rename from products/idn/docs/identity-now/transforms/img/account_summary.png rename to docs/extensibility/transforms/img/account_summary.png diff --git a/products/idn/docs/identity-now/transforms/img/configuring_transform_behavior_1.png b/docs/extensibility/transforms/img/configuring_transform_behavior_1.png similarity index 100% rename from products/idn/docs/identity-now/transforms/img/configuring_transform_behavior_1.png rename to docs/extensibility/transforms/img/configuring_transform_behavior_1.png diff --git a/products/idn/docs/identity-now/transforms/img/configuring_transform_behavior_2.png b/docs/extensibility/transforms/img/configuring_transform_behavior_2.png similarity index 100% rename from products/idn/docs/identity-now/transforms/img/configuring_transform_behavior_2.png rename to docs/extensibility/transforms/img/configuring_transform_behavior_2.png diff --git a/products/idn/docs/identity-now/transforms/img/create_source.png b/docs/extensibility/transforms/img/create_source.png similarity index 100% rename from products/idn/docs/identity-now/transforms/img/create_source.png rename to docs/extensibility/transforms/img/create_source.png diff --git a/products/idn/docs/identity-now/transforms/img/how_transforms_work_1.png b/docs/extensibility/transforms/img/how_transforms_work_1.png similarity index 100% rename from products/idn/docs/identity-now/transforms/img/how_transforms_work_1.png rename to docs/extensibility/transforms/img/how_transforms_work_1.png diff --git a/products/idn/docs/identity-now/transforms/img/how_transforms_work_2.png b/docs/extensibility/transforms/img/how_transforms_work_2.png similarity index 100% rename from products/idn/docs/identity-now/transforms/img/how_transforms_work_2.png rename to docs/extensibility/transforms/img/how_transforms_work_2.png diff --git a/products/idn/docs/identity-now/transforms/img/how_transforms_work_3.png b/docs/extensibility/transforms/img/how_transforms_work_3.png similarity index 100% rename from products/idn/docs/identity-now/transforms/img/how_transforms_work_3.png rename to docs/extensibility/transforms/img/how_transforms_work_3.png diff --git a/products/idn/docs/identity-now/transforms/img/how_transforms_work_4.png b/docs/extensibility/transforms/img/how_transforms_work_4.png similarity index 100% rename from products/idn/docs/identity-now/transforms/img/how_transforms_work_4.png rename to docs/extensibility/transforms/img/how_transforms_work_4.png diff --git a/products/idn/docs/identity-now/transforms/img/identity_profile.png b/docs/extensibility/transforms/img/identity_profile.png similarity index 100% rename from products/idn/docs/identity-now/transforms/img/identity_profile.png rename to docs/extensibility/transforms/img/identity_profile.png diff --git a/products/idn/docs/identity-now/transforms/img/mappings_tab.png b/docs/extensibility/transforms/img/mappings_tab.png similarity index 100% rename from products/idn/docs/identity-now/transforms/img/mappings_tab.png rename to docs/extensibility/transforms/img/mappings_tab.png diff --git a/products/idn/docs/identity-now/transforms/img/temporary_password_attribute_mapping.png b/docs/extensibility/transforms/img/temporary_password_attribute_mapping.png similarity index 100% rename from products/idn/docs/identity-now/transforms/img/temporary_password_attribute_mapping.png rename to docs/extensibility/transforms/img/temporary_password_attribute_mapping.png diff --git a/products/idn/docs/identity-now/transforms/img/what_are_transforms_1.png b/docs/extensibility/transforms/img/what_are_transforms_1.png similarity index 100% rename from products/idn/docs/identity-now/transforms/img/what_are_transforms_1.png rename to docs/extensibility/transforms/img/what_are_transforms_1.png diff --git a/products/idn/docs/identity-now/transforms/index.md b/docs/extensibility/transforms/index.md similarity index 85% rename from products/idn/docs/identity-now/transforms/index.md rename to docs/extensibility/transforms/index.md index 1f4959497..fb17d25a4 100644 --- a/products/idn/docs/identity-now/transforms/index.md +++ b/docs/extensibility/transforms/index.md @@ -6,9 +6,11 @@ sidebar_label: Transforms sidebar_position: 1 sidebar_class_name: transforms keywords: ['transforms'] -description: Building Transforms in IdentityNow -slug: /docs/transforms +description: Modify attribute data without code. +slug: /extensibility/transforms tags: ['Transforms'] +customProps: + description: Modify attribute data without code. --- In SailPoint's cloud services, transforms allow you to manipulate attribute values while aggregating from or provisioning to a source. This guide provides a reference to help you understand the purpose, configuration, and usage of transforms. @@ -26,17 +28,17 @@ flowchart LR -Because there is no code to write, an administrator can configure these by using a JSON object structure and uploading them into IdentityNow using [IdentityNow's Transform REST APIs](/idn/api/v3/transforms). +Because there is no code to write, an administrator can configure these by using a JSON object structure and uploading them into Identity Security Cloud using [Identity Security Cloud's Transform REST APIs](/docs/api/v3/transforms). :::info -Sometimes transforms are referred to as Seaspray, the codename for transforms. IdentityNow Transforms and Seaspray are essentially the same. +Sometimes transforms are referred to as Seaspray, the codename for transforms. Identity Security Cloud Transforms and Seaspray are essentially the same. ::: ## How Transforms Work -Transforms typically have an input(s) and output(s). The way the transformation occurs mainly depends on the type of transform. Refer to [Operations in IdentityNow Transforms](./operations/index.md) for more information. +Transforms typically have an input(s) and output(s). The way the transformation occurs mainly depends on the type of transform. Refer to [Operations in Identity Security Cloud Transforms](./operations/index.md) for more information. For example, a [Lower transform](./operations/lower.md) transforms any input text strings into lowercase versions as output. So if the input were `Foo`, the lowercase output of the transform would be `foo`: @@ -76,7 +78,7 @@ flowchart LR ### Complex Nested Transforms -For more complex use cases, a single transform may not be enough. It is possible to link several transforms together. IdentityNow calls these 'nested' transforms because they are transform objects within other transform objects. +For more complex use cases, a single transform may not be enough. It is possible to link several transforms together. Identity Security Cloud calls these 'nested' transforms because they are transform objects within other transform objects. An example of a nested transform would be using the previous [Concat transform](./operations/concatenation.md) and passing its output as an input to another [Lower transform](./operations/lower.md). If the inputs `Foo` and `Bar` were passed into the transforms, the ultimate output would be `foobar`, concatenated and in lowercase. @@ -127,7 +129,7 @@ Transforms are JSON objects. Prior to this, the transforms have been shown as fl There are three main components of a transform object: -1. `name` - This specifies the name of the transform. It refers to a transform in the IdentityNow API or User Interface (UI). Only provide a name on the root-level transform. Nested transforms do not have names. +1. `name` - This specifies the name of the transform. It refers to a transform in the Identity Security Cloud API or User Interface (UI). Only provide a name on the root-level transform. Nested transforms do not have names. 2. `type` - This specifies the transform type, which ultimately determines the transform's behavior. @@ -135,7 +137,7 @@ There are three main components of a transform object: :::caution -When uploading a transform to IdentityNow it cannot exceed 400KB. +When uploading a transform to Identity Security Cloud it cannot exceed 400KB. ::: @@ -172,7 +174,7 @@ The following variables are available to the Apache Velocity template engine whe ## Implicit vs Explicit Input -A special configuration attribute available to all transforms is input. If the input attribute is not specified, this is referred to as implicit input, and the system determines the input based on what is configured. If the input attribute is specified, then this is referred to as explicit input, and the system's input is ignored in favor of whatever the transform explicitly specifies. A good way to understand this concept is to walk through an example. Imagine that IdentityNow has the following: +A special configuration attribute available to all transforms is input. If the input attribute is not specified, this is referred to as implicit input, and the system determines the input based on what is configured. If the input attribute is specified, then this is referred to as explicit input, and the system's input is ignored in favor of whatever the transform explicitly specifies. A good way to understand this concept is to walk through an example. Imagine that Identity Security Cloud has the following: - An account on Source 1 with department set to `Services`. - An account on Source 2 with department set to `Engineering`. @@ -240,17 +242,17 @@ These transforms are configured separately from the transforms applied via the i ::: #### Configuration -These can be configured in IdentityNow by going to **Admin** > **Sources** > (A Source) > **Accounts** (tab) > **Create Account**. +These can be configured in Identity Security Cloud by going to **Admin** > **Sources** > (A Source) > **Accounts** (tab) > **Create Account**. The available options on this page are constructed as transforms behind the scenes. For example, the identity attribute mapping choice is saved as an [identity attribute transform](./operations/identity-attribute.md) definition within the saved create profile. -These can also be configured with IdentityNow REST APIs. You can define any kind of transform you want for any field in the create profile policy, to calculate account attributes in ways beyond what the UI offers. See [Transforms in Provisioning Policies](./guides/provisioning-policy-transform.md). +These can also be configured with Identity Security Cloud REST APIs. You can define any kind of transform you want for any field in the create profile policy, to calculate account attributes in ways beyond what the UI offers. See [Transforms in Provisioning Policies](./guides/provisioning-policy-transform.md). -For more information on the IdentityNow REST API endpoints used to managed transform objects in APIs, refer to [IdentityNow Transform REST APIs](/idn/api/v3/transforms). +For more information on the Identity Security Cloud REST API endpoints used to managed transform objects in APIs, refer to [Identity Security Cloud Transform REST APIs](/docs/api/v3/transforms). :::tip -For details about authentication against REST APIs, refer to the [authentication docs](../../../api/authentication.md). +For details about authentication against REST APIs, refer to the [authentication docs](../../api/authentication.md). ::: @@ -290,9 +292,9 @@ To test a transform for account data, you must provision a new account on that s Sometimes it can be difficult to decide when to implement a transform and when to implement a rule. Both transforms and rules can calculate values for identity or account attributes. -Despite their functional similarity, transforms and rules have very different implementations. Transforms are JSON-based configurations, editable with IdentityNow's transform REST APIs. Rules are implemented with code (typically [BeanShell](https://github.com/beanshell/beanshell), a Java-like syntax), so they must follow the [IdentityNow Rule Guidelines](https://community.sailpoint.com/docs/DOC-12122), and they require SailPoint to be reviewed and installed into the tenant. Rules, however, can do things that transforms cannot in some cases. +Despite their functional similarity, transforms and rules have very different implementations. Transforms are JSON-based configurations, editable with Identity Security Cloud's transform REST APIs. Rules are implemented with code (typically [BeanShell](https://github.com/beanshell/beanshell), a Java-like syntax), so they must follow the [Identity Security Cloud Rule Guidelines](https://community.sailpoint.com/docs/DOC-12122), and they require SailPoint to be reviewed and installed into the tenant. Rules, however, can do things that transforms cannot in some cases. -Because transforms have easier and more accessible implementations, they are generally recommended. With transforms, any IdentityNow administrator can view, create, edit, and delete transforms directly with REST API without SailPoint involvement. +Because transforms have easier and more accessible implementations, they are generally recommended. With transforms, any Identity Security Cloud administrator can view, create, edit, and delete transforms directly with REST API without SailPoint involvement. If something cannot be done with a transform, then consider using a rule. When you are transitioning from a transform to a rule, you must take special consideration when you decide where the rule executes. @@ -300,6 +302,6 @@ If something cannot be done with a transform, then consider using a rule. When y - If you are calculating account attributes (during provisioning), you can use [Attribute Generator rules](https://community.sailpoint.com/docs/DOC-12645) instead of account transforms. -- All rules you build must follow the [IdentityNow Rule Guidelines](https://community.sailpoint.com/docs/DOC-12122). +- All rules you build must follow the [Identity Security Cloud Rule Guidelines](https://community.sailpoint.com/docs/DOC-12122). If you use a rule, make note of it for administrative purposes. The best practice is to check in these types of artifacts into some sort of version control (e.g., GitHub, et. Al.) for records. diff --git a/products/idn/docs/identity-now/transforms/operations/account-attribute.md b/docs/extensibility/transforms/operations/account-attribute.md similarity index 94% rename from products/idn/docs/identity-now/transforms/operations/account-attribute.md rename to docs/extensibility/transforms/operations/account-attribute.md index 5cc4abfee..56918c54b 100644 --- a/products/idn/docs/identity-now/transforms/operations/account-attribute.md +++ b/docs/extensibility/transforms/operations/account-attribute.md @@ -6,7 +6,7 @@ sidebar_label: Account Attribute sidebar_class_name: accountAttribute keywords: ['transforms', 'operations', 'account', 'attribute'] description: Look up an account for a particular source on an identity. -slug: /docs/transforms/operations/account-attribute +slug: /extensibility/transforms/operations/account-attribute tags: ['Transforms', 'Transform Operations'] --- @@ -16,8 +16,8 @@ Use the account attribute transform to look up an account for a particular sourc :::note Other Considerations -- If there are multiple accounts, then IdentityNow by default takes the value from the oldest account (based on the account created date). You can configure this behavior by specifying `accountSortAttribute` and `accountSortDescending` attributes. -- If there are multiple accounts and the oldest account has a null attribute value, by default IdentityNow moves to the next account that can have a value (if there are any). You can override this behavior with the `accountReturnFirstLink` property. +- If there are multiple accounts, then Identity Security Cloud by default takes the value from the oldest account (based on the account created date). You can configure this behavior by specifying `accountSortAttribute` and `accountSortDescending` attributes. +- If there are multiple accounts and the oldest account has a null attribute value, by default Identity Security Cloud moves to the next account that can have a value (if there are any). You can override this behavior with the `accountReturnFirstLink` property. - You can filter the multiple accounts returned based on the data they contain so that you can target specific accounts. This is often used to target accounts that are "active" instead of those that are not. ::: diff --git a/products/idn/docs/identity-now/transforms/operations/base64-decode.md b/docs/extensibility/transforms/operations/base64-decode.md similarity index 99% rename from products/idn/docs/identity-now/transforms/operations/base64-decode.md rename to docs/extensibility/transforms/operations/base64-decode.md index 0fad59749..3db723162 100644 --- a/products/idn/docs/identity-now/transforms/operations/base64-decode.md +++ b/docs/extensibility/transforms/operations/base64-decode.md @@ -6,7 +6,7 @@ sidebar_label: Base64 Decode sidebar_class_name: base64Decode keywords: ['transforms', 'operations', 'base64', 'decode'] description: Render base64 data in its original binary format. -slug: /docs/transforms/operations/base64-decode +slug: /extensibility/transforms/operations/base64-decode tags: ['Transforms', 'Transform Operations'] --- diff --git a/products/idn/docs/identity-now/transforms/operations/base64-encode.md b/docs/extensibility/transforms/operations/base64-encode.md similarity index 99% rename from products/idn/docs/identity-now/transforms/operations/base64-encode.md rename to docs/extensibility/transforms/operations/base64-encode.md index 4e5a91153..f803d9926 100644 --- a/products/idn/docs/identity-now/transforms/operations/base64-encode.md +++ b/docs/extensibility/transforms/operations/base64-encode.md @@ -6,7 +6,7 @@ sidebar_label: Base64 Encode sidebar_class_name: base64Encode keywords: ['transforms', 'operations', 'base64', 'encode'] description: Encode data with a Base64-based text encoding scheme. -slug: /docs/transforms/operations/base64-encode +slug: /extensibility/transforms/operations/base64-encode tags: ['Transforms', 'Transform Operations'] --- diff --git a/products/idn/docs/identity-now/transforms/operations/concatenation.md b/docs/extensibility/transforms/operations/concatenation.md similarity index 97% rename from products/idn/docs/identity-now/transforms/operations/concatenation.md rename to docs/extensibility/transforms/operations/concatenation.md index 126f1d388..063606d84 100644 --- a/products/idn/docs/identity-now/transforms/operations/concatenation.md +++ b/docs/extensibility/transforms/operations/concatenation.md @@ -6,7 +6,7 @@ sidebar_label: Concatenation sidebar_class_name: concatenation keywords: ['transforms', 'operations', 'concatenation'] description: Join two or more string values into a combined output. -slug: /docs/transforms/operations/concatenation +slug: /extensibility/transforms/operations/concatenation tags: ['Transforms', 'Transform Operations'] --- diff --git a/products/idn/docs/identity-now/transforms/operations/conditional.md b/docs/extensibility/transforms/operations/conditional.md similarity index 98% rename from products/idn/docs/identity-now/transforms/operations/conditional.md rename to docs/extensibility/transforms/operations/conditional.md index e33525575..43bddccdc 100644 --- a/products/idn/docs/identity-now/transforms/operations/conditional.md +++ b/docs/extensibility/transforms/operations/conditional.md @@ -6,7 +6,7 @@ sidebar_label: Conditional sidebar_class_name: conditional keywords: ['transforms', 'operations', 'conditional'] description: Output different values depending on simple conditional logic. -slug: /docs/transforms/operations/conditional +slug: /extensibility/transforms/operations/conditional tags: ['Transforms', 'Transform Operations'] --- diff --git a/products/idn/docs/identity-now/transforms/operations/date-compare.md b/docs/extensibility/transforms/operations/date-compare.md similarity index 98% rename from products/idn/docs/identity-now/transforms/operations/date-compare.md rename to docs/extensibility/transforms/operations/date-compare.md index dcc176d4f..5ad89b8a0 100644 --- a/products/idn/docs/identity-now/transforms/operations/date-compare.md +++ b/docs/extensibility/transforms/operations/date-compare.md @@ -6,7 +6,7 @@ sidebar_label: Date Compare sidebar_class_name: dateCompare keywords: ['transforms', 'operations', 'date', 'compare'] description: Compare two dates and return a calculated value. -slug: /docs/transforms/operations/date-compare +slug: /extensibility/transforms/operations/date-compare tags: ['Transforms', 'Transform Operations'] --- diff --git a/products/idn/docs/identity-now/transforms/operations/date-format.md b/docs/extensibility/transforms/operations/date-format.md similarity index 98% rename from products/idn/docs/identity-now/transforms/operations/date-format.md rename to docs/extensibility/transforms/operations/date-format.md index 916e37400..e432da841 100644 --- a/products/idn/docs/identity-now/transforms/operations/date-format.md +++ b/docs/extensibility/transforms/operations/date-format.md @@ -6,7 +6,7 @@ sidebar_label: Date Format sidebar_class_name: dateFormat keywords: ['transforms', 'operations', 'date', 'format'] description: Convert datetime strings from one format to another. -slug: /docs/transforms/operations/date-format +slug: /extensibility/transforms/operations/date-format tags: ['Transforms', 'Transform Operations'] --- diff --git a/products/idn/docs/identity-now/transforms/operations/date-math.md b/docs/extensibility/transforms/operations/date-math.md similarity index 97% rename from products/idn/docs/identity-now/transforms/operations/date-math.md rename to docs/extensibility/transforms/operations/date-math.md index 2d62842f4..03555bbe8 100644 --- a/products/idn/docs/identity-now/transforms/operations/date-math.md +++ b/docs/extensibility/transforms/operations/date-math.md @@ -6,7 +6,7 @@ sidebar_label: Date Math sidebar_class_name: dateMath keywords: ['transforms', 'operations', 'date', 'math'] description: Add, subtract, and round components of a timestamp's incoming value. -slug: /docs/transforms/operations/date-math +slug: /extensibility/transforms/operations/date-math tags: ['Transforms', 'Transform Operations'] --- @@ -146,7 +146,7 @@ This transform takes the `startDate` attribute from a user's record in the "HR S

     

    -This transform take the `HIREDATE` from Workday and converts it to [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) to be used in the Date Math transform. The Date Math transform then creates a new Date of `HIREDATE + 1`. Since that is then outputted in the format "yyyy-MM-dd'T'HH:mm", you can then use it in a [dateFormat](/idn/docs/transforms/operations/date-format) transform to give a WIN32 formatted date. +This transform take the `HIREDATE` from Workday and converts it to [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) to be used in the Date Math transform. The Date Math transform then creates a new Date of `HIREDATE + 1`. Since that is then outputted in the format "yyyy-MM-dd'T'HH:mm", you can then use it in a [dateFormat](/docs/extensibility/transforms/operations/date-format) transform to give a WIN32 formatted date. **Transform Request Body**: diff --git a/products/idn/docs/identity-now/transforms/operations/decompose-diacritical-marks.md b/docs/extensibility/transforms/operations/decompose-diacritical-marks.md similarity index 98% rename from products/idn/docs/identity-now/transforms/operations/decompose-diacritical-marks.md rename to docs/extensibility/transforms/operations/decompose-diacritical-marks.md index af1e6aabd..974060751 100644 --- a/products/idn/docs/identity-now/transforms/operations/decompose-diacritical-marks.md +++ b/docs/extensibility/transforms/operations/decompose-diacritical-marks.md @@ -6,7 +6,7 @@ sidebar_label: Decompose Diacritial Marks sidebar_class_name: decomposeDiacriticalMarks keywords: ['transforms', 'operations', 'decompose', 'diacritical', 'marks'] description: Clean or standardize symbols used within language. -slug: /docs/transforms/operations/decompose-diacritical-marks +slug: /extensibility/transforms/operations/decompose-diacritical-marks tags: ['Transforms', 'Transform Operations'] --- diff --git a/products/idn/docs/identity-now/transforms/operations/e164-phone.md b/docs/extensibility/transforms/operations/e164-phone.md similarity index 98% rename from products/idn/docs/identity-now/transforms/operations/e164-phone.md rename to docs/extensibility/transforms/operations/e164-phone.md index 0f64e1944..847cba5ed 100644 --- a/products/idn/docs/identity-now/transforms/operations/e164-phone.md +++ b/docs/extensibility/transforms/operations/e164-phone.md @@ -6,7 +6,7 @@ sidebar_label: E.164 Phone sidebar_class_name: e164Phone keywords: ['transforms', 'operations', 'e164', 'phone'] description: Convert a phone number string into an E.164-compatible number. -slug: /docs/transforms/operations/e164-phone +slug: /extensibility/transforms/operations/e164-phone tags: ['Transforms', 'Transform Operations'] --- diff --git a/products/idn/docs/identity-now/transforms/operations/first-valid.md b/docs/extensibility/transforms/operations/first-valid.md similarity index 99% rename from products/idn/docs/identity-now/transforms/operations/first-valid.md rename to docs/extensibility/transforms/operations/first-valid.md index 5c4cd70ee..6a2cb2230 100644 --- a/products/idn/docs/identity-now/transforms/operations/first-valid.md +++ b/docs/extensibility/transforms/operations/first-valid.md @@ -6,7 +6,7 @@ sidebar_label: First Valid sidebar_class_name: firstValid keywords: ['transforms', 'operations', 'first', 'valid'] description: Return the first piece of data that is not null. -slug: /docs/transforms/operations/first-valid +slug: /extensibility/transforms/operations/first-valid tags: ['Transforms', 'Transform Operations'] --- diff --git a/products/idn/docs/identity-now/transforms/operations/generate-random-string.md b/docs/extensibility/transforms/operations/generate-random-string.md similarity index 98% rename from products/idn/docs/identity-now/transforms/operations/generate-random-string.md rename to docs/extensibility/transforms/operations/generate-random-string.md index 84bb94c8f..a48f201be 100644 --- a/products/idn/docs/identity-now/transforms/operations/generate-random-string.md +++ b/docs/extensibility/transforms/operations/generate-random-string.md @@ -6,7 +6,7 @@ sidebar_label: Generate Random String sidebar_class_name: generateRandomString keywords: ['transforms', 'operations', 'generate', 'random', 'string'] description: Generate a random string of any length. -slug: /docs/transforms/operations/generate-random-string +slug: /extensibility/transforms/operations/generate-random-string tags: ['Transforms', 'Transform Operations'] --- diff --git a/products/idn/docs/identity-now/transforms/operations/get-end-of-string.md b/docs/extensibility/transforms/operations/get-end-of-string.md similarity index 97% rename from products/idn/docs/identity-now/transforms/operations/get-end-of-string.md rename to docs/extensibility/transforms/operations/get-end-of-string.md index 59f4dfb0b..e0c1759b2 100644 --- a/products/idn/docs/identity-now/transforms/operations/get-end-of-string.md +++ b/docs/extensibility/transforms/operations/get-end-of-string.md @@ -6,7 +6,7 @@ sidebar_label: Get End of String sidebar_class_name: getEndOfString keywords: ['transforms', 'operations', 'get', 'end', 'string'] description: Get the rightmost N characters of a string. -slug: /docs/transforms/operations/get-end-of-string +slug: /extensibility/transforms/operations/get-end-of-string tags: ['Transforms', 'Transform Operations'] --- diff --git a/products/idn/docs/identity-now/transforms/operations/get-reference-identity-attribute.md b/docs/extensibility/transforms/operations/get-reference-identity-attribute.md similarity index 97% rename from products/idn/docs/identity-now/transforms/operations/get-reference-identity-attribute.md rename to docs/extensibility/transforms/operations/get-reference-identity-attribute.md index 024ae9360..82326455b 100644 --- a/products/idn/docs/identity-now/transforms/operations/get-reference-identity-attribute.md +++ b/docs/extensibility/transforms/operations/get-reference-identity-attribute.md @@ -7,7 +7,7 @@ sidebar_class_name: getReferenceIdentityAttribute keywords: ['transforms', 'operations', 'get', 'reference', 'identity', 'attribute'] description: Get another user's identity attribute. -slug: /docs/transforms/operations/get-reference-identity-attribute +slug: /extensibility/transforms/operations/get-reference-identity-attribute tags: ['Transforms', 'Transform Operations'] --- diff --git a/products/idn/docs/identity-now/transforms/operations/identity-attribute.md b/docs/extensibility/transforms/operations/identity-attribute.md similarity index 97% rename from products/idn/docs/identity-now/transforms/operations/identity-attribute.md rename to docs/extensibility/transforms/operations/identity-attribute.md index 5229b58c1..431e8aaa1 100644 --- a/products/idn/docs/identity-now/transforms/operations/identity-attribute.md +++ b/docs/extensibility/transforms/operations/identity-attribute.md @@ -6,7 +6,7 @@ sidebar_label: Identity Attribute sidebar_class_name: identityAttribute keywords: ['transforms', 'operations', 'identity', 'attribute'] description: Get a user's identity attribute's value. -slug: /docs/transforms/operations/identity-attribute +slug: /extensibility/transforms/operations/identity-attribute tags: ['Transforms', 'Transform Operations'] --- diff --git a/products/idn/docs/identity-now/transforms/operations/img/lower_transform_input.png b/docs/extensibility/transforms/operations/img/lower_transform_input.png similarity index 100% rename from products/idn/docs/identity-now/transforms/operations/img/lower_transform_input.png rename to docs/extensibility/transforms/operations/img/lower_transform_input.png diff --git a/products/idn/docs/identity-now/transforms/operations/img/sailpoint_logo.png b/docs/extensibility/transforms/operations/img/sailpoint_logo.png similarity index 100% rename from products/idn/docs/identity-now/transforms/operations/img/sailpoint_logo.png rename to docs/extensibility/transforms/operations/img/sailpoint_logo.png diff --git a/products/idn/docs/identity-now/transforms/operations/index-of.md b/docs/extensibility/transforms/operations/index-of.md similarity index 98% rename from products/idn/docs/identity-now/transforms/operations/index-of.md rename to docs/extensibility/transforms/operations/index-of.md index df3e67c59..79161acb8 100644 --- a/products/idn/docs/identity-now/transforms/operations/index-of.md +++ b/docs/extensibility/transforms/operations/index-of.md @@ -6,7 +6,7 @@ sidebar_label: Index Of sidebar_class_name: indexOf keywords: ['transforms', 'operations', 'index', 'of'] description: Get the location of a specific substring within a value. -slug: /docs/transforms/operations/index-of +slug: /extensibility/transforms/operations/index-of tags: ['Transforms', 'Transform Operations'] --- diff --git a/products/idn/docs/identity-now/transforms/operations/index.md b/docs/extensibility/transforms/operations/index.md similarity index 94% rename from products/idn/docs/identity-now/transforms/operations/index.md rename to docs/extensibility/transforms/operations/index.md index b99188de6..3a7ff3485 100644 --- a/products/idn/docs/identity-now/transforms/operations/index.md +++ b/docs/extensibility/transforms/operations/index.md @@ -6,7 +6,7 @@ sidebar_label: Operations sidebar_class_name: operations keywords: ['transforms', 'operations'] description: A list of transform operations. -slug: /docs/transforms/operations +slug: /extensibility/transforms/operations tags: ['Transforms', 'Transform Operations'] --- diff --git a/products/idn/docs/identity-now/transforms/operations/iso-3166.md b/docs/extensibility/transforms/operations/iso-3166.md similarity index 98% rename from products/idn/docs/identity-now/transforms/operations/iso-3166.md rename to docs/extensibility/transforms/operations/iso-3166.md index d30a2eeba..0915511bf 100644 --- a/products/idn/docs/identity-now/transforms/operations/iso-3166.md +++ b/docs/extensibility/transforms/operations/iso-3166.md @@ -6,7 +6,7 @@ sidebar_label: ISO3166 sidebar_class_name: iso3166 keywords: ['transforms', 'operations', 'iso3166'] description: Convert a string into an ISO 3166 country code value. -slug: /docs/transforms/operations/iso-3166 +slug: /extensibility/transforms/operations/iso-3166 tags: ['Transforms', 'Transform Operations'] --- diff --git a/products/idn/docs/identity-now/transforms/operations/last-index-of.md b/docs/extensibility/transforms/operations/last-index-of.md similarity index 98% rename from products/idn/docs/identity-now/transforms/operations/last-index-of.md rename to docs/extensibility/transforms/operations/last-index-of.md index 20348d18d..f15bb72a8 100644 --- a/products/idn/docs/identity-now/transforms/operations/last-index-of.md +++ b/docs/extensibility/transforms/operations/last-index-of.md @@ -6,7 +6,7 @@ sidebar_label: Last Index Of sidebar_class_name: lastIndexOf keywords: ['transforms', 'operations', 'last', 'index', 'of'] description: Returns last location of specific substring. -slug: /docs/transforms/operations/last-index-of +slug: /extensibility/transforms/operations/last-index-of tags: ['Transforms', 'Transform Operations'] --- diff --git a/products/idn/docs/identity-now/transforms/operations/left-pad.md b/docs/extensibility/transforms/operations/left-pad.md similarity index 98% rename from products/idn/docs/identity-now/transforms/operations/left-pad.md rename to docs/extensibility/transforms/operations/left-pad.md index 4ff0badf6..87e80c7c2 100644 --- a/products/idn/docs/identity-now/transforms/operations/left-pad.md +++ b/docs/extensibility/transforms/operations/left-pad.md @@ -6,7 +6,7 @@ sidebar_label: Left Pad sidebar_class_name: leftPad keywords: ['transforms', 'operations', 'left', 'pad'] description: Left pad of the input string. -slug: /docs/transforms/operations/left-pad +slug: /extensibility/transforms/operations/left-pad tags: ['Transforms', 'Transform Operations'] --- diff --git a/products/idn/docs/identity-now/transforms/operations/lookup.md b/docs/extensibility/transforms/operations/lookup.md similarity index 98% rename from products/idn/docs/identity-now/transforms/operations/lookup.md rename to docs/extensibility/transforms/operations/lookup.md index 3a89e6632..22f56a1e3 100644 --- a/products/idn/docs/identity-now/transforms/operations/lookup.md +++ b/docs/extensibility/transforms/operations/lookup.md @@ -6,7 +6,7 @@ sidebar_label: Lookup sidebar_class_name: lookup keywords: ['transforms', 'operations', 'lookup'] description: Look up and return a key's matching value. -slug: /docs/transforms/operations/lookup +slug: /extensibility/transforms/operations/lookup tags: ['Transforms', 'Transform Operations'] --- diff --git a/products/idn/docs/identity-now/transforms/operations/lower.md b/docs/extensibility/transforms/operations/lower.md similarity index 97% rename from products/idn/docs/identity-now/transforms/operations/lower.md rename to docs/extensibility/transforms/operations/lower.md index 2e6ede5c9..66493c153 100644 --- a/products/idn/docs/identity-now/transforms/operations/lower.md +++ b/docs/extensibility/transforms/operations/lower.md @@ -6,7 +6,7 @@ sidebar_label: Lower sidebar_class_name: lower keywords: ['transforms', 'operations', 'lower'] description: Convert an input string into all lowercase letters. -slug: /docs/transforms/operations/lower +slug: /extensibility/transforms/operations/lower tags: ['Transforms', 'Transform Operations'] --- diff --git a/products/idn/docs/identity-now/transforms/operations/name-normalizer.md b/docs/extensibility/transforms/operations/name-normalizer.md similarity index 98% rename from products/idn/docs/identity-now/transforms/operations/name-normalizer.md rename to docs/extensibility/transforms/operations/name-normalizer.md index 5bec80d10..549fb520b 100644 --- a/products/idn/docs/identity-now/transforms/operations/name-normalizer.md +++ b/docs/extensibility/transforms/operations/name-normalizer.md @@ -6,7 +6,7 @@ sidebar_label: Name Normalizer sidebar_class_name: nameNormalizer keywords: ['transforms', 'operations', 'name normalizer'] description: Clean or standardize the spelling of strings coming in from source systems. -slug: /docs/transforms/operations/name-normalizer +slug: /extensibility/transforms/operations/name-normalizer tags: ['Transforms', 'Transform Operations'] --- diff --git a/products/idn/docs/identity-now/transforms/operations/random-alphanumeric.md b/docs/extensibility/transforms/operations/random-alphanumeric.md similarity index 97% rename from products/idn/docs/identity-now/transforms/operations/random-alphanumeric.md rename to docs/extensibility/transforms/operations/random-alphanumeric.md index 56ac89130..328642530 100644 --- a/products/idn/docs/identity-now/transforms/operations/random-alphanumeric.md +++ b/docs/extensibility/transforms/operations/random-alphanumeric.md @@ -6,7 +6,7 @@ sidebar_label: Random Alphanumeric sidebar_class_name: randomAlphanumeric keywords: ['transforms', 'operations', 'random alphanumeric'] description: Generate a random string of any length. -slug: /docs/transforms/operations/random-alphanumeric +slug: /extensibility/transforms/operations/random-alphanumeric tags: ['Transforms', 'Transform Operations'] --- diff --git a/products/idn/docs/identity-now/transforms/operations/random-numeric.md b/docs/extensibility/transforms/operations/random-numeric.md similarity index 96% rename from products/idn/docs/identity-now/transforms/operations/random-numeric.md rename to docs/extensibility/transforms/operations/random-numeric.md index 5a3756226..d3224071d 100644 --- a/products/idn/docs/identity-now/transforms/operations/random-numeric.md +++ b/docs/extensibility/transforms/operations/random-numeric.md @@ -6,7 +6,7 @@ sidebar_label: Random Numeric sidebar_class_name: randomNumeric keywords: ['transforms', 'operations', 'random numeric'] description: Generate a random number of any length. -slug: /docs/transforms/operations/random-numeric +slug: /extensibility/transforms/operations/random-numeric tags: ['Transforms', 'Transform Operations'] --- diff --git a/products/idn/docs/identity-now/transforms/operations/reference.md b/docs/extensibility/transforms/operations/reference.md similarity index 98% rename from products/idn/docs/identity-now/transforms/operations/reference.md rename to docs/extensibility/transforms/operations/reference.md index f924d1bbc..ec5f5c100 100644 --- a/products/idn/docs/identity-now/transforms/operations/reference.md +++ b/docs/extensibility/transforms/operations/reference.md @@ -6,7 +6,7 @@ sidebar_label: Reference sidebar_class_name: reference keywords: ['transforms', 'operations', 'reference'] description: Reuse a transform that has already been written. -slug: /docs/transforms/operations/reference +slug: /extensibility/transforms/operations/reference tags: ['Transforms', 'Transform Operations'] --- diff --git a/products/idn/docs/identity-now/transforms/operations/replace-all.md b/docs/extensibility/transforms/operations/replace-all.md similarity index 98% rename from products/idn/docs/identity-now/transforms/operations/replace-all.md rename to docs/extensibility/transforms/operations/replace-all.md index 24df71e09..6476d2157 100644 --- a/products/idn/docs/identity-now/transforms/operations/replace-all.md +++ b/docs/extensibility/transforms/operations/replace-all.md @@ -6,7 +6,7 @@ sidebar_label: Replace All sidebar_class_name: replaceAll keywords: ['transforms', 'operations', 'replace all'] description: Find and replace all instances of all patterns. -slug: /docs/transforms/operations/replace-all +slug: /extensibility/transforms/operations/replace-all tags: ['Transforms', 'Transform Operations'] --- diff --git a/products/idn/docs/identity-now/transforms/operations/replace.md b/docs/extensibility/transforms/operations/replace.md similarity index 92% rename from products/idn/docs/identity-now/transforms/operations/replace.md rename to docs/extensibility/transforms/operations/replace.md index 30b83d5ef..be2fb22ac 100644 --- a/products/idn/docs/identity-now/transforms/operations/replace.md +++ b/docs/extensibility/transforms/operations/replace.md @@ -6,7 +6,7 @@ sidebar_label: Replace sidebar_class_name: replace keywords: ['transforms', 'operations', 'replace'] description: Find and replace all instances of a single string. -slug: /docs/transforms/operations/replace +slug: /extensibility/transforms/operations/replace tags: ['Transforms', 'Transform Operations'] --- @@ -22,7 +22,7 @@ The replace transform takes a `regex` attribute as an argument to identify which { "attributes": { "regex": "IIQ", - "replacement": "IdentityNow" + "replacement": "Identity Security Cloud" }, "type": "replace", "name": "Replace Transform" @@ -44,11 +44,11 @@ The replace transform takes a `regex` attribute as an argument to identify which ## Examples -This transform makes a simple word replacement, exchanging "IIQ" for "IdentityNow". +This transform makes a simple word replacement, exchanging "IIQ" for "Identity Security Cloud". ```bash Input: "Working with IIQ is fun" -Output: "Working with IdentityNow is fun" +Output: "Working with Identity Security Cloud is fun" ``` **Transform Request Body**: @@ -57,7 +57,7 @@ Output: "Working with IdentityNow is fun" { "attributes": { "regex": "IIQ", - "replacement": "IdentityNow" + "replacement": "Identity Security Cloud" }, "type": "replace", "name": "Replace Transform" diff --git a/products/idn/docs/identity-now/transforms/operations/right-pad.md b/docs/extensibility/transforms/operations/right-pad.md similarity index 98% rename from products/idn/docs/identity-now/transforms/operations/right-pad.md rename to docs/extensibility/transforms/operations/right-pad.md index 11efdb291..f773192a2 100644 --- a/products/idn/docs/identity-now/transforms/operations/right-pad.md +++ b/docs/extensibility/transforms/operations/right-pad.md @@ -6,7 +6,7 @@ sidebar_label: Right Pad sidebar_class_name: rightPad keywords: ['transforms', 'operations', 'right pad'] description: Add padding to the right of an incoming string. -slug: /docs/transforms/operations/right-pad +slug: /extensibility/transforms/operations/right-pad tags: ['Transforms', 'Transform Operations'] --- diff --git a/products/idn/docs/identity-now/transforms/operations/rule.md b/docs/extensibility/transforms/operations/rule.md similarity index 98% rename from products/idn/docs/identity-now/transforms/operations/rule.md rename to docs/extensibility/transforms/operations/rule.md index 3fa3448ab..146002f4f 100644 --- a/products/idn/docs/identity-now/transforms/operations/rule.md +++ b/docs/extensibility/transforms/operations/rule.md @@ -6,7 +6,7 @@ sidebar_label: Rule sidebar_class_name: rule keywords: ['transforms', 'operations', 'rule'] description: Reuse rule logic that has already been written for a previous use case. -slug: /docs/transforms/operations/rule +slug: /extensibility/transforms/operations/rule tags: ['Transforms', 'Transform Operations'] --- diff --git a/products/idn/docs/identity-now/transforms/operations/split.md b/docs/extensibility/transforms/operations/split.md similarity index 98% rename from products/idn/docs/identity-now/transforms/operations/split.md rename to docs/extensibility/transforms/operations/split.md index 27c670d7e..e13660cc1 100644 --- a/products/idn/docs/identity-now/transforms/operations/split.md +++ b/docs/extensibility/transforms/operations/split.md @@ -6,7 +6,7 @@ sidebar_label: Split sidebar_class_name: split keywords: ['transforms', 'operations', 'split'] description: Return the Nth element of a split array. -slug: /docs/transforms/operations/split +slug: /extensibility/transforms/operations/split tags: ['Transforms', 'Transform Operations'] --- diff --git a/products/idn/docs/identity-now/transforms/operations/static.md b/docs/extensibility/transforms/operations/static.md similarity index 89% rename from products/idn/docs/identity-now/transforms/operations/static.md rename to docs/extensibility/transforms/operations/static.md index b6d2c893a..9e4593aad 100644 --- a/products/idn/docs/identity-now/transforms/operations/static.md +++ b/docs/extensibility/transforms/operations/static.md @@ -6,7 +6,7 @@ sidebar_label: Static sidebar_class_name: static keywords: ['transforms', 'operations', 'static'] description: Return a fixed string value. -slug: /docs/transforms/operations/static +slug: /extensibility/transforms/operations/static tags: ['Transforms', 'Transform Operations'] --- @@ -17,7 +17,7 @@ Use the static transform to return a fixed string value, or more commonly, to ev :::note Other Considerations - When you are using static transforms within the create profile for a source, you can enter the value directly in the input field if the user selects Static as the attribute type. -- Because IdentityNow supports the ability to order attributes in a create profile, you can use the Velocity template of an attribute higher in the list to generate a static value for an attribute that is lower in the list. For example, if you wanted to generate an email address based on a display name, you would need to do the follwing: +- Because Identity Security Cloud supports the ability to order attributes in a create profile, you can use the Velocity template of an attribute higher in the list to generate a static value for an attribute that is lower in the list. For example, if you wanted to generate an email address based on a display name, you would need to do the follwing: - Move the "displayName" attribute higher in the list so that it is created before the email address. - In the "mail" attribute, select Static for the attribute type. In the Static Value field, enter `$displayName@yourdomain.com`. diff --git a/products/idn/docs/identity-now/transforms/operations/substring.md b/docs/extensibility/transforms/operations/substring.md similarity index 98% rename from products/idn/docs/identity-now/transforms/operations/substring.md rename to docs/extensibility/transforms/operations/substring.md index 6cf135736..e6f71f276 100644 --- a/products/idn/docs/identity-now/transforms/operations/substring.md +++ b/docs/extensibility/transforms/operations/substring.md @@ -6,7 +6,7 @@ sidebar_label: Substring sidebar_class_name: substring keywords: ['transforms', 'operations', 'substring'] description: Get the inner portion of a string passed into the transform. -slug: /docs/transforms/operations/substring +slug: /extensibility/transforms/operations/substring tags: ['Transforms', 'Transform Operations'] --- diff --git a/products/idn/docs/identity-now/transforms/operations/trim.md b/docs/extensibility/transforms/operations/trim.md similarity index 97% rename from products/idn/docs/identity-now/transforms/operations/trim.md rename to docs/extensibility/transforms/operations/trim.md index e34f33e60..037e4353f 100644 --- a/products/idn/docs/identity-now/transforms/operations/trim.md +++ b/docs/extensibility/transforms/operations/trim.md @@ -6,7 +6,7 @@ sidebar_label: Trim sidebar_class_name: trim keywords: ['transforms', 'operations', 'trim'] description: Trim whitespaces from both the beginning and ending of input strings. -slug: /docs/transforms/operations/trim +slug: /extensibility/transforms/operations/trim tags: ['Transforms', 'Transform Operations'] --- diff --git a/products/idn/docs/identity-now/transforms/operations/upper.md b/docs/extensibility/transforms/operations/upper.md similarity index 97% rename from products/idn/docs/identity-now/transforms/operations/upper.md rename to docs/extensibility/transforms/operations/upper.md index e7453c40e..a08538c06 100644 --- a/products/idn/docs/identity-now/transforms/operations/upper.md +++ b/docs/extensibility/transforms/operations/upper.md @@ -6,7 +6,7 @@ sidebar_label: Upper sidebar_class_name: upper keywords: ['transforms', 'operations', 'upper'] description: Convert an input string into all uppercase letters. -slug: /docs/transforms/operations/upper +slug: /extensibility/transforms/operations/upper tags: ['Transforms', 'Transform Operations'] --- diff --git a/products/idn/docs/identity-now/transforms/operations/username-generator.md b/docs/extensibility/transforms/operations/username-generator.md similarity index 94% rename from products/idn/docs/identity-now/transforms/operations/username-generator.md rename to docs/extensibility/transforms/operations/username-generator.md index 0a2ca42e6..62ab0db74 100644 --- a/products/idn/docs/identity-now/transforms/operations/username-generator.md +++ b/docs/extensibility/transforms/operations/username-generator.md @@ -6,7 +6,7 @@ sidebar_label: Username Generator sidebar_class_name: usernameGenerator keywords: ['transforms', 'operations', 'username', 'generator'] description: Derive a unique value for an attribute in an account create profile. -slug: /docs/transforms/operations/username-generator +slug: /extensibility/transforms/operations/username-generator tags: ['Transforms', 'Transform Operations'] --- @@ -25,7 +25,7 @@ Use the username generator transform to specify logic to use when it derives a u The username generator transform is intended for use as a configuration within the account create profile for a source. Thus, this transform's structure is more extensive than a typical Seaspray implementation -- it must be assigned to a create profile attribute (designated by `name`) and provide certain uniqueness check attributes such as `cloudMaxSize`, `cloudMaxUniqueChecks`, and `cloudRequired`. -The `cloudMaxSize` attribute denotes the maximum length of generated data allowable as a result of the generator logic. The transform truncates any characters over the `cloudMaxSize`. The `cloudMaxUniqueChecks` attribute determines the maximum number of iterations the generator must attempt before failing to generate a value. The `cloudRequired` attribute is an internal flag required for the IdentityNow platform - leave it as `true`. +The `cloudMaxSize` attribute denotes the maximum length of generated data allowable as a result of the generator logic. The transform truncates any characters over the `cloudMaxSize`. The `cloudMaxUniqueChecks` attribute determines the maximum number of iterations the generator must attempt before failing to generate a value. The `cloudRequired` attribute is an internal flag required for the Identity Security Cloud platform - leave it as `true`. Provide the username generator transform itself in the create profile attribute entry's `transform` parameter. @@ -101,9 +101,9 @@ Provide the username generator transform itself in the create profile attribute > **Note** that you can leverage `$uniqueCounter` here to automatically increment a counter if the generated value is not available and you want to try appending numeric values (i.e., 1, 2, 3, etc.) instead of progressing beyond the current pattern. - **Optional Attributes** - - **sourceCheck** - This boolean value (true/false) indicates whether the generator must check only the IdentityNow database's representation of accounts for uniqueness, or whether it must query the target system directly. If no value is provided, the attribute defaults to `false`. + - **sourceCheck** - This boolean value (true/false) indicates whether the generator must check only the Identity Security Cloud database's representation of accounts for uniqueness, or whether it must query the target system directly. If no value is provided, the attribute defaults to `false`. - `true` indicates the generator must check the target system directly. The generator only respects this setting if the system supports the `getObject` functionality. For systems that lack the ability to query for single account objects, the generator ignores this setting and defaults to `false`. The generator only checks the attribute identified in the account schema as the `accountID`. - - `false` indicates the generator must check only the IdentityNow database of accounts. The generator only checks the `accountID`. + - `false` indicates the generator must check only the Identity Security Cloud database of accounts. The generator only checks the `accountID`. ## Examples diff --git a/products/idn/docs/identity-now/transforms/operations/uuid-generator.md b/docs/extensibility/transforms/operations/uuid-generator.md similarity index 96% rename from products/idn/docs/identity-now/transforms/operations/uuid-generator.md rename to docs/extensibility/transforms/operations/uuid-generator.md index 1d8d5d59b..f5f1c6299 100644 --- a/products/idn/docs/identity-now/transforms/operations/uuid-generator.md +++ b/docs/extensibility/transforms/operations/uuid-generator.md @@ -6,7 +6,7 @@ sidebar_label: UUID Generator sidebar_class_name: uuidGenerator keywords: ['transforms', 'operations', 'uuid', 'generator'] description: Create a universal unique ID (UUID). -slug: /docs/transforms/operations/uuid-generator +slug: /extensibility/transforms/operations/uuid-generator tags: ['Transforms', 'Transform Operations'] --- diff --git a/docs/guides.md b/docs/guides.md new file mode 100644 index 000000000..5c9e53525 --- /dev/null +++ b/docs/guides.md @@ -0,0 +1,27 @@ +--- +id: guides +title: Guides +pagination_label: Guides +sidebar_label: Guides +sidebar_position: 1 +sidebar_class_name: guides +keywords: ['guides'] +description: ISC guides. +slug: /guides +tags: ['guides'] +--- + +## Overview +Identity Security Cloud (ISC) has all sorts of potential specific solutions you can implement as long as you know how. These specific solutions may either not fall into one of the extensibility, connectivity, tools, or reporting categories, or they may fall into multiple categories. Read these guides to learn how to implement these specific solutions. + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + +## Discuss +The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions. + +To learn more about these ISC topics and discuss them with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/isc/6). \ No newline at end of file diff --git a/docs/guides/disable-access-profile-requests.md b/docs/guides/disable-access-profile-requests.md new file mode 100644 index 000000000..814f63a79 --- /dev/null +++ b/docs/guides/disable-access-profile-requests.md @@ -0,0 +1,129 @@ +--- +id: disable-access-profile-requests +title: Disable Access Profile Requests +pagination_label: Disable Access Profile Requests +sidebar_label: Disable Access Profile Requests +sidebar_position: 1 +sidebar_class_name: disableAccessProfileRequests +keywords: ['access', 'request', 'access profile', 'request center', 'disable'] +description: Bulk disable access profile requests. +slug: /guides/disable-access-profile-requests +tags: ['AccessProfileRequestManagement'] +--- + +## Overview +In Identity Security Cloud, [access profiles](https://documentation.sailpoint.com/saas/help/access/access-profiles.html) are groups of [entitlements](https://documentation.sailpoint.com/saas/help/access/entitlements.html), which represent access rights on [sources](https://documentation.sailpoint.com/saas/help/sources/index.html). By default, all access profiles are marked as requestable. This means that an organization's users can submit [access requests](https://documentation.sailpoint.com/saas/help/requests/index.html) for the access profiles in the Identity Security Cloud [Request Center](https://documentation.sailpoint.com/saas/user-help/requests/request_center.html), where all access profiles are listed. + +You can disable requests for access profiles to prevent users from gaining inappropriate or undesired access. In the UI, you can edit the [individual access profile](https://documentation.sailpoint.com/saas/help/requests/config_ap_roles.html#configuring-access-profiles-for-requests) to disable requests for the access profile. You can also use the [PATCH Access Profile endpoint](https://developer.sailpoint.com/docs/api/v3/patch-access-profile) to mark the individual access profile as non-requestable. + +You may have many access profiles that you want to disable requests for, and you don't want one to get overlooked and then inappropriately accessed. There are three different processes you can use to ensure that you have disabled requests for all access profiles that aren't currently associated with [applications](https://documentation.sailpoint.com/saas/help/common/app-config.html) configured for access requests. Read this guide to learn how to perform these processes. + +## Disable requests for individual access profiles with the UI +Follow these steps to use the Identity Security Cloud UI to individually disable requests for all access profiles that aren't currently associated with applications: + +1. Identify the access profiles that are associated with applications configured for access requests. Create a list of these associated access profiles. +- Go to **Admin > Applications** and open each application you use for access requests. These applications have both 'Visible in the Request Center' and 'Allow Access Requests' marked on the 'Configuration' tab. +- Go to the application's 'Access' tab and capture the names of each application's associated access profiles, recording them in your list of access profiles. +2. Edit each access profile that is **not** in your list to disable access requests. +- Go to **Admin > Access > Access Profiles** to view a list of all access profiles. +- For each access profile that isn't in your list of those associated with applications configured for access requests, select 'Edit', go to the 'Access Requests' tab, and disable 'Allow Access Requests'. Then save your changes. + +Once you have performed this process, all the access profiles that aren't currently associated with applications will no longer be requestable. + +## Disable requests for individual access profiles with the API +Follow these steps to use two API endpoints to individually disable access requests for all access profiles that aren't currently associated with applications: + +1. Use the [Search endpoint](https://developer.sailpoint.com/docs/api/v3/search-post) to identify the access profiles that are **not** associated with applications configured for access requests. Sending the following query will return a list of these unassociated access profiles. +- Provide this request body. It will return all access profiles that have a null or empty `apps` list. +``` +{ + "queryDsl": { + "bool": { + "must_not": [ + { + "nested": { + "path": "apps", + "query": { + "exists": { + "field": "apps" + } + } + } + } + ] + } + }, + "queryType": "DSL", + "indices": [ + "accessprofiles" + ], + "sort": [ + "name" + ] +} +``` +- The response body will include all the details of each unassociated access profile. Extract the `id` for each access profile returned. +2. Use the [PATCH Access Profile endpoint](https://developer.sailpoint.com/docs/api/v3/patch-access-profile) and provide the unassociated access profile's `id` to update the specified access profile's `requestable` field. +- Provide this request body. It will use the `replace` operation to update the value in the specified access profile's `requestable` path to `false`. +``` +[ + { + "op": "replace", + "path": "/requestable", + "value": "false" + } +] +``` +- After a successful PATCH update, the response body will include all the specified access profile's details, including the updated `false` value in the `requestable` path. + +Once you have performed this process for each of the unassociated access profiles returned in your search, all the access profiles that aren't associated with applications will no longer be requestable. + +## Bulk disable requests for access profiles with the API +Follow these steps to use two API endpoints to bulk disable access requests for all access profiles that aren't currently associated with applications: +1. Use the [Search endpoint](https://developer.sailpoint.com/docs/api/v3/search-post) to identify the access profiles that are **not** associated with applications configured for access requests. Sending the following query will return a list of these unassociated access profiles. +- Provide this request body. It will return all access profiles that have a null or empty `apps` list. +``` +{ + "queryDsl": { + "bool": { + "must_not": [ + { + "nested": { + "path": "apps", + "query": { + "exists": { + "field": "apps" + } + } + } + } + ] + } + }, + "queryType": "DSL", + "indices": [ + "accessprofiles" + ], + "sort": [ + "name" + ] +} +``` +- The response body will include all the details of each unassociated access profile. Extract the `id` for each access profile returned. +2. Use the [Update Requestability for Access Profiles endpoint](https://developer.sailpoint.com/docs/api/beta/update-access-profiles-in-bulk) and provide every unassociated access profile's `id`, along with the updated values for their `requestable` fields. +- Provide this request body. It can bulk update all the access profiles you specify - you just need to specify each access profile's `id` and the `requestable` value you want for the access profile. +``` +[ + { + "id": "813b1e19281645278f9c9f665ea911c9", + "requestable": "false" + }, + { + "id": "c80bd9a30d42468f9a3646f39cdd7c74", + "requestable": "false" + } + ] +``` +- After a successful update, the response body will include the `id` and new `requestable` values for all the updated access profiles, along with confirmations that they were successfully updated. + +Once you have performed this process for all the unassociated access profiles returned in your search, all the access profiles that aren't associated with applications will no longer be requestable. \ No newline at end of file diff --git a/products/idn/docs/identity-now/global-platform-resources/img/idn-console.PNG b/docs/guides/img/idn-console.PNG similarity index 100% rename from products/idn/docs/identity-now/global-platform-resources/img/idn-console.PNG rename to docs/guides/img/idn-console.PNG diff --git a/products/idn/docs/identity-now/global-platform-resources/img/postman1.PNG b/docs/guides/img/postman1.PNG similarity index 100% rename from products/idn/docs/identity-now/global-platform-resources/img/postman1.PNG rename to docs/guides/img/postman1.PNG diff --git a/products/idn/docs/identity-now/global-platform-resources/img/postman2.PNG b/docs/guides/img/postman2.PNG similarity index 100% rename from products/idn/docs/identity-now/global-platform-resources/img/postman2.PNG rename to docs/guides/img/postman2.PNG diff --git a/products/idn/api/img/service-accounts/account-schema.png b/docs/guides/img/service-accounts/account-schema.png similarity index 100% rename from products/idn/api/img/service-accounts/account-schema.png rename to docs/guides/img/service-accounts/account-schema.png diff --git a/products/idn/api/img/service-accounts/create-identity-profile.png b/docs/guides/img/service-accounts/create-identity-profile.png similarity index 100% rename from products/idn/api/img/service-accounts/create-identity-profile.png rename to docs/guides/img/service-accounts/create-identity-profile.png diff --git a/products/idn/api/img/service-accounts/download-schema.png b/docs/guides/img/service-accounts/download-schema.png similarity index 100% rename from products/idn/api/img/service-accounts/download-schema.png rename to docs/guides/img/service-accounts/download-schema.png diff --git a/products/idn/api/img/service-accounts/import-accounts.png b/docs/guides/img/service-accounts/import-accounts.png similarity index 100% rename from products/idn/api/img/service-accounts/import-accounts.png rename to docs/guides/img/service-accounts/import-accounts.png diff --git a/products/idn/api/img/service-accounts/imported-account.png b/docs/guides/img/service-accounts/imported-account.png similarity index 100% rename from products/idn/api/img/service-accounts/imported-account.png rename to docs/guides/img/service-accounts/imported-account.png diff --git a/products/idn/api/img/service-accounts/invite.png b/docs/guides/img/service-accounts/invite.png similarity index 100% rename from products/idn/api/img/service-accounts/invite.png rename to docs/guides/img/service-accounts/invite.png diff --git a/products/idn/api/img/service-accounts/login.png b/docs/guides/img/service-accounts/login.png similarity index 100% rename from products/idn/api/img/service-accounts/login.png rename to docs/guides/img/service-accounts/login.png diff --git a/products/idn/api/img/service-accounts/mappings.png b/docs/guides/img/service-accounts/mappings.png similarity index 100% rename from products/idn/api/img/service-accounts/mappings.png rename to docs/guides/img/service-accounts/mappings.png diff --git a/products/idn/docs/identity-now/global-platform-resources/ip-address-allow-list.md b/docs/guides/ip-address-allow-list.md similarity index 75% rename from products/idn/docs/identity-now/global-platform-resources/ip-address-allow-list.md rename to docs/guides/ip-address-allow-list.md index 1ad6c41ed..36f274b55 100644 --- a/products/idn/docs/identity-now/global-platform-resources/ip-address-allow-list.md +++ b/docs/guides/ip-address-allow-list.md @@ -3,16 +3,14 @@ id: ip-address-allow-list title: IP Address Allow List pagination_label: IP Address Allow List sidebar_label: IP Address Allow List -sidebar_position: 8 +sidebar_position: 2 sidebar_class_name: allowList keywords: ['connectivity', 'connectors', 'workflows', 'allowlist','ip address'] -description: This document outlines how to create an IP Address Allow List for secure access to internal resources by certain IdentityNow services, and how to find your tenant's hosting region to set up this list​. -slug: /docs/global-platform-resources/ip-address-allow-list +description: Create an IP Address Allow List​. +slug: /guides/ip-address-allow-list tags: ['Connectivity', 'connectors', 'workflows', 'allowlist','ip address'] --- -# IP Address Allow List - ## Overview Some SaaS services like Workflows and SaaS Connectivity might need to reach out to internal resources to perform operations inside a customer environment. Instead of opening up those internal resources to the entire internet, you can create an IP Address Allow List so that you can be sure that all SaaS resources can access them while restricting the IP Address range to only allow what is required @@ -23,11 +21,11 @@ In order to create an IP Address Allow list, you need to know what region your t ### Finding your tenant using the admin console -Go to the admin console in IdentityNow and find the 'Org Details' section. You will find your tenant's host region there: +Go to the admin console in Identity Security Cloud and find the 'Org Details' section. You will find your tenant's host region there: ![img](./img/idn-console.PNG) -### Finding your tenant programatically using the IP address returned by IdentityNow +### Finding your tenant programatically using the IP address returned by Identity Security Cloud If you can't access the admin console or you want to dynamically find the region through code, follow these steps to find it: @@ -35,13 +33,13 @@ If you can't access the admin console or you want to dynamically find the region ![img](./img/postman1.PNG) -2. After a succesful call to IdentityNow, hover over the globe icon in the response window in postman to get the IP address: +2. After a succesful call to Identity Security Cloud, hover over the globe icon in the response window in postman to get the IP address: ![img](./img/postman2.PNG) 3. Download the [IP Address ranges from AWS](https://ip-ranges.amazonaws.com/ip-ranges.json) -4. Compare the IP address found when calling IdentityNow to the list provided by AWS to determine where your tenant is hosted. You can run a simple Python script to easily find what region the IP address belongs to: +4. Compare the IP address found when calling Identity Security Cloud to the list provided by AWS to determine where your tenant is hosted. You can run a simple Python script to easily find what region the IP address belongs to: ```python from ipaddress import ip_network, ip_address @@ -72,7 +70,7 @@ The URL used to find your range of allow list URLs can be constructed using the https://files.accessiq.sailpoint.com/network/REGION/FILENAME ``` -Where REGION is the region of your IdentityNow Tenant and FILENAME is one of the three following: +Where REGION is the region of your Identity Security Cloud Tenant and FILENAME is one of the three following: ``` source_ips.yaml @@ -96,7 +94,7 @@ which will result in a file similar to the following: - "52.206.146.115/32" ``` -These IP Address ranges can now be used as an allow list to permit any call from your IdentityNow tenant to access your internal network. +These IP Address ranges can now be used as an allow list to permit any call from your Identity Security Cloud tenant to access your internal network. ## Limitations diff --git a/products/idn/api/service-accounts.md b/docs/guides/service-accounts.md similarity index 77% rename from products/idn/api/service-accounts.md rename to docs/guides/service-accounts.md index 2612a308f..d3235dccf 100644 --- a/products/idn/api/service-accounts.md +++ b/docs/guides/service-accounts.md @@ -6,19 +6,20 @@ sidebar_label: Service Accounts sidebar_position: 4 sidebar_class_name: serviceAccounts keywords: ['service account'] -description: Read this guide to learn how to create service accounts that can generate API tokens to be used in integrations. +description: Create and implement service accounts. +slug: /guides/service-accounts tags: ['Service Account', 'Authentication'] --- ## Service Accounts -Service accounts are identities in IdentityNow (IDN) that aren't real people. Their purpose is to provide credentials for automation services that can be managed and controlled separately from real identities. As a developer of integrations with IDN, there are two main advantages of creating service accounts: you can scope access to the least privilege necessary to do the job, and you can ensure that your integration's access doesn't end when you leave your organization. If you use your user account to generate credentials for integrations, they are tied to your level of access (i.e. admin) and can be revoked when you leave the organization - this could cause downtime in your integrations. +Service accounts are identities in Identity Security Cloud (ISC) that aren't real people. Their purpose is to provide credentials for automation services that can be managed and controlled separately from real identities. As a developer of integrations with ISC, there are two main advantages of creating service accounts: you can scope access to the least privilege necessary to do the job, and you can ensure that your integration's access doesn't end when you leave your organization. If you use your user account to generate credentials for integrations, they are tied to your level of access (i.e. admin) and can be revoked when you leave the organization - this could cause downtime in your integrations. Read this guide to learn how to create service accounts and implement them. ### Implementing service accounts -Any authoritative source can be used to create and manage service accounts, with Active Directory (AD) being a likely choice. Using AD to create service accounts is advantageous because doing so provisions your service accounts with unique email addresses that can be used to log in to IDN as the service account. However, if you don't want to create service accounts by using AD, you can use a flat file source to create and manage your accounts. +Any authoritative source can be used to create and manage service accounts, with Active Directory (AD) being a likely choice. Using AD to create service accounts is advantageous because doing so provisions your service accounts with unique email addresses that can be used to log in to ISC as the service account. However, if you don't want to create service accounts by using AD, you can use a flat file source to create and manage your accounts. ### Create a delimited file source @@ -38,7 +39,7 @@ Then open the CSV and add a new service account: - Set the `id` to a unique value that won't be duplicated anywhere in this file (ex. `SA-001`). - Set the `name` to quickly describe the account's purpose (ex. `audit01`). -- Set the `e-mail` to a valid email address that you have access to. This is important - you will receive the IDN invite as an email to set the password and login as the service account. This can be your email address or any other email address you have access to (ex `admin@company.com`). You can also reuse this email address as many times as you want. +- Set the `e-mail` to a valid email address that you have access to. This is important - you will receive the ISC invite as an email to set the password and login as the service account. This can be your email address or any other email address you have access to (ex `admin@company.com`). You can also reuse this email address as many times as you want. - Set the `purpose` to a brief description of what this account is used for. This can help you identify accounts later on when you need to manage and delete old accounts (ex. `Automate monthly audit report`). Save the CSV and upload it to your source from the 'Import Accounts' tab. @@ -78,6 +79,6 @@ If you have not received the invite, check your junk folder or deleted folder be ### Permissions and access tokens -New service accounts are given the basic "user" level. Depending on what you need your service account to do, you will need to modify the user level appropriately. For more information about user levels and how to set them, refer to [user level permissions](./authorization.md#user-level-permissions). +New service accounts are given the basic "user" level. Depending on what you need your service account to do, you will need to modify the user level appropriately. For more information about user levels and how to set them, refer to [user level permissions](../api/authorization.md#user-level-permissions). -Once your service account has the appropriate user level, you can generate [personal access tokens](./authentication.md#personal-access-tokens) (PATs) from the service account to fulfill the needs of your integrations. You can further refine your PATs' access by applying [scopes](./authorization.md#scopes) to each PAT you create. +Once your service account has the appropriate user level, you can generate [personal access tokens](../api/authentication.md#personal-access-tokens) (PATs) from the service account to fulfill the needs of your integrations. You can further refine your PATs' access by applying [scopes](../api/authorization.md#scopes) to each PAT you create. diff --git a/docs/iiq.md b/docs/iiq.md new file mode 100644 index 000000000..7d13ebb12 --- /dev/null +++ b/docs/iiq.md @@ -0,0 +1,19 @@ +--- +id: iiq +title: IdentityIQ +pagination_label: IdentityIQ +sidebar_label: IdentityIQ +sidebar_position: 1 +sidebar_class_name: docs +keywords: ['docs'] +description: Building extensibility in IdentityIQ +slug: /iiq +tags: ['docs'] +--- + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/products/iiq/docs/identity-iq/plugin-developer-guide/appendix-a/index.md b/docs/iiq/plugin-developer-guide/appendix-a/index.md similarity index 99% rename from products/iiq/docs/identity-iq/plugin-developer-guide/appendix-a/index.md rename to docs/iiq/plugin-developer-guide/appendix-a/index.md index 16fea54ae..423e8fd93 100644 --- a/products/iiq/docs/identity-iq/plugin-developer-guide/appendix-a/index.md +++ b/docs/iiq/plugin-developer-guide/appendix-a/index.md @@ -7,7 +7,7 @@ sidebar_position: 10 sidebar_class_name: plugin_developer_guide_appendix_migration keywords: ['plugin'] description: Migration from IdentityIQ 7.0 to 7.1 -slug: /docs/plugin-developer-guide/appendix-migration +slug: /iiq/plugin-developer-guide/appendix-migration tags: ['plugin','guide','identityiq'] --- diff --git a/products/iiq/docs/identity-iq/plugin-developer-guide/appendix-b/index.md b/docs/iiq/plugin-developer-guide/appendix-b/index.md similarity index 96% rename from products/iiq/docs/identity-iq/plugin-developer-guide/appendix-b/index.md rename to docs/iiq/plugin-developer-guide/appendix-b/index.md index 299e697af..2052e995e 100644 --- a/products/iiq/docs/identity-iq/plugin-developer-guide/appendix-b/index.md +++ b/docs/iiq/plugin-developer-guide/appendix-b/index.md @@ -7,7 +7,7 @@ sidebar_position: 11 sidebar_class_name: plugin_developer_guide_updates keywords: ['plugin'] description: IdentityIQ 8.0 Updates -slug: /docs/plugin-developer-guide/updates +slug: /iiq/plugin-developer-guide/updates tags: ['plugin','guide','identityiq'] --- # Appendix B - 8.0 Updates diff --git a/products/iiq/docs/identity-iq/plugin-developer-guide/chapter-1/index.md b/docs/iiq/plugin-developer-guide/chapter-1/index.md similarity index 99% rename from products/iiq/docs/identity-iq/plugin-developer-guide/chapter-1/index.md rename to docs/iiq/plugin-developer-guide/chapter-1/index.md index 4dd6d82f3..1dc24079c 100644 --- a/products/iiq/docs/identity-iq/plugin-developer-guide/chapter-1/index.md +++ b/docs/iiq/plugin-developer-guide/chapter-1/index.md @@ -7,7 +7,7 @@ sidebar_position: 1 sidebar_class_name: plugin_developer_guide_overview keywords: ['plugin'] description: IdentityIQ Plugin Developer Guide Overview -slug: /docs/plugin-developer-guide/overview +slug: /iiq/plugin-developer-guide/overview tags: ['plugin','guide','identityiq'] --- diff --git a/products/iiq/docs/identity-iq/plugin-developer-guide/chapter-2/index.md b/docs/iiq/plugin-developer-guide/chapter-2/index.md similarity index 99% rename from products/iiq/docs/identity-iq/plugin-developer-guide/chapter-2/index.md rename to docs/iiq/plugin-developer-guide/chapter-2/index.md index b4f98154e..96d96d800 100644 --- a/products/iiq/docs/identity-iq/plugin-developer-guide/chapter-2/index.md +++ b/docs/iiq/plugin-developer-guide/chapter-2/index.md @@ -7,7 +7,7 @@ sidebar_position: 2 sidebar_class_name: plugin_developer_guide_manifest keywords: ['plugin'] description: IdentityIQ Plugin Manifest File -slug: /docs/plugin-developer-guide/manifest +slug: /iiq/plugin-developer-guide/manifest tags: ['plugin','guide','identityiq'] --- diff --git a/products/iiq/docs/identity-iq/plugin-developer-guide/chapter-3/index.md b/docs/iiq/plugin-developer-guide/chapter-3/index.md similarity index 99% rename from products/iiq/docs/identity-iq/plugin-developer-guide/chapter-3/index.md rename to docs/iiq/plugin-developer-guide/chapter-3/index.md index 4bc2e99dc..73a236413 100644 --- a/products/iiq/docs/identity-iq/plugin-developer-guide/chapter-3/index.md +++ b/docs/iiq/plugin-developer-guide/chapter-3/index.md @@ -7,7 +7,7 @@ sidebar_position: 3 sidebar_class_name: plugin_developer_guide_build_file keywords: ['plugin'] description: IdentityIQ Plugin Build File -slug: /docs/plugin-developer-guide/build-file +slug: /iiq/plugin-developer-guide/build-file tags: ['plugin','guide','identityiq'] --- diff --git a/products/iiq/docs/identity-iq/plugin-developer-guide/chapter-4/index.md b/docs/iiq/plugin-developer-guide/chapter-4/index.md similarity index 97% rename from products/iiq/docs/identity-iq/plugin-developer-guide/chapter-4/index.md rename to docs/iiq/plugin-developer-guide/chapter-4/index.md index 02c2f828f..9c4c14241 100644 --- a/products/iiq/docs/identity-iq/plugin-developer-guide/chapter-4/index.md +++ b/docs/iiq/plugin-developer-guide/chapter-4/index.md @@ -7,7 +7,7 @@ sidebar_position: 4 sidebar_class_name: plugin_developer_guide_database_scripts keywords: ['plugin'] description: IdentityIQ Plugin Database Scripts -slug: /docs/plugin-developer-guide/database-scripts +slug: /iiq/plugin-developer-guide/database-scripts tags: ['plugin','guide','identityiq'] --- diff --git a/products/iiq/docs/identity-iq/plugin-developer-guide/chapter-5/index.md b/docs/iiq/plugin-developer-guide/chapter-5/index.md similarity index 98% rename from products/iiq/docs/identity-iq/plugin-developer-guide/chapter-5/index.md rename to docs/iiq/plugin-developer-guide/chapter-5/index.md index c57ae6a2f..331c00c16 100644 --- a/products/iiq/docs/identity-iq/plugin-developer-guide/chapter-5/index.md +++ b/docs/iiq/plugin-developer-guide/chapter-5/index.md @@ -7,7 +7,7 @@ sidebar_position: 5 sidebar_class_name: plugin_developer_guide_ui_elements keywords: ['plugin'] description: IdentityIQ Plugin UI Elements -slug: /docs/plugin-developer-guide/ui-elements +slug: /iiq/plugin-developer-guide/ui-elements tags: ['plugin','guide','identityiq'] --- # UI Elements diff --git a/products/iiq/docs/identity-iq/plugin-developer-guide/chapter-6/index.md b/docs/iiq/plugin-developer-guide/chapter-6/index.md similarity index 97% rename from products/iiq/docs/identity-iq/plugin-developer-guide/chapter-6/index.md rename to docs/iiq/plugin-developer-guide/chapter-6/index.md index 5a69372c6..b12417ff0 100644 --- a/products/iiq/docs/identity-iq/plugin-developer-guide/chapter-6/index.md +++ b/docs/iiq/plugin-developer-guide/chapter-6/index.md @@ -7,7 +7,7 @@ sidebar_position: 6 sidebar_class_name: plugin_developer_guide_xml_artifacts keywords: ['plugin'] description: IdentityIQ Plugin XML Artifacts -slug: /docs/plugin-developer-guide/xml-artifacts +slug: /iiq/plugin-developer-guide/xml-artifacts tags: ['plugin','guide','identityiq'] --- diff --git a/products/iiq/docs/identity-iq/plugin-developer-guide/chapter-7/index.md b/docs/iiq/plugin-developer-guide/chapter-7/index.md similarity index 98% rename from products/iiq/docs/identity-iq/plugin-developer-guide/chapter-7/index.md rename to docs/iiq/plugin-developer-guide/chapter-7/index.md index 333e75885..0587d3463 100644 --- a/products/iiq/docs/identity-iq/plugin-developer-guide/chapter-7/index.md +++ b/docs/iiq/plugin-developer-guide/chapter-7/index.md @@ -7,7 +7,7 @@ sidebar_position: 7 sidebar_class_name: plugin_developer_guide_java_rest_resources keywords: ['plugin'] description: IdentityIQ Plugin Java Classes REST Resources -slug: /docs/plugin-developer-guide/java-classes-rest-resources +slug: /iiq/plugin-developer-guide/java-classes-rest-resources tags: ['plugin','guide','identityiq'] --- diff --git a/products/iiq/docs/identity-iq/plugin-developer-guide/chapter-8/index.md b/docs/iiq/plugin-developer-guide/chapter-8/index.md similarity index 99% rename from products/iiq/docs/identity-iq/plugin-developer-guide/chapter-8/index.md rename to docs/iiq/plugin-developer-guide/chapter-8/index.md index 2b430320f..800aceaa9 100644 --- a/products/iiq/docs/identity-iq/plugin-developer-guide/chapter-8/index.md +++ b/docs/iiq/plugin-developer-guide/chapter-8/index.md @@ -7,7 +7,7 @@ sidebar_position: 8 sidebar_class_name: plugin_developer_guide_java_executors keywords: ['plugin'] description: IdentityIQ Plugin Java Class Plugin Executors -slug: /docs/plugin-developer-guide/java-classes-executors +slug: /iiq/plugin-developer-guide/java-classes-executors tags: ['plugin','guide','identityiq'] --- diff --git a/products/iiq/docs/identity-iq/plugin-developer-guide/chapter-9/index.md b/docs/iiq/plugin-developer-guide/chapter-9/index.md similarity index 97% rename from products/iiq/docs/identity-iq/plugin-developer-guide/chapter-9/index.md rename to docs/iiq/plugin-developer-guide/chapter-9/index.md index 898594430..766691e99 100644 --- a/products/iiq/docs/identity-iq/plugin-developer-guide/chapter-9/index.md +++ b/docs/iiq/plugin-developer-guide/chapter-9/index.md @@ -7,7 +7,7 @@ sidebar_position: 9 sidebar_class_name: plugin_developer_guide_installation keywords: ['plugin'] description: IdentityIQ Plugin Installation -slug: /docs/plugin-developer-guide/installation +slug: /iiq/plugin-developer-guide/installation tags: ['plugin','guide','identityiq'] --- diff --git a/products/iiq/docs/identity-iq/plugin-developer-guide/img/database_scripts.png b/docs/iiq/plugin-developer-guide/img/database_scripts.png similarity index 100% rename from products/iiq/docs/identity-iq/plugin-developer-guide/img/database_scripts.png rename to docs/iiq/plugin-developer-guide/img/database_scripts.png diff --git a/products/iiq/docs/identity-iq/plugin-developer-guide/img/delete_plugin.png b/docs/iiq/plugin-developer-guide/img/delete_plugin.png similarity index 100% rename from products/iiq/docs/identity-iq/plugin-developer-guide/img/delete_plugin.png rename to docs/iiq/plugin-developer-guide/img/delete_plugin.png diff --git a/products/iiq/docs/identity-iq/plugin-developer-guide/img/drag_and_drop.png b/docs/iiq/plugin-developer-guide/img/drag_and_drop.png similarity index 100% rename from products/iiq/docs/identity-iq/plugin-developer-guide/img/drag_and_drop.png rename to docs/iiq/plugin-developer-guide/img/drag_and_drop.png diff --git a/products/iiq/docs/identity-iq/plugin-developer-guide/img/new_plugin.png b/docs/iiq/plugin-developer-guide/img/new_plugin.png similarity index 100% rename from products/iiq/docs/identity-iq/plugin-developer-guide/img/new_plugin.png rename to docs/iiq/plugin-developer-guide/img/new_plugin.png diff --git a/products/iiq/docs/identity-iq/plugin-developer-guide/img/persisted_file.png b/docs/iiq/plugin-developer-guide/img/persisted_file.png similarity index 100% rename from products/iiq/docs/identity-iq/plugin-developer-guide/img/persisted_file.png rename to docs/iiq/plugin-developer-guide/img/persisted_file.png diff --git a/products/iiq/docs/identity-iq/plugin-developer-guide/img/plugin_dist.png b/docs/iiq/plugin-developer-guide/img/plugin_dist.png similarity index 100% rename from products/iiq/docs/identity-iq/plugin-developer-guide/img/plugin_dist.png rename to docs/iiq/plugin-developer-guide/img/plugin_dist.png diff --git a/products/iiq/docs/identity-iq/plugin-developer-guide/img/plugin_structure.png b/docs/iiq/plugin-developer-guide/img/plugin_structure.png similarity index 100% rename from products/iiq/docs/identity-iq/plugin-developer-guide/img/plugin_structure.png rename to docs/iiq/plugin-developer-guide/img/plugin_structure.png diff --git a/products/iiq/docs/identity-iq/plugin-developer-guide/img/snippet.png b/docs/iiq/plugin-developer-guide/img/snippet.png similarity index 100% rename from products/iiq/docs/identity-iq/plugin-developer-guide/img/snippet.png rename to docs/iiq/plugin-developer-guide/img/snippet.png diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 000000000..e630d1a2e --- /dev/null +++ b/docs/index.md @@ -0,0 +1,50 @@ +--- +id: docs +title: Identity Security Cloud +pagination_label: Docs +sidebar_label: Docs +sidebar_position: 1 +sidebar_class_name: docs +keywords: ['docs'] +description: The Identity Security Cloud Developer Documentation. +slug: / +tags: ['docs'] +--- + +## Overview + +:::caution What about IdentityNow? + +Looking for IdentityNow? You're in the right place! IdentityNow has an updated brand in Identity Security Cloud. + +::: + +Identity Security Cloud (ISC) is a unified, multi-tenant identity governance and security platform. ISC provides organizations with the ability to ensure that their users, known as identities in ISC, have secure access to different data sources, and it makes identity access management fast and easy. + +The ISC platform out of the box will often meet all your identity governance and security needs, but it's possible that it won't. The beauty of ISC is that even if it doesn't quite meet all your needs, you can extend the platform's functionality and build custom solutions that do! + +The SailPoint Developer Documentation provides developers with all the information they need to extend their platforms' functionality and build their desired solutions. The developer documentation is written for developers of all experience levels, from nontechnical users exploring what's possible to advanced developers who live and breathe code. + +Check out the developer documentation and see what's possible! + +:::info Are you a partner? + +The developer documentation is written for customers and partners who already have access to ISC. If you're interested in becoming a partner, go [here](https://www.sailpoint.com/partners/become-partner/). + +::: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +## Discuss + +The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions. + +To learn more about ISC and discuss it with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/isc/6). \ No newline at end of file diff --git a/products/iiq/docs/identity-iq/plugin-developer-guide/index.md b/docs/plugin-developer-guide.md similarity index 95% rename from products/iiq/docs/identity-iq/plugin-developer-guide/index.md rename to docs/plugin-developer-guide.md index fc2a7e132..93bf86cc5 100644 --- a/products/iiq/docs/identity-iq/plugin-developer-guide/index.md +++ b/docs/plugin-developer-guide.md @@ -6,8 +6,8 @@ sidebar_label: Plugin Developer Guide sidebar_position: 1 sidebar_class_name: plugin_developer_guide keywords: ['plugin'] -description: Plugin Developer Guide in IdentityIQ -slug: /docs/plugin-developer-guide +description: IdentityIQ Plugin Developer Guide. +slug: /iiq/plugin-developer-guide tags: ['plugin','guide','identityiq'] --- diff --git a/docs/reporting.md b/docs/reporting.md new file mode 100644 index 000000000..09d9dd3cb --- /dev/null +++ b/docs/reporting.md @@ -0,0 +1,28 @@ +--- +id: reporting +title: Reporting +pagination_label: Reporting +sidebar_label: Reporting +sidebar_position: 1 +sidebar_class_name: reporting +keywords: ['reporting'] +description: Collect data reports from ISC. +slug: /reporting +tags: ['reporting'] +--- + +## Overview + +Data reporting refers to the process of collecting and presenting data in a structured format that makes the data accessible and easy to understand, which facilitates an organization's data-driven decisions. Identity Security Cloud (ISC) provides different data reporting options you can use to extract data from your tenant and make it presentable. + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + +## Discuss +The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions. + +To learn more about ISC data reporting and discuss the different options with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/isc/6). diff --git a/docs/reporting/access-intelligence-center/_category_.json b/docs/reporting/access-intelligence-center/_category_.json new file mode 100644 index 000000000..9c0816cc1 --- /dev/null +++ b/docs/reporting/access-intelligence-center/_category_.json @@ -0,0 +1,5 @@ +{ + "customProps": { + "description": "Create your own dashboards and discover key insights." + } +} \ No newline at end of file diff --git a/products/idn/docs/identity-now/access-intelligence-center/audit-er-diagram.md b/docs/reporting/access-intelligence-center/audit-er-diagram.md similarity index 98% rename from products/idn/docs/identity-now/access-intelligence-center/audit-er-diagram.md rename to docs/reporting/access-intelligence-center/audit-er-diagram.md index 0d30ee72a..f07326342 100644 --- a/products/idn/docs/identity-now/access-intelligence-center/audit-er-diagram.md +++ b/docs/reporting/access-intelligence-center/audit-er-diagram.md @@ -7,7 +7,7 @@ sidebar_position: 2 sidebar_class_name: AccessIntelligenceCenter keywords: ['data listing', 'data share', 'secure data sharing'] description: Access Intelligence Center Audit ER Diagram -slug: /docs/aic-audit-er-diagram +slug: /reporting/aic-audit-er-diagram tags: ['AccessIntelligenceCenter', 'AIC'] hide_table_of_contents: true --- diff --git a/products/idn/docs/identity-now/access-intelligence-center/identity-er-diagram.md b/docs/reporting/access-intelligence-center/identity-er-diagram.md similarity index 99% rename from products/idn/docs/identity-now/access-intelligence-center/identity-er-diagram.md rename to docs/reporting/access-intelligence-center/identity-er-diagram.md index f5e3c7fb3..1560860a2 100644 --- a/products/idn/docs/identity-now/access-intelligence-center/identity-er-diagram.md +++ b/docs/reporting/access-intelligence-center/identity-er-diagram.md @@ -7,7 +7,7 @@ sidebar_position: 1 sidebar_class_name: AccessIntelligenceCenter keywords: ['data listing', 'data share', 'secure data sharing'] description: Access Intelligence Center ER Diagram -slug: /docs/aic-er-diagram +slug: /reporting/aic-er-diagram tags: ['AccessIntelligenceCenter', 'AIC'] hide_table_of_contents: true --- diff --git a/products/idn/docs/identity-now/access-intelligence-center/index.md b/docs/reporting/access-intelligence-center/index.md similarity index 90% rename from products/idn/docs/identity-now/access-intelligence-center/index.md rename to docs/reporting/access-intelligence-center/index.md index fcf95ae64..8e67cd9c2 100644 --- a/products/idn/docs/identity-now/access-intelligence-center/index.md +++ b/docs/reporting/access-intelligence-center/index.md @@ -6,8 +6,8 @@ sidebar_label: Access Intelligence Center sidebar_position: 5 sidebar_class_name: AccessIntelligenceCenter keywords: ['data listing', 'data share', 'secure data sharing'] -description: Access Intelligence Center is an easy way to get IDN data of your organization in a structured format. -slug: /docs/access-intelligence-center +description: Custom dashboards for data analysis. +slug: /reporting/access-intelligence-center tags: ['AccessIntelligenceCenter', 'AIC'] hide_table_of_contents: true --- @@ -25,7 +25,7 @@ The AIC Audit dashboard focuses on more tangible audit events, such as access re With Reader permission, users can view any public sheets available and make selections to further filter the data. With Authoring permission, users can view public sheets, create new public or private sheets, and bookmark certain filters for future use. -## IdentityNow Documentation +## Identity Security Cloud Documentation For information on how to use AIC in your environment, see the documentation [here](https://documentation.sailpoint.com/saas/help/ai/access_insights/access_intelligence.html) ## Technical Documentation and Videos diff --git a/products/idn/docs/identity-now/access-intelligence-center/videos.md b/docs/reporting/access-intelligence-center/videos.md similarity index 97% rename from products/idn/docs/identity-now/access-intelligence-center/videos.md rename to docs/reporting/access-intelligence-center/videos.md index eba164688..809980410 100644 --- a/products/idn/docs/identity-now/access-intelligence-center/videos.md +++ b/docs/reporting/access-intelligence-center/videos.md @@ -7,7 +7,7 @@ sidebar_position: 2 sidebar_class_name: AccessIntelligenceCenter keywords: ['data listing', 'data share', 'secure data sharing'] description: Access Intelligence Center Videos -slug: /docs/aic-videos +slug: /reporting/aic-videos tags: ['AccessIntelligenceCenter', 'AIC'] --- diff --git a/docs/reporting/secure-data-share/_category_.json b/docs/reporting/secure-data-share/_category_.json new file mode 100644 index 000000000..11508475c --- /dev/null +++ b/docs/reporting/secure-data-share/_category_.json @@ -0,0 +1,5 @@ +{ + "customProps": { + "description": "Securely share ISC data with Snowflake." + } +} \ No newline at end of file diff --git a/products/idn/docs/identity-now/secure-data-share/audit-er-diagram.md b/docs/reporting/secure-data-share/audit-er-diagram.md similarity index 97% rename from products/idn/docs/identity-now/secure-data-share/audit-er-diagram.md rename to docs/reporting/secure-data-share/audit-er-diagram.md index 629beffb5..b381a9670 100644 --- a/products/idn/docs/identity-now/secure-data-share/audit-er-diagram.md +++ b/docs/reporting/secure-data-share/audit-er-diagram.md @@ -7,7 +7,7 @@ sidebar_position: 2 sidebar_class_name: secureDataShare keywords: ['data listing', 'data share', 'secure data sharing'] description: Secure Data Share Audit ER Diagram -slug: /docs/sds-audit-er-diagram +slug: /reporting/sds-audit-er-diagram tags: ['SecureDataShare', 'SDS'] hide_table_of_contents: true --- diff --git a/products/idn/docs/identity-now/secure-data-share/identity-er-diagram.md b/docs/reporting/secure-data-share/identity-er-diagram.md similarity index 99% rename from products/idn/docs/identity-now/secure-data-share/identity-er-diagram.md rename to docs/reporting/secure-data-share/identity-er-diagram.md index f949bcb47..39902a7f0 100644 --- a/products/idn/docs/identity-now/secure-data-share/identity-er-diagram.md +++ b/docs/reporting/secure-data-share/identity-er-diagram.md @@ -7,7 +7,7 @@ sidebar_position: 1 sidebar_class_name: secureDataShare keywords: ['data listing', 'data share', 'secure data sharing'] description: Secure Data Share Entity Relationship Diagram -slug: /docs/sds-er-diagram +slug: /reporting/sds-er-diagram tags: ['SecureDataShare', 'SDS'] hide_table_of_contents: true --- diff --git a/products/idn/docs/identity-now/secure-data-share/index.md b/docs/reporting/secure-data-share/index.md similarity index 83% rename from products/idn/docs/identity-now/secure-data-share/index.md rename to docs/reporting/secure-data-share/index.md index 656318640..aa92d7cc5 100644 --- a/products/idn/docs/identity-now/secure-data-share/index.md +++ b/docs/reporting/secure-data-share/index.md @@ -6,17 +6,17 @@ sidebar_label: Secure Data Share sidebar_position: 6 sidebar_class_name: secureDataShare keywords: ['data listing', 'data share', 'secure data sharing'] -description: Secure Data Share is an easy way to get IDN data of your organization in a structured format. -slug: /docs/secure-data-share +description: Share ISC data with Snowflake. +slug: /reporting/secure-data-share tags: ['SecureDataShare'] hide_table_of_contents: true --- import MermaidViewer from '@site/src/components/MermaidViewer'; -Secure Data Sharing (SDS) makes SailPoint's Identity data available directly to customer via their Snowflake account. DataSet comprises of structured Identity and audit data. Includes relationship tables that connects Identity with other domain entities like entitlements, roles, access profiles, accounts and Apps. This dataset has an additional Audit events table that is a flattened representation of all the events happening in IdentityNow for your organization. +Secure Data Sharing (SDS) makes SailPoint's Identity data available directly to customer via their Snowflake account. DataSet comprises of structured Identity and audit data. Includes relationship tables that connects Identity with other domain entities like entitlements, roles, access profiles, accounts and Apps. This dataset has an additional Audit events table that is a flattened representation of all the events happening in Identity Security Cloud for your organization. -## IdentityNow Documentation +## Identity Security Cloud Documentation For information on how to use SDS in your environment, see the documentation [here](https://documentation.sailpoint.com/saas/help/secure_data_share/secure_data_share.html). ## Technical Documentation diff --git a/docs/sidebar.js b/docs/sidebar.js new file mode 100644 index 000000000..9d6f9ef4a --- /dev/null +++ b/docs/sidebar.js @@ -0,0 +1,127 @@ +// const sidebars = { +// openApiSidebar: [ +// { +// type: 'category', +// label: 'API Specifications', +// collapsible: true, +// items: [ +// { +// type: 'doc', +// id: 'api/getting-started', +// }, +// { +// type: 'doc', +// id: 'api/authentication', +// }, +// { +// type: 'doc', +// id: 'api/authorization', +// }, +// { +// type: 'doc', +// id: 'api/service-accounts', +// }, +// { +// type: 'doc', +// id: 'api/standard-collection-parameters', +// }, +// { +// type: 'doc', +// id: 'api/rate-limit', +// }, +// { +// type: 'doc', +// id: 'api/postman-collections', +// }, +// { +// type: 'doc', +// id: 'api/patch-requests' +// }, +// { +// type: 'category', +// label: 'V3 APIs', +// link: { +// type: 'generated-index', +// title: 'V3 APIs', +// 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.', +// slug: '/api/v3', +// }, +// // @ts-ignore +// items: require('./api/v3/sidebar.js'), +// }, +// { +// type: 'category', +// label: 'Beta APIs', +// link: { +// type: 'generated-index', +// title: 'Beta APIs', +// description: +// 'Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.', +// slug: '/api/beta', +// }, +// // @ts-ignore +// items: require('./api/beta/sidebar.js'), +// }, +// ], +// }, +// { +// type: 'category', +// label: 'Extensibility', +// items: [ +// { +// type: 'autogenerated', +// dirName: 'extensibility', +// } +// ] +// }, +// { +// type: 'category', +// label: 'Tools', +// items: [ +// { +// type: 'autogenerated', +// dirName: 'tools', +// } +// ] +// }, +// { +// type: 'category', +// label: 'Reporting', +// items: [ +// { +// type: 'autogenerated', +// dirName: 'reporting', +// } +// ] +// }, +// ] +// }; +// module.exports = sidebars; + +const sidebars = { + iiqOpenApiSidebar: [ + { + type: 'category', + label: 'IdentityIQ API', + link: { + type: 'generated-index', + title: 'IdentityIQ API', + description: + "These are the SCIM APIs for SailPoint's on-premise service, IdentityIQ. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.", + slug: '/api/iiq', + }, + // @ts-ignore + items: require('./api/sidebar.js'), + }, + ], + idnDocs: [ + { + type: 'autogenerated', + dirName: 'docs', + }, + ] + }; + + module.exports = sidebars; + \ No newline at end of file diff --git a/docs/tools.md b/docs/tools.md new file mode 100644 index 000000000..f328fc335 --- /dev/null +++ b/docs/tools.md @@ -0,0 +1,28 @@ +--- +id: tools +title: Tools +pagination_label: Tools +sidebar_label: Tools +sidebar_position: 1 +sidebar_class_name: tools +keywords: ['tools'] +description: ISC developer tools. +slug: /tools +tags: ['tools'] +--- + +## Overview + +The SailPoint Developer Relations Team has built some useful tools that improve the experience for developers building on the Identity Security Cloud (ISC) platform. These tools make it easier for developers to leverage the ISC APIs, extensibility options, and connectivity. + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + +## Discuss +The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions. + +To learn more about ISC tools and discuss them with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/isc/6). diff --git a/products/idn/tools/cli/Templates/report.md b/docs/tools/cli/Templates/report.md similarity index 100% rename from products/idn/tools/cli/Templates/report.md rename to docs/tools/cli/Templates/report.md diff --git a/products/idn/tools/cli/Templates/search.md b/docs/tools/cli/Templates/search.md similarity index 89% rename from products/idn/tools/cli/Templates/search.md rename to docs/tools/cli/Templates/search.md index acd70a3c9..256da0e67 100644 --- a/products/idn/tools/cli/Templates/search.md +++ b/docs/tools/cli/Templates/search.md @@ -106,4 +106,4 @@ For example, the variable in this template is configured so you can choose how m } ``` -Everything inside this searchQuery object matches the standard format of an [IdentityNow search query](https://documentation.sailpoint.com/saas/help/search/building-query.html). A limited number of examples are provided [here](https://developer.sailpoint.com/idn/api/v3/search-post), but the searchQuery object is mapped to the full search object. This means that you can add any search query values missing from this object. +Everything inside this searchQuery object matches the standard format of an [Identity Security Cloud search query](https://documentation.sailpoint.com/saas/help/search/building-query.html). A limited number of examples are provided [here](https://developer.sailpoint.com/docs/api/v3/search-post), but the searchQuery object is mapped to the full search object. This means that you can add any search query values missing from this object. diff --git a/products/idn/tools/cli/Templates/spconfig.md b/docs/tools/cli/Templates/spconfig.md similarity index 94% rename from products/idn/tools/cli/Templates/spconfig.md rename to docs/tools/cli/Templates/spconfig.md index f02880c26..6747dca9d 100644 --- a/products/idn/tools/cli/Templates/spconfig.md +++ b/docs/tools/cli/Templates/spconfig.md @@ -11,7 +11,7 @@ slug: /tools/cli/templates/spconfig tags: ['CLI'] --- -Use SPConfig templates to perform complex import and export operations with IdentityNow (IDN) configurations. +Use SPConfig templates to perform complex import and export operations with Identity Security Cloud (ISC) configurations. This is an example of a template file with one SPConfig template populated: @@ -69,7 +69,7 @@ Use variables to dynamically populate values in the following content during com "exportBody": { ``` -The following object matches that detailed in the [API docs](https://developer.sailpoint.com/idn/api/beta/export-sp-config) +The following object matches that detailed in the [API docs](https://developer.sailpoint.com/docs/api/beta/export-sp-config) ```json "description": "Export all available objects", diff --git a/docs/tools/cli/_category_.json b/docs/tools/cli/_category_.json new file mode 100644 index 000000000..50f1f7ad1 --- /dev/null +++ b/docs/tools/cli/_category_.json @@ -0,0 +1,5 @@ +{ + "customProps": { + "description": "Terminal based tool for interaction with ISC." + } +} \ No newline at end of file diff --git a/products/idn/tools/cli/assets/img/vhs/MacOSAndLinux.gif b/docs/tools/cli/assets/img/vhs/MacOSAndLinux.gif similarity index 100% rename from products/idn/tools/cli/assets/img/vhs/MacOSAndLinux.gif rename to docs/tools/cli/assets/img/vhs/MacOSAndLinux.gif diff --git a/products/idn/tools/cli/assets/img/vhs/Sail.gif b/docs/tools/cli/assets/img/vhs/Sail.gif similarity index 100% rename from products/idn/tools/cli/assets/img/vhs/Sail.gif rename to docs/tools/cli/assets/img/vhs/Sail.gif diff --git a/products/idn/tools/cli/assets/img/vhs/brewinstall.gif b/docs/tools/cli/assets/img/vhs/brewinstall.gif similarity index 100% rename from products/idn/tools/cli/assets/img/vhs/brewinstall.gif rename to docs/tools/cli/assets/img/vhs/brewinstall.gif diff --git a/products/idn/tools/cli/assets/img/vhs/configure-pat.gif b/docs/tools/cli/assets/img/vhs/configure-pat.gif similarity index 100% rename from products/idn/tools/cli/assets/img/vhs/configure-pat.gif rename to docs/tools/cli/assets/img/vhs/configure-pat.gif diff --git a/products/idn/tools/cli/assets/img/vhs/transform-download.gif b/docs/tools/cli/assets/img/vhs/transform-download.gif similarity index 100% rename from products/idn/tools/cli/assets/img/vhs/transform-download.gif rename to docs/tools/cli/assets/img/vhs/transform-download.gif diff --git a/products/idn/tools/cli/assets/img/vhs/transform-list.gif b/docs/tools/cli/assets/img/vhs/transform-list.gif similarity index 100% rename from products/idn/tools/cli/assets/img/vhs/transform-list.gif rename to docs/tools/cli/assets/img/vhs/transform-list.gif diff --git a/products/idn/tools/cli/assets/img/vhs/transform.gif b/docs/tools/cli/assets/img/vhs/transform.gif similarity index 100% rename from products/idn/tools/cli/assets/img/vhs/transform.gif rename to docs/tools/cli/assets/img/vhs/transform.gif diff --git a/products/idn/tools/cli/cluster.md b/docs/tools/cli/cluster.md similarity index 91% rename from products/idn/tools/cli/cluster.md rename to docs/tools/cli/cluster.md index cf1edfd36..a688093df 100644 --- a/products/idn/tools/cli/cluster.md +++ b/docs/tools/cli/cluster.md @@ -33,7 +33,7 @@ sail cluster list This command returns a table of the clusters, along with their IDs. -This command uses the [Get all clusters endpoint](https://developer.sailpoint.com/idn/api/beta/get-managed-clusters). +This command uses the [Get all clusters endpoint](https://developer.sailpoint.com/docs/api/beta/get-managed-clusters). ## Get cluster by ID @@ -57,7 +57,7 @@ You can also get multiple clusters at once. Here is an example: sail cluster get f48e8c9c7dce4672bead8222a767dce7 3652192cc2264ad5827fdc1eb2d88f01 ``` -This command uses the [Get cluster endpoint](https://developer.sailpoint.com/idn/api/beta/get-managed-cluster). +This command uses the [Get cluster endpoint](https://developer.sailpoint.com/docs/api/beta/get-managed-cluster). ## Get cluster's log configuration @@ -73,13 +73,13 @@ Here is an example: sail cluster log get 2c91808580f6cc1a01811af8cf5f18cb ``` -This command uses the [Get cluster's log configuration endpoint](https://developer.sailpoint.com/idn/api/beta/get-client-log-configuration). +This command uses the [Get cluster's log configuration endpoint](https://developer.sailpoint.com/docs/api/beta/get-client-log-configuration). ## Set cluster's log configuration You can update a cluster's root logging level, the duration of its logging, and the connector logging class. To set a cluster's log configuration, run this command: -This command uses the [Update cluster's log configuration endpoint](https://developer.sailpoint.com/idn/api/beta/put-client-log-configuration). +This command uses the [Update cluster's log configuration endpoint](https://developer.sailpoint.com/docs/api/beta/put-client-log-configuration). ```shell sail cluster log set {cluster ID} -r {rootLevel} -d {durationMinutes} -c {connector logging class} diff --git a/products/idn/tools/cli/connectors.md b/docs/tools/cli/connectors.md similarity index 80% rename from products/idn/tools/cli/connectors.md rename to docs/tools/cli/connectors.md index d697af192..080a624b0 100644 --- a/products/idn/tools/cli/connectors.md +++ b/docs/tools/cli/connectors.md @@ -15,7 +15,7 @@ tags: ['CLI'] Learn how to use the CLI to create, manage, and test SaaS connectors in this guide. -You can use SaaS connectors to serve as bridges between your IdentityNow (IDN) tenant and other source systems without the use of a Virtual Appliance (VA). For more information about the SaaS connectors, refer to the [SaaS Connectivity](/idn/docs/saas-connectivity) guide. +You can use SaaS connectors to serve as bridges between your Identity Security Cloud (ISC) tenant and other source systems without the use of a Virtual Appliance (VA). For more information about the SaaS connectors, refer to the [SaaS Connectivity](/docs/connectivity/saas-connectivity) guide. The `connectors` command is a CLI interface for the SaaS Connectivity platform. The CLI is the best way to create, manage, and test SaaS connectors within your tenant. @@ -42,27 +42,27 @@ To initialize a connector project, run this command: sail conn init [connectorProjectName] ``` -This command creates a folder named `connectorProjectName` in your working directory. The folder includes all the files necessary to create a connector. For more information about initiating a connector project, refer to the [Create new project](/idn/docs/saas-connectivity/prerequisites/#create-new-project) section of the SaaS Connectivity documentation. +This command creates a folder named `connectorProjectName` in your working directory. The folder includes all the files necessary to create a connector. For more information about initiating a connector project, refer to the [Create new project](/docs/connectivity/saas-connectivity/prerequisites/#create-new-project) section of the SaaS Connectivity documentation. ### Create connector -To create a connector entry in your IDN tenant, run this command: +To create a connector entry in your ISC tenant, run this command: ```shell sail conn create [connectorAlias] ``` -This command registers your connector and gives it a unique ID. For more information about creating a connector in your tenant, refer to the [Create connector in your org](/idn/docs/saas-connectivity/test-build-deploy#create-connector-in-your-org) section of the SaaS Connectivity documentation. +This command registers your connector and gives it a unique ID. For more information about creating a connector in your tenant, refer to the [Create connector in your org](/docs/connectivity/saas-connectivity/test-build-deploy#create-connector-in-your-org) section of the SaaS Connectivity documentation. ### Upload connector -To upload a connector to your IDN tenant, run `npm run pack-zip` in the project directory to package the connector into a zip file. Then run this command: +To upload a connector to your ISC tenant, run `npm run pack-zip` in the project directory to package the connector into a zip file. Then run this command: ```shell sail conn upload -c [connectorID | connectorAlias] -f connector.zip ``` -You must package the project files before you upload them. For more information about how to package and upload connectors, refer to the [Create and upload connector bundle](/idn/docs/saas-connectivity/test-build-deploy/#create-and-upload-connector-bundle) section of the SaaS Connectivity documentation. +You must package the project files before you upload them. For more information about how to package and upload connectors, refer to the [Create and upload connector bundle](/docs/connectivity/saas-connectivity/test-build-deploy/#create-and-upload-connector-bundle) section of the SaaS Connectivity documentation. ### Invoke command @@ -72,7 +72,7 @@ To test connector commands, like `test-connection`, `account-list`, and `entitle sail conn invoke [command] -c [connectorID | connectorAlias] -p [config.json] -v [version] ``` -For more information about the different available connector commands, refer to [Connector Commands](/idn/docs/saas-connectivity/connector-commands). +For more information about the different available connector commands, refer to [Connector Commands](/docs/connectivity/saas-connectivity/connector-commands). The entitlement commands require an additional flag (`-t [entitlementType]`), like this example: @@ -80,7 +80,7 @@ The entitlement commands require an additional flag (`-t [entitlementType]`), li sail conn invoke entitlement-list -t [entitlementType] -c [connectorID | connectorAlias] -p [config.json] -v [version] ``` -For more information about invoking commands, refer to the [Test your connector in IdentityNow](/idn/docs/saas-connectivity/test-build-deploy#test-your-connector-in-identitynow) section of the SaaS Connectivity documentation. +For more information about invoking commands, refer to the [Test your connector in Identity Security Cloud](/docs/connectivity/saas-connectivity/test-build-deploy#test-your-connector-in-identitynow) section of the SaaS Connectivity documentation. ### List connectors @@ -120,7 +120,7 @@ sail conn delete -c [connectorID] ### Manage tags -You can use tags to create multiple instances of your connector that can be used in IDN. The `latest` tag is created by default and is the primary instance, typically used for production purposes. Tags are similar to branches in a version control system, like git or CVS. You can create a tag for actively developing the connector, or for any other purpose you want. +You can use tags to create multiple instances of your connector that can be used in ISC. The `latest` tag is created by default and is the primary instance, typically used for production purposes. Tags are similar to branches in a version control system, like git or CVS. You can create a tag for actively developing the connector, or for any other purpose you want. A common pattern is to create a `development` tag on a connector from a specific version, like the latest version. @@ -134,7 +134,7 @@ As the connector is developed and the version number increases, update the `deve sail conn tags update -c [connectorID | connectorAlias] -n [tagName] -v [version] ``` -You can test the connector in IDN by selecting the connector instance with the `development` tag. The CLI will use the version you point to with the update command. +You can test the connector in ISC by selecting the connector instance with the `development` tag. The CLI will use the version you point to with the update command. To see a connector's tags and the versions they point to, run this command: @@ -172,4 +172,4 @@ To get detailed logging statistics on each connector, run this command: sail conn stats ``` -For more information about connector logging, refer to [Logging](/idn/docs/saas-connectivity/in-depth/logging/). +For more information about connector logging, refer to [Logging](/docs/connectivity/saas-connectivity/in-depth/logging/). diff --git a/products/idn/tools/cli/index.md b/docs/tools/cli/index.md similarity index 84% rename from products/idn/tools/cli/index.md rename to docs/tools/cli/index.md index 95356292d..2255e0488 100644 --- a/products/idn/tools/cli/index.md +++ b/docs/tools/cli/index.md @@ -1,21 +1,21 @@ --- id: cli -title: CLI -pagination_label: CLI +title: Command Line Interface +pagination_label: Command Line Interface sidebar_label: CLI sidebar_position: 1 sidebar_class_name: cli keywords: ['cli'] -description: The SailPoint CLI is a terminal-based tool you can use to interact with your IDN tenant. +description: Terminal-based tool for interaction with ISC. slug: /tools/cli tags: ['CLI'] --- ## Start using the CLI -The SailPoint CLI is a terminal-based tool you can use to to interact with your IdentityNow (IDN) tenant. The CLI provides a text-based environment you can use to run operations known as "commands" to interact with your tenant however you want. +The SailPoint CLI is a terminal-based tool you can use to to interact with your Identity Security Cloud (ISC) tenant. The CLI provides a text-based environment you can use to run operations known as "commands" to interact with your tenant however you want. -You can use the CLI to perform many functions you would have otherwise used Postman or custom scripts to perform before. For example, you can use the CLI to call the SailPoint APIs to do whatever you want in your IDN tenant, and you can do all this directly on the command line, with minimal setup. +You can use the CLI to perform many functions you would have otherwise used Postman or custom scripts to perform before. For example, you can use the CLI to call the SailPoint APIs to do whatever you want in your ISC tenant, and you can do all this directly on the command line, with minimal setup. Learn how to use the SailPoint command line interface (CLI) in this guide. @@ -106,11 +106,11 @@ sudo yum localinstall /path/to/rpm/package/sail_x.x.x_linux_amd64.rpm ## Configuration -To configure the CLI to connect and authenticate to your IDN tenant, you must do the following: +To configure the CLI to connect and authenticate to your ISC tenant, you must do the following: -- Find your tenant name. To learn how to find it, refer to [Getting Started](/idn/api/getting-started#find-your-tenant-name). The CLI will use this tenant name to connect to your IDN instance. +- Find your tenant name. To learn how to find it, refer to [Getting Started](/docs/api/getting-started#find-your-tenant-name). The CLI will use this tenant name to connect to your ISC instance. - OAuth -- PAT | Create a personal access token (PAT). Make sure to note the "Client ID" and "Client Secret." The CLI needs this information to authenticate successfully. To learn how to create a PAT, refer to [Personal Access Tokens](/idn/api/authentication#personal-access-tokens). +- PAT | Create a personal access token (PAT). Make sure to note the "Client ID" and "Client Secret." The CLI needs this information to authenticate successfully. To learn how to create a PAT, refer to [Personal Access Tokens](/docs/api/authentication#personal-access-tokens). To configure your first environment for OAuth run the following command: ```bash @@ -119,8 +119,8 @@ sail env {environment} with `{environment}` being the name of the environment you wish to configure. You will be prompted for the following information: -- The Tenant URL - The web URL used to access your IdentityNow tenant (ex. https://tenant.identitynow.com), this is used during the OAuth process. -- The API URL - The API URL used to access your IdentityNow tenant (ex. https://tenant.api.identitynow.com), this is used for the api calls made by certain commands. +- The Tenant URL - The web URL used to access your Identity Security Cloud tenant (ex. https://tenant.identitynow.com), this is used during the OAuth process. +- The API URL - The API URL used to access your Identity Security Cloud tenant (ex. https://tenant.api.identitynow.com), this is used for the api calls made by certain commands. ### OAuth Authentication @@ -173,14 +173,14 @@ Run the `sail` command for an overview of available commands and flags. You can These commands are available: -- `connectors`: This command is a CLI interface for the SaaS Connectivity platform. The CLI is the best way to create and manage SaaS connectors within your tenant. For more information about the `connectors` command, refer to the CLI [Connectors guide](/idn/tools/cli/connectors). -- `search`: Run this command to access IDN search functionality within the CLI. For more information about the `search` command, refer to the CLI [Search guide](/idn/tools/cli/search). -- `set`: Run this command to configure your CLI settings. For more information about the `set` command, refer to the CLI [Set guide](/idn/tools/cli/set). -- `spconfig`: Run this command to access IDN SP Config functionality. For more information about the `spconfig` command, refer to the CLI [SPConfig guide](/idn/tools/cli/spconfig). -- `transform`: This command is a CLI interface that makes it easy to create, manage, and test transforms. For more information about the `transform` command, refer to the CLI [Transforms guide](/idn/tools/cli/transforms). -- `va`: Run this command to access VAs connected to your tenant. For more information about the `va` command, refer to the CLI [VA guide](/idn/tools/cli/va). -- `cluster`: Run this command to access VA clusters connected to your tenant. For more information about the `cluster` command, refer to the CLI [Clusters guide](/idn/tools/cli/cluster). -- `workflow`: Run this command to create and manage workflows within the CLI. For more information about the `workflow` command, refer to the CLI [Workflows guide](/idn/tools/cli/workflow). +- `connectors`: This command is a CLI interface for the SaaS Connectivity platform. The CLI is the best way to create and manage SaaS connectors within your tenant. For more information about the `connectors` command, refer to the CLI [Connectors guide](/docs/tools/cli/connectors). +- `search`: Run this command to access ISC search functionality within the CLI. For more information about the `search` command, refer to the CLI [Search guide](/docs/tools/cli/search). +- `set`: Run this command to configure your CLI settings. For more information about the `set` command, refer to the CLI [Set guide](/docs/tools/cli/set). +- `spconfig`: Run this command to access ISC SP Config functionality. For more information about the `spconfig` command, refer to the CLI [SPConfig guide](/docs/tools/cli/spconfig). +- `transform`: This command is a CLI interface that makes it easy to create, manage, and test transforms. For more information about the `transform` command, refer to the CLI [Transforms guide](/docs/tools/cli/transforms). +- `va`: Run this command to access VAs connected to your tenant. For more information about the `va` command, refer to the CLI [VA guide](/docs/tools/cli/va). +- `cluster`: Run this command to access VA clusters connected to your tenant. For more information about the `cluster` command, refer to the CLI [Clusters guide](/docs/tools/cli/cluster). +- `workflow`: Run this command to create and manage workflows within the CLI. For more information about the `workflow` command, refer to the CLI [Workflows guide](/docs/tools/cli/workflow). ## GitHub diff --git a/products/idn/tools/cli/sanitize.md b/docs/tools/cli/sanitize.md similarity index 100% rename from products/idn/tools/cli/sanitize.md rename to docs/tools/cli/sanitize.md diff --git a/products/idn/tools/cli/search.md b/docs/tools/cli/search.md similarity index 73% rename from products/idn/tools/cli/search.md rename to docs/tools/cli/search.md index 12d25c676..9e9c9166c 100644 --- a/products/idn/tools/cli/search.md +++ b/docs/tools/cli/search.md @@ -6,20 +6,20 @@ sidebar_label: Search sidebar_position: 3 sidebar_class_name: cli keywords: ['cli', 'search'] -description: Learn how to use the CLI to search your IDN tenant in this guide. +description: Learn how to use the CLI to search your ISC tenant in this guide. slug: /tools/cli/search tags: ['CLI'] --- # Search -Learn how to use the CLI to search your IDN tenant in this guide. +Learn how to use the CLI to search your ISC tenant in this guide. -In IdentityNow (IDN), you can search across all the sources connected to your tenant and return virtually any information you have access to. The `search` command allows you to access IDN search functionality within the CLI. For more information about the `search` command, refer to the CLI [Search guide](/idn/tools/cli/search). For more information about search in IDN, refer to [Search](idn/api/v3/search). +In Identity Security Cloud (ISC), you can search across all the sources connected to your tenant and return virtually any information you have access to. The `search` command allows you to access ISC search functionality within the CLI. For more information about the `search` command, refer to the CLI [Search guide](docs/tools/cli/search). For more information about search in ISC, refer to [Search](docs/api/v3/search). -In IdentityNow, you can search all the sources connected to your tenant and return virtually any information you have access to. To learn more about search in IdentityNow, refer to [Search](https://documentation.sailpoint.com/saas/help/search/index.html). +In Identity Security Cloud, you can search all the sources connected to your tenant and return virtually any information you have access to. To learn more about search in Identity Security Cloud, refer to [Search](https://documentation.sailpoint.com/saas/help/search/index.html). -The `search` command makes it easy to search in IdentityNow with the SailPoint CLI. Read this guide to learn how to use the `query` and `template` commands to search IdentityNow with the CLI. +The `search` command makes it easy to search in Identity Security Cloud with the SailPoint CLI. Read this guide to learn how to use the `query` and `template` commands to search Identity Security Cloud with the CLI. - [Search](#search) - [Query](#query) @@ -35,11 +35,11 @@ The `search` command makes it easy to search in IdentityNow with the SailPoint C ## Query -Search queries in IdentityNow are flexible - they can be very broad or very narrow, and you can further narrow your results by using IdentityNow's specific syntax to structure your queries. To learn about structuring search queries, refer to [Building a Search Query](https://documentation.sailpoint.com/saas/help/search/building-query.html). +Search queries in Identity Security Cloud are flexible - they can be very broad or very narrow, and you can further narrow your results by using Identity Security Cloud's specific syntax to structure your queries. To learn about structuring search queries, refer to [Building a Search Query](https://documentation.sailpoint.com/saas/help/search/building-query.html). -The `query` command allows you to search IdentityNow for a query you specify. +The `query` command allows you to search Identity Security Cloud for a query you specify. -To use the `query` command to search IdentityNow, you must understand how to format your search queries. +To use the `query` command to search Identity Security Cloud, you must understand how to format your search queries. The basic format of a query is "field:term", so an example `query` command would like this: @@ -47,7 +47,7 @@ The basic format of a query is "field:term", so an example `query` command would sail search query "name:a*" --indices identities ``` -The CLI will use the [V3 Search endpoint](https://developer.sailpoint.com/idn/api/v3/search-post) to search for all identities starting with names starting with the letter "a". +The CLI will use the [V3 Search endpoint](https://developer.sailpoint.com/docs/api/v3/search-post) to search for all identities starting with names starting with the letter "a". The CLI will then generate a JSON file containing the search results. This JSON file will be located in a folder titled "search_results", within the current working directory, unless a folder path is specified. ### Command @@ -129,7 +129,7 @@ sail search query "name:a*" --indices identities --folderPath ./local/folder/pat For more detailed search queries, you can provide a predefined template instead of constructing the whole query every time. This allows you to run very detailed search queries quickly and easily. -The `template` command allows you to use predefined templates to search IdentityNow. +The `template` command allows you to use predefined templates to search Identity Security Cloud. ### Command @@ -139,7 +139,7 @@ This example shows the essential `template` command structure: sail search template all-provisioning-events-90-days ``` -The specified template file will give the CLI all the information it needs to perform its search in IdentityNow. +The specified template file will give the CLI all the information it needs to perform its search in Identity Security Cloud. ### Flags diff --git a/products/idn/tools/cli/set.md b/docs/tools/cli/set.md similarity index 100% rename from products/idn/tools/cli/set.md rename to docs/tools/cli/set.md diff --git a/products/idn/tools/cli/spconfig.md b/docs/tools/cli/spconfig.md similarity index 87% rename from products/idn/tools/cli/spconfig.md rename to docs/tools/cli/spconfig.md index 867f79b9b..9e8490d8c 100644 --- a/products/idn/tools/cli/spconfig.md +++ b/docs/tools/cli/spconfig.md @@ -15,7 +15,7 @@ tags: ['CLI'] Learn how to use the CLI to import and export configurations. -You can use the [SP Config APIs](/idn/api/beta/sp-config) to import configurations into IDN and export them out. +You can use the [SP Config APIs](/docs/api/beta/sp-config) to import configurations into ISC and export them out. With the `spconfig` command, you can access the same functionality. @@ -38,9 +38,9 @@ To perform SPConfig operations, you can run these commands: ### Download -You can use the `download` command to download import and export job results from IDN. The `download` command is specified differently for **Linux/Mac** and **Windows**, respectively. +You can use the `download` command to download import and export job results from ISC. The `download` command is specified differently for **Linux/Mac** and **Windows**, respectively. -To download import and export job results from IDN on **Linux/Mac**, run this command: +To download import and export job results from ISC on **Linux/Mac**, run this command: ```shell sail spconfig download \ @@ -48,7 +48,7 @@ sail spconfig download \ --export {export job ID} ``` -To download import and export job results from IDN on **Windows**, run this command: +To download import and export job results from ISC on **Windows**, run this command: ```shell sail spconfig download \ @@ -66,7 +66,7 @@ You can add these flags to the `download` command: ### Import -To begin an import task in IDN, run this command: +To begin an import task in ISC, run this command: ```shell sail spconfig import \ @@ -81,7 +81,7 @@ You can add these flags to the `import` command: ### Export -To begin an export task in IDN, run this command: +To begin an export task in ISC, run this command: ```shell sail spconfig export \ @@ -102,7 +102,7 @@ You can add these flags to the `export` command: ### Status -To check the status of import and export jobs in IDN, run this command: +To check the status of import and export jobs in ISC, run this command: ```shell sail spconfig status --import {import job ID to check} --export {export job ID to check} @@ -117,7 +117,7 @@ You can add these flags to the `status` command: ### Template -To begin exporting a template from IDN, run this command: +To begin exporting a template from ISC, run this command: ```shell sail spconfig template diff --git a/products/idn/tools/cli/transforms.md b/docs/tools/cli/transforms.md similarity index 51% rename from products/idn/tools/cli/transforms.md rename to docs/tools/cli/transforms.md index fb7774719..6d9ed1d76 100644 --- a/products/idn/tools/cli/transforms.md +++ b/docs/tools/cli/transforms.md @@ -15,7 +15,7 @@ tags: ['CLI'] Learn about the CLI commands you can use to create, manage, and test transforms in this guide. -In IdentityNow (IDN), you can use transforms to manipulate attribute data without writing any code. For more information about transforms, refer to [Transforms](/idn/docs/transforms). +In Identity Security Cloud (ISC), you can use transforms to manipulate attribute data without writing any code. For more information about transforms, refer to [Transforms](/docs/extensibility/transforms). With the `transforms` command, it's it easy to create, manage, and test transforms in the CLI. @@ -29,10 +29,6 @@ To create, manage, and test transforms with the CLI, you can use these commands: - [Download transforms](#download-transforms) - [Create transform](#create-transform) - [Update transform](#update-transform) - - [Preview transform](#preview-transform) - - [Explicit input](#explicit-input) - - [Implicit input](#implicit-input) - - [Output](#output) - [Delete transform](#delete-transform) ## List transforms @@ -77,58 +73,7 @@ To update a transform from a `json` file, run the following command. Use the `-f sail transform update -f transform.json ``` -A common workflow is to first download the transforms, then make edits to the transform file, and then use the update command to save those edits in IDN. - -## Preview transform - -You can use the preview command to view a preview of the final output of a transform, using real account data from IDN. This command is safe to use when you are testing - it does not modify account or identity details in IDN. - -You can preview both transforms with [explicit input](#explicit-input) and transforms with [implicit input](#implicit-input) determined by their identity profile mappings in IDN. - -### Explicit input - -Transforms that use "explicit input" have direct references in their specifications to the account attributes the transforms will apply to. These transforms require additional flags: - -- `-i` The identity profile ID to use for the preview. You can find the ID of the identity profile you are interested in by using the [Identity Profiles List](/idn/api/v3/list-identity-profiles) endpoint. -- `-a` The name of the identity attribute to apply the transform to. This depends on the identity profile's available attributes. - -To preview an "explicit" input transform, run your command like this example: - -```shell -sail transform preview -i 2c91808876628b6201767b4bfea61dbb -a department -f transform.json -``` - -This example previews the output of a transform that will convert a specific identity's department name based on the details in the "transform.json" file. - -### Implicit input - -Transforms that use "implicit input"* rely on the identity profile mapping in IDN to determine which account attribute to apply the transform to. These transforms require additional flags. - -- `--implicit` This indicates that the transform uses implicit input. It does not specify an account attribute directly in the JSON. -- `-n ` The name of the transform. The transform must be saved in IDN before you run this command. - -To preview an "implicit" input transform, run your command like this example: - -```shell -sail transform preview -i 2c91808876628b6201767b4bfea61dbb -a department -n ToUpper --implicit -``` - -This example previews the output of a transform that will convert a specific identity's incoming lowercased department name to an uppercased name based on identity profile mapping in IDN. - -### Output - -The preview command produces this output: - -```shell -Original value: adam.archer -Transformed value: ADAM.ARCHER -``` - -This is an example of a preview for a transform that is converting incoming lowercased account names into uppercased account names. - -The `Original value` is the value of the identity attribute at the time of the last identity refresh. It is not the value of the account attribute as it currently exists on the source. The value may already have been transformed if the identity profile mapping has a transform mapped to the attribute. - -The `Transformed value` is a result of a change to the account attribute, according to the transform specification. This is what the identity attribute will become if you use this transform in the identity profile. +A common workflow is to first download the transforms, then make edits to the transform file, and then use the update command to save those edits in ISC. ## Delete transform @@ -158,4 +103,4 @@ sail transform list | 1f3a97cf-e58b-4fad-b2f2-0dcc19fb1627 | NETID | +--------------------------------------+--------------------------+ sail transform delete 03d5187b-ab96-402c-b5a1-40b74285d77a -``` \ No newline at end of file +``` diff --git a/products/idn/tools/cli/va.md b/docs/tools/cli/va.md similarity index 98% rename from products/idn/tools/cli/va.md rename to docs/tools/cli/va.md index d62c6dd80..3dc27faf6 100644 --- a/products/idn/tools/cli/va.md +++ b/docs/tools/cli/va.md @@ -14,7 +14,7 @@ tags: ['CLI'] Learn about the CLI commands you can use to interact with VAs in this guide. -A virtual appliance (VA) is a Linux-based virtual machine that connects to your sources and applications in IDN by using APIs, connectors, and other integrations SailPoint has made available. +A virtual appliance (VA) is a Linux-based virtual machine that connects to your sources and applications in ISC by using APIs, connectors, and other integrations SailPoint has made available. For more information about VAs, refer to the [Virtual Appliance Reference Guide](https://community.sailpoint.com/t5/IdentityNow-Connectors/Virtual-Appliance-Reference-Guide/ta-p/74641?_ga=2.265747530.43742715.1681135659-1245631791.1680185785&_gl=1*1bevvkq*_ga*MTI0NTYzMTc5MS4xNjgwMTg1Nzg1*_ga_SS72Z4HXJM*MTY4MTMwOTc1MC4yOS4xLjE2ODEzMDk5MzkuMjguMC4w). diff --git a/products/idn/tools/cli/workflow.md b/docs/tools/cli/workflow.md similarity index 95% rename from products/idn/tools/cli/workflow.md rename to docs/tools/cli/workflow.md index 0736e71c6..fcebd0989 100644 --- a/products/idn/tools/cli/workflow.md +++ b/docs/tools/cli/workflow.md @@ -15,7 +15,7 @@ tags: ['CLI'] Learn how to use the SailPoint CLI to create, manage, and test workflows in this guide. -A workflow is a set of steps that are completed whenever a specific event occurs. Once that event triggers the workflow, the workflow performs the steps within IdentityNow. +A workflow is a set of steps that are completed whenever a specific event occurs. Once that event triggers the workflow, the workflow performs the steps within Identity Security Cloud. The `workflow` command makes it easy to create, manage, and test workflows from within the SailPoint CLI. To learn more about workflows, refer to [Workflows](https://documentation.sailpoint.com/saas/help/workflows/workflow-basics.html?h=workflow). @@ -42,7 +42,7 @@ The `workflow` command makes it easy to create, manage, and test workflows from The CLI will return a table of the available workflows in your tenant, with their IDs. - This command uses the [List Workflows endpoint](https://developer.sailpoint.com/idn/api/beta/list-workflows). + This command uses the [List Workflows endpoint](https://developer.sailpoint.com/docs/api/beta/list-workflows). ## Get workflow @@ -60,7 +60,7 @@ The `workflow` command makes it easy to create, manage, and test workflows from The CLI will return the workflow, along with all its details. - This command uses the [Get workflow endpoint](https://developer.sailpoint.com/idn/api/beta/get-workflow). + This command uses the [Get workflow endpoint](https://developer.sailpoint.com/docs/api/beta/get-workflow). ## Create workflow @@ -84,7 +84,7 @@ The `workflow` command makes it easy to create, manage, and test workflows from Once you create the workflow, it will be located in the file path you specified. - This command uses the [Create workflow endpoint](https://developer.sailpoint.com/idn/api/beta/create-workflow). + This command uses the [Create workflow endpoint](https://developer.sailpoint.com/docs/api/beta/create-workflow). ### File path @@ -130,7 +130,7 @@ The `workflow` command makes it easy to create, manage, and test workflows from The updated workflow will be located in the file path you specified. - This command uses the [Update workflow endpoint](https://developer.sailpoint.com/idn/api/beta/update-workflow). + This command uses the [Update workflow endpoint](https://developer.sailpoint.com/docs/api/beta/update-workflow). ### File path @@ -174,7 +174,7 @@ The `workflow` command makes it easy to create, manage, and test workflows from sail workflow delete $(cat list_of_workflowIDs.txt) ``` - This command uses the [Delete workflow endpoint](https://developer.sailpoint.com/idn/api/beta/delete-workflow). + This command uses the [Delete workflow endpoint](https://developer.sailpoint.com/docs/api/beta/delete-workflow). ## Download workflow diff --git a/products/idn/tools/rule-development-kit/assets/intellisense.png b/docs/tools/rule-development-kit/assets/intellisense.png similarity index 100% rename from products/idn/tools/rule-development-kit/assets/intellisense.png rename to docs/tools/rule-development-kit/assets/intellisense.png diff --git a/products/idn/tools/rule-development-kit/index.md b/docs/tools/rule-development-kit/index.md similarity index 96% rename from products/idn/tools/rule-development-kit/index.md rename to docs/tools/rule-development-kit/index.md index fcc21c1f2..dbdb06cb1 100644 --- a/products/idn/tools/rule-development-kit/index.md +++ b/docs/tools/rule-development-kit/index.md @@ -6,7 +6,7 @@ sidebar_label: Rule Development Kit sidebar_position: 3 sidebar_class_name: rdk keywords: ['rule', 'development','kit'] -description: The SailPoint Rule Development Kit is a project that enables you to develop rules more quickly and easily. +description: Rule development made quick and easy. slug: /tools/rule-development-kit tags: ['RDK'] --- @@ -15,7 +15,7 @@ tags: ['RDK'] The SailPoint Rule Development Kit (RDK) is a project you can use to develop rules more quickly and easily. -In SailPoint solutions, rules serve as flexible configuration frameworks implementers can leverage to preform complex or advanced configurations. To learn more about them, refer to [Rules](../../docs/identity-now/rules/index.md). +In SailPoint solutions, rules serve as flexible configuration frameworks implementers can leverage to preform complex or advanced configurations. To learn more about them, refer to [Rules](../../extensibility/rules/index.md). The RDK provides you with the available classes and methods available when you're developing a rule. You can mock out these classes and run your rule locally to test your logic before submitting it for review. @@ -60,7 +60,7 @@ src/ * **`src/main/java/`** Use this folder to develop your rules before putting them into the rule XML format. Import objects as needed from `sailpoint.*` -* **`src/main/resources/rules/`** Use this folder to store your rules in the XML format you would expect to upload to IdentityNow (IDN). +* **`src/main/resources/rules/`** Use this folder to store your rules in the XML format you would expect to upload to Identity Security Cloud (ISC). * **`src/test/java/sailpoint/`** Use this folder for test classes to test your rules. @@ -84,7 +84,7 @@ The rule development kit provides you with intellisense when writing rules, you ## Create your new rule -To get syntax highlighting and the features from the IDE, this guide shows how to write the rule in native Java and move it over to the XML format needed when you're storing it in IdentityNow (IDN). +To get syntax highlighting and the features from the IDE, this guide shows how to write the rule in native Java and move it over to the XML format needed when you're storing it in Identity Security Cloud (ISC). This guide will walk through an example of how to duplicate writing the 'Username Generator' rule that ships with the RDK. @@ -92,9 +92,9 @@ Create a new Java class under `src/main/java`, called `UsernameGenerator`. ## Import the classes and initialize the objects the rule needs -Each rule type has inputs provided to the rule. You can view available inputs for each rule type by clicking the rule type [here](/idn/docs/rules/cloud-rules#supported-cloud-rules). +Each rule type has inputs provided to the rule. You can view available inputs for each rule type by clicking the rule type [here](/docs/extensibility/rules/cloud-rules#supported-cloud-rules). -The 'Username Generator' rule uses the `AttributeGenerator` rule type. See [Attribute Generator](/idn/docs/rules/cloud-rules/account-profile-attribute-generator#input) for the available inputs. +The 'Username Generator' rule uses the `AttributeGenerator` rule type. See [Attribute Generator](/docs/extensibility/rules/cloud-rules/account-profile-attribute-generator#input) for the available inputs. In your IDE, import the classes needed, and initialize these inputs within your newly created class. @@ -117,7 +117,7 @@ public class UsernameGenerator { ## Write your rule logic -You can see the completed code for the 'Username Generator' in the following code. If you want to dive deeper into how this rule was written, follow [this guide](/idn/docs/rules/guides/your-first-rule). +You can see the completed code for the 'Username Generator' in the following code. If you want to dive deeper into how this rule was written, follow [this guide](/docs/extensibility/rules/guides/your-first-rule).
    Completed Username Generator Code @@ -230,7 +230,7 @@ public class UsernameGenerator { ## Convert the rule to XML format -The final step required before you can test your rule is converting it to XML format. These XML files are stored under the `/src/main/resources/rules` directory in the RDK. You can find the `AttributeGenerator` template file [here](/idn/docs/rules/cloud-rules/account-profile-attribute-generator#template). +The final step required before you can test your rule is converting it to XML format. These XML files are stored under the `/src/main/resources/rules` directory in the RDK. You can find the `AttributeGenerator` template file [here](/docs/extensibility/rules/cloud-rules/account-profile-attribute-generator#template). Replace `Example Rule` with the preferred name of your rule, and add a short description. @@ -527,7 +527,7 @@ Interpreter i = new Interpreter(); ### Mock the objects and return the mocked data -Anywhere your rule uses data from IDN, you will need to mock out those objects. In the 'Username Generator' example, the objects used are `IdnRuleUtil`, `Application`, and `Identity`. +Anywhere your rule uses data from ISC, you will need to mock out those objects. In the 'Username Generator' example, the objects used are `IdnRuleUtil`, `Application`, and `Identity`. ```java IdnRuleUtil idn = mock(); diff --git a/docs/tools/sdk/_category_.json b/docs/tools/sdk/_category_.json new file mode 100644 index 000000000..5e0e7bf42 --- /dev/null +++ b/docs/tools/sdk/_category_.json @@ -0,0 +1,5 @@ +{ + "customProps": { + "description": "Streamlined development in your language of choice" + } +} \ No newline at end of file diff --git a/products/idn/tools/sdk/go/creating-resources.md b/docs/tools/sdk/go/creating-resources.md similarity index 100% rename from products/idn/tools/sdk/go/creating-resources.md rename to docs/tools/sdk/go/creating-resources.md diff --git a/products/idn/tools/sdk/go/deleting-resources.md b/docs/tools/sdk/go/deleting-resources.md similarity index 100% rename from products/idn/tools/sdk/go/deleting-resources.md rename to docs/tools/sdk/go/deleting-resources.md diff --git a/products/idn/tools/sdk/go/error-handling.md b/docs/tools/sdk/go/error-handling.md similarity index 100% rename from products/idn/tools/sdk/go/error-handling.md rename to docs/tools/sdk/go/error-handling.md diff --git a/products/idn/tools/sdk/go/getting-started.md b/docs/tools/sdk/go/getting-started.md similarity index 100% rename from products/idn/tools/sdk/go/getting-started.md rename to docs/tools/sdk/go/getting-started.md diff --git a/products/idn/tools/sdk/go/index.mdx b/docs/tools/sdk/go/index.mdx similarity index 94% rename from products/idn/tools/sdk/go/index.mdx rename to docs/tools/sdk/go/index.mdx index 5d6574969..e4f318042 100644 --- a/products/idn/tools/sdk/go/index.mdx +++ b/docs/tools/sdk/go/index.mdx @@ -6,7 +6,7 @@ sidebar_label: Golang sidebar_position: 2 sidebar_class_name: gosdk keywords: ['go', 'golang', 'sdk'] -description: Learn how to use the Golang SDK in this guide. +description: Easy ISC development in Golang SDK. slug: /tools/sdk/go tags: ['SDK', 'Software Development Kit'] --- @@ -19,9 +19,9 @@ You need the following to use the Go SDK: - Golang version 1.18 or above. You can download it [here](https://go.dev/dl/). You can use `go version` to check your version. -- Your tenant name in IdentityNow. To learn how to find it, refer to [Getting Started](/idn/api/getting-started#find-your-tenant-name). The SDK will use this tenant name to connect to your IdentityNow instance. +- Your tenant name in IdentityNow. To learn how to find it, refer to [Getting Started](/docs/api/getting-started#find-your-tenant-name). The SDK will use this tenant name to connect to your IdentityNow instance. -- A PAT with a client secret and ID. To learn how to create one in IDN, refer to [Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/api_keys.html#generating-a-personal-access-token). The SDK will use this PAT to authenticate with the SailPoint APIs. +- A PAT with a client secret and ID. To learn how to create one in ISC, refer to [Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/api_keys.html#generating-a-personal-access-token). The SDK will use this PAT to authenticate with the SailPoint APIs. ## Setup @@ -189,7 +189,7 @@ To get your environment variables to persist across PowerShell sessions, run the ## Discuss -You can use this SDK to build new tools that extend your IDN platform and improve experiences across your organization. Use this guide to get started, and if you have questions, don't hesitate to reach out on the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss! +You can use this SDK to build new tools that extend your ISC platform and improve experiences across your organization. Use this guide to get started, and if you have questions, don't hesitate to reach out on the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss! ## Getting Started diff --git a/products/idn/tools/sdk/go/pagination.md b/docs/tools/sdk/go/pagination.md similarity index 95% rename from products/idn/tools/sdk/go/pagination.md rename to docs/tools/sdk/go/pagination.md index 087d4effa..70dfecc03 100644 --- a/products/idn/tools/sdk/go/pagination.md +++ b/docs/tools/sdk/go/pagination.md @@ -11,7 +11,7 @@ slug: /tools/sdk/go/paginate tags: ['SDK', 'Software Development Kit'] --- -By default, your requests will return a maximum of 250 records. To return more, you must implement pagination. To learn more about pagination, refer to [Paginating Results](/idn/api/standard-collection-parameters/#paginating-results). +By default, your requests will return a maximum of 250 records. To return more, you must implement pagination. To learn more about pagination, refer to [Paginating Results](/docs/api/standard-collection-parameters/#paginating-results). Pagination is implemented with the SDK in the following code block on line 18: diff --git a/products/idn/tools/sdk/go/retries.md b/docs/tools/sdk/go/retries.md similarity index 100% rename from products/idn/tools/sdk/go/retries.md rename to docs/tools/sdk/go/retries.md diff --git a/products/idn/tools/sdk/go/search.md b/docs/tools/sdk/go/search.md similarity index 94% rename from products/idn/tools/sdk/go/search.md rename to docs/tools/sdk/go/search.md index 3ec32cdd3..40c77a6eb 100644 --- a/products/idn/tools/sdk/go/search.md +++ b/docs/tools/sdk/go/search.md @@ -11,7 +11,7 @@ slug: /tools/sdk/go/search tags: ['SDK', 'Software Development Kit'] --- -To try using the IDN [search functionality](/idn/api/v3/search-post) along with pagination, copy this code into your "sdk.go" file, following the main code: +To try using the ISC [search functionality](/docs/api/v3/search-post) along with pagination, copy this code into your "sdk.go" file, following the main code: ```go func getSearchResults(ctx context.Context, apiClient *sailpoint.APIClient) { diff --git a/products/idn/tools/sdk/go/updating-resources.md b/docs/tools/sdk/go/updating-resources.md similarity index 100% rename from products/idn/tools/sdk/go/updating-resources.md rename to docs/tools/sdk/go/updating-resources.md diff --git a/docs/tools/sdk/index.md b/docs/tools/sdk/index.md new file mode 100644 index 000000000..d7d8b39c4 --- /dev/null +++ b/docs/tools/sdk/index.md @@ -0,0 +1,29 @@ +--- +id: sdk +title: SDKs +pagination_label: SDKs +sidebar_label: SDKs +sidebar_position: 2 +sidebar_class_name: sdk +keywords: ['sdk'] +description: Easy ISC development in your preferred coding language. +slug: /tools/sdk +tags: ['SDK'] +--- + +## Overview + +The SailPoint software development kits (SDKs) make it easier for developers to leverage the Identity Security Cloud (ISC) APIs, extensibility options, and connectivity while they build with their preferred coding languages. + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + +## Discuss + +The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions. + +To learn more about the ISC SDKs and discuss them with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/isc/6). \ No newline at end of file diff --git a/products/idn/tools/sdk/powershell/creating-resources.md b/docs/tools/sdk/powershell/creating-resources.md similarity index 100% rename from products/idn/tools/sdk/powershell/creating-resources.md rename to docs/tools/sdk/powershell/creating-resources.md diff --git a/products/idn/tools/sdk/powershell/deleting-resources.md b/docs/tools/sdk/powershell/deleting-resources.md similarity index 100% rename from products/idn/tools/sdk/powershell/deleting-resources.md rename to docs/tools/sdk/powershell/deleting-resources.md diff --git a/products/idn/tools/sdk/powershell/error-handling.md b/docs/tools/sdk/powershell/error-handling.md similarity index 100% rename from products/idn/tools/sdk/powershell/error-handling.md rename to docs/tools/sdk/powershell/error-handling.md diff --git a/products/idn/tools/sdk/powershell/getting-started.md b/docs/tools/sdk/powershell/getting-started.md similarity index 94% rename from products/idn/tools/sdk/powershell/getting-started.md rename to docs/tools/sdk/powershell/getting-started.md index fc43fb77a..bd8f2d690 100644 --- a/products/idn/tools/sdk/powershell/getting-started.md +++ b/docs/tools/sdk/powershell/getting-started.md @@ -87,21 +87,21 @@ DESCRIPTION PARAMETERS -Offset Offset into the full result set. Usually specified with *limit* to paginate through the results. For more information, refer to [V3 API Standard Collection - Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters). + Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters). -Limit - Max number of results to return. For more information, refer to [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters). + Max number of results to return. For more information, refer to [V3 API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters). -Count 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. For more information, refer to [V3 API Standard Collection - Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters). + Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters). -Name Name of the transform to retrieve from the list. -Filters - 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 + Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results). Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* -WithHttpInfo [] diff --git a/products/idn/tools/sdk/powershell/index.mdx b/docs/tools/sdk/powershell/index.mdx similarity index 95% rename from products/idn/tools/sdk/powershell/index.mdx rename to docs/tools/sdk/powershell/index.mdx index 142bc0b91..958a1be00 100644 --- a/products/idn/tools/sdk/powershell/index.mdx +++ b/docs/tools/sdk/powershell/index.mdx @@ -6,7 +6,7 @@ sidebar_label: PowerShell sidebar_position: 3 sidebar_class_name: powershellsdk keywords: ['powershell', 'sdk'] -description: Learn how to use the PowerShell SDK in this guide. +description: Easy ISC development in PowerShell. slug: /tools/sdk/powershell tags: ['SDK'] --- @@ -19,9 +19,9 @@ You need the following to use the PowerShell SDK: - PowerShell 6.2 or greater. To learn how to install, refer to [Installing PowerShell](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.4). -- Your tenant name in IdentityNow. To learn how to find it, refer to [Getting Started](/idn/api/getting-started#find-your-tenant-name). The SDK will use this tenant name to connect to your IdentityNow instance. +- Your tenant name in IdentityNow. To learn how to find it, refer to [Getting Started](/docs/api/getting-started#find-your-tenant-name). The SDK will use this tenant name to connect to your IdentityNow instance. -- A PAT with a client secret and ID. To learn how to create one in IDN, refer to [Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/api_keys.html#generating-a-personal-access-token). The SDK will use this PAT to authenticate with the SailPoint APIs. +- A PAT with a client secret and ID. To learn how to create one in ISC, refer to [Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/api_keys.html#generating-a-personal-access-token). The SDK will use this PAT to authenticate with the SailPoint APIs. ## Setup @@ -193,7 +193,7 @@ To get your environment variables to persist across PowerShell sessions, run the ## Discuss -You can use this SDK to build new tools that extend your IDN platform and improve experiences across your organization. Use this guide to get started, and if you have questions, don't hesitate to reach out on the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss! +You can use this SDK to build new tools that extend your ISC platform and improve experiences across your organization. Use this guide to get started, and if you have questions, don't hesitate to reach out on the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss! ## Getting Started diff --git a/products/idn/tools/sdk/powershell/pagination.md b/docs/tools/sdk/powershell/pagination.md similarity index 89% rename from products/idn/tools/sdk/powershell/pagination.md rename to docs/tools/sdk/powershell/pagination.md index 8725c8e58..e3b17d635 100644 --- a/products/idn/tools/sdk/powershell/pagination.md +++ b/docs/tools/sdk/powershell/pagination.md @@ -11,7 +11,7 @@ slug: /tools/sdk/powershell/paginate tags: ['SDK'] --- -By default, your requests will return a maximum of 250 records. To return more, you must implement pagination. To learn more about pagination, refer to [Paginating Results](/idn/api/standard-collection-parameters/#paginating-results). +By default, your requests will return a maximum of 250 records. To return more, you must implement pagination. To learn more about pagination, refer to [Paginating Results](/docs/api/standard-collection-parameters/#paginating-results). Pagination is implemented with the SDK in the following code block on line 8: @@ -45,4 +45,4 @@ The `-Parameters` specifies a hashtable of additional values passed to the API e You can also provide an `-InitialOffset` value to specify the record number to start the request on. For example, you can provide add `-InitialOffset 10` to start getting accounts from 11 instead of 0. -To find out whether an endpoint supports pagination, refer to its documentation. Any API supporting pagination lists the optional query parameters detailed in [Paginating Results](/idn/api/standard-collection-parameters/#paginating-results). +To find out whether an endpoint supports pagination, refer to its documentation. Any API supporting pagination lists the optional query parameters detailed in [Paginating Results](/docs/api/standard-collection-parameters/#paginating-results). diff --git a/products/idn/tools/sdk/powershell/retries.md b/docs/tools/sdk/powershell/retries.md similarity index 100% rename from products/idn/tools/sdk/powershell/retries.md rename to docs/tools/sdk/powershell/retries.md diff --git a/products/idn/tools/sdk/powershell/search.md b/docs/tools/sdk/powershell/search.md similarity index 78% rename from products/idn/tools/sdk/powershell/search.md rename to docs/tools/sdk/powershell/search.md index 62712c7bc..618f798d7 100644 --- a/products/idn/tools/sdk/powershell/search.md +++ b/docs/tools/sdk/powershell/search.md @@ -11,7 +11,7 @@ slug: /tools/sdk/powershell/search tags: ['SDK'] --- -The PowerShell SDK provides you access to IdentityNow's [Search](https://documentation.sailpoint.com/saas/help/search/index.html) functionality. +The PowerShell SDK provides you access to Identity Security Cloud's [Search](https://documentation.sailpoint.com/saas/help/search/index.html) functionality. Here is an example search you can copy into your PowerShell instance to try it out: @@ -40,7 +40,7 @@ try { } ``` -This example request uses the [Perform Search endpoint](/idn/api/v3/search-post) to search your tenant for identities with the name "john.doe". +This example request uses the [Perform Search endpoint](/docs/api/v3/search-post) to search your tenant for identities with the name "john.doe". ### Paginate search results @@ -79,7 +79,7 @@ try { } ``` -This example searches your IdentityNow tenant for all identities and sorts them by their `displayName` in descending order. The search returns a maximum of 150000 records (the `Limit`) and 5000 records per page (the `Increment`). +This example searches your Identity Security Cloud tenant for all identities and sorts them by their `displayName` in descending order. The search returns a maximum of 150000 records (the `Limit`) and 5000 records per page (the `Increment`). To paginate the search results, you can specify these parameters: diff --git a/products/idn/tools/sdk/powershell/updating-resources.md b/docs/tools/sdk/powershell/updating-resources.md similarity index 100% rename from products/idn/tools/sdk/powershell/updating-resources.md rename to docs/tools/sdk/powershell/updating-resources.md diff --git a/products/idn/tools/sdk/typescript/creating-resources.md b/docs/tools/sdk/typescript/creating-resources.md similarity index 100% rename from products/idn/tools/sdk/typescript/creating-resources.md rename to docs/tools/sdk/typescript/creating-resources.md diff --git a/products/idn/tools/sdk/typescript/deleting-resources.md b/docs/tools/sdk/typescript/deleting-resources.md similarity index 100% rename from products/idn/tools/sdk/typescript/deleting-resources.md rename to docs/tools/sdk/typescript/deleting-resources.md diff --git a/products/idn/tools/sdk/typescript/error-handling.md b/docs/tools/sdk/typescript/error-handling.md similarity index 100% rename from products/idn/tools/sdk/typescript/error-handling.md rename to docs/tools/sdk/typescript/error-handling.md diff --git a/products/idn/tools/sdk/typescript/getting-started.md b/docs/tools/sdk/typescript/getting-started.md similarity index 95% rename from products/idn/tools/sdk/typescript/getting-started.md rename to docs/tools/sdk/typescript/getting-started.md index 0ed5e9c8e..4b1d425f0 100644 --- a/products/idn/tools/sdk/typescript/getting-started.md +++ b/docs/tools/sdk/typescript/getting-started.md @@ -47,7 +47,7 @@ To run the SDK, run the `node src/index.js` command. This command sends the requ Using the same SDK function, you can list your transforms but limit the results to only what you want. This example wants a list of no more than 10 transforms that start with the name "Test": -Refer to [List Transforms](https://developer.sailpoint.com/idn/api/v3/list-transforms) for all its supported query parameters. +Refer to [List Transforms](https://developer.sailpoint.com/docs/api/v3/list-transforms) for all its supported query parameters. ```typescript import {Configuration, TransformsApi} from "sailpoint-api-client" diff --git a/products/idn/tools/sdk/typescript/index.mdx b/docs/tools/sdk/typescript/index.mdx similarity index 95% rename from products/idn/tools/sdk/typescript/index.mdx rename to docs/tools/sdk/typescript/index.mdx index 599059710..8c054ef5c 100644 --- a/products/idn/tools/sdk/typescript/index.mdx +++ b/docs/tools/sdk/typescript/index.mdx @@ -6,7 +6,7 @@ sidebar_label: TypeScript sidebar_position: 4 sidebar_class_name: typescriptsdk keywords: ['tsc', 'typescript', 'sdk'] -description: Learn how to use the TypeScript SDK in this guide. +description: Easy ISC development in TypeScript. slug: /tools/sdk/typescript tags: ['SDK'] --- @@ -27,9 +27,9 @@ You need the following to use the TypeScript SDK: npm install -g typescript ``` -- Your tenant name in IDN. To learn how to find it, refer to [Getting Started](/idn/api/getting-started#find-your-tenant-name). The SDK will use this tenant name to connect to your IDN instance. +- Your tenant name in ISC. To learn how to find it, refer to [Getting Started](/docs/api/getting-started#find-your-tenant-name). The SDK will use this tenant name to connect to your ISC instance. -- A PAT with a client secret and ID. To learn how to create one in IDN, refer to [Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/api_keys.html#generating-a-personal-access-token). The SDK will use this PAT to authenticate with the SailPoint APIs. +- A PAT with a client secret and ID. To learn how to create one in ISC, refer to [Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/api_keys.html#generating-a-personal-access-token). The SDK will use this PAT to authenticate with the SailPoint APIs. ## Setup @@ -229,7 +229,7 @@ To get your environment variables to persist across PowerShell sessions, run the ## Discuss -You can use this SDK to build new tools that extend your IDN platform and improve experiences across your organization. Use this guide to get started, and if you have questions, don't hesitate to reach out on the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss! +You can use this SDK to build new tools that extend your ISC platform and improve experiences across your organization. Use this guide to get started, and if you have questions, don't hesitate to reach out on the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss! ## Getting Started diff --git a/products/idn/tools/sdk/typescript/pagination.md b/docs/tools/sdk/typescript/pagination.md similarity index 89% rename from products/idn/tools/sdk/typescript/pagination.md rename to docs/tools/sdk/typescript/pagination.md index b80c2d71a..e17694143 100644 --- a/products/idn/tools/sdk/typescript/pagination.md +++ b/docs/tools/sdk/typescript/pagination.md @@ -11,7 +11,7 @@ slug: /tools/sdk/typescript/paginate tags: ['SDK'] --- -By default, your requests will return a maximum of 250 records. To return more, you must implement pagination. To learn more about pagination, refer to [Paginating Results](/idn/api/standard-collection-parameters/#paginating-results). +By default, your requests will return a maximum of 250 records. To return more, you must implement pagination. To learn more about pagination, refer to [Paginating Results](/docs/api/standard-collection-parameters/#paginating-results). Pagination is implemented with the SDK in the following code block on line 7: @@ -42,4 +42,4 @@ The `limit` specifies the total number of results you can return, 1000. The foll You can also provide an `offset` value to specify the record number to start the request on. For example, you can add `{offset: 11}` to start getting accounts from 11 instead of 0. -To find out whether an endpoint supports pagination, refer to its documentation. Any API supporting pagination lists the optional query parameters detailed in [Paginating Results](/idn/api/standard-collection-parameters/#paginating-results). +To find out whether an endpoint supports pagination, refer to its documentation. Any API supporting pagination lists the optional query parameters detailed in [Paginating Results](/docs/api/standard-collection-parameters/#paginating-results). diff --git a/products/idn/tools/sdk/typescript/retries.md b/docs/tools/sdk/typescript/retries.md similarity index 100% rename from products/idn/tools/sdk/typescript/retries.md rename to docs/tools/sdk/typescript/retries.md diff --git a/products/idn/tools/sdk/typescript/search.md b/docs/tools/sdk/typescript/search.md similarity index 91% rename from products/idn/tools/sdk/typescript/search.md rename to docs/tools/sdk/typescript/search.md index 92c6ecc16..ec089c0c1 100644 --- a/products/idn/tools/sdk/typescript/search.md +++ b/docs/tools/sdk/typescript/search.md @@ -11,7 +11,7 @@ slug: /tools/sdk/typescript/search tags: ['SDK'] --- -To try using the IDN [search functionality](/idn/api/v3/search-post) along with pagination, copy this code into your "index.ts" file: +To try using the ISC [search functionality](/docs/api/v3/search-post) along with pagination, copy this code into your "index.ts" file: ```typescript const search = async () => { diff --git a/products/idn/tools/sdk/typescript/updating-resources.md b/docs/tools/sdk/typescript/updating-resources.md similarity index 100% rename from products/idn/tools/sdk/typescript/updating-resources.md rename to docs/tools/sdk/typescript/updating-resources.md diff --git a/docusaurus.config.js b/docusaurus.config.js index 3abeb56fe..838cbee06 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -17,8 +17,8 @@ const config = { url: 'https://developer.sailpoint.com', baseUrl, favicon: 'img/SailPoint-Logo-Icon.ico', - onBrokenLinks: 'throw', - onBrokenMarkdownLinks: 'throw', + // onBrokenLinks: 'throw', + // onBrokenMarkdownLinks: 'throw', onDuplicateRoutes: 'throw', i18n: { defaultLocale: 'en', diff --git a/footer.js b/footer.js index 2b0899997..23150313b 100644 --- a/footer.js +++ b/footer.js @@ -2,19 +2,19 @@ module.exports = { style: 'light', links: [ { - title: 'IdentityNow', + title: 'Identity Security Cloud', items: [ { label: 'Your First API Call', - to: 'idn/api/getting-started', + to: 'docs/api/getting-started', }, { label: 'Build A Transform', - to: 'idn/docs/transforms/guides/your-first-transform', + to: 'docs/extensibility/transforms/guides/your-first-transform', }, { label: 'Build A SaaS Connector', - to: 'idn/docs/saas-connectivity', + to: 'docs/connectivity/saas-connectivity', }, { label: 'Get Certified', diff --git a/navbar.js b/navbar.js index 915b293e8..0c7fd2dff 100644 --- a/navbar.js +++ b/navbar.js @@ -7,72 +7,19 @@ module.exports = { }, items: [ { - type: 'dropdown', - label: 'IdentityNow', position: 'left', - items: [ - {to: '#', label: 'API Specifications', className: 'navbar__section'}, - {to: '/idn/api/v3', label: 'V3 APIs', className: 'indent'}, - {to: '/idn/api/beta', label: 'Beta APIs', className: 'indent'}, - {to: '#', label: 'Documentation', className: 'navbar__section'}, - {to: 'idn/docs', label: 'IDN Documentation', className: 'indent'}, - {to: '#', label: 'Tools', className: 'navbar__section'}, - {to: 'idn/tools/cli', label: 'CLI', className: 'indent'}, - {to: 'idn/tools/sdk', label: 'SDKs', className: 'indent'}, - { - to: 'idn/tools/rule-development-kit', - label: 'Rule Development Kit', - className: 'indent', - }, - {to: '#', label: 'External Links', className: 'navbar__section'}, - { - href: 'https://documentation.sailpoint.com', - label: 'Product Documentation', - className: 'indent', - }, - { - href: 'https://university.sailpoint.com/Saba/Web_spf/NA10P1PRD075/guest/categorydetail/categ000000000003041/true/xxemptyxx/', - label: 'IdentityNow Certifications', - className: 'indent', - }, - ], + label: 'Identity Security Cloud', + to: '/docs', }, { - type: 'dropdown', + position: 'left', label: 'IdentityIQ', - position: 'left', - items: [ - {to: '#', label: 'API Specifications', className: 'navbar__section'}, - {to: '/iiq/api', label: 'IIQ APIs', className: 'indent'}, - {to: '#', label: 'Documentation', className: 'navbar__section'}, - {to: 'iiq/docs', label: 'IIQ Documentation', className: 'indent'}, - {to: '#', label: 'External Links', className: 'navbar__section'}, - { - href: 'https://documentation.sailpoint.com/#identityiq', - label: 'Product Documentation', - className: 'indent', - }, - { - href: 'https://university.sailpoint.com/Saba/Web_spf/NA10P1PRD075/guest/categorydetail/categ000000000003042/true/xxemptyxx/', - label: 'IdentityIQ Certifications', - className: 'indent', - }, - ], + to: '/docs/iiq', }, { - type: 'dropdown', - label: 'NERM', position: 'left', - items: [ - {to: '#', label: 'API Specifications', className: 'navbar__section'}, - {to: '/nerm/api', label: 'NERM APIs', className: 'indent'}, - {to: '#', label: 'External Links', className: 'navbar__section'}, - { - href: 'https://documentation.sailpoint.com', - label: 'Product Documentation', - className: 'indent', - }, - ], + label: 'CoLab', + to: '/colab', }, { position: 'left', diff --git a/package-lock.json b/package-lock.json index ae4264c2f..1414b8c02 100644 --- a/package-lock.json +++ b/package-lock.json @@ -12,6 +12,9 @@ "@docusaurus/plugin-content-docs": "^2.4.3", "@docusaurus/plugin-google-tag-manager": "^2.4.3", "@docusaurus/theme-mermaid": "2.4.3", + "@fortawesome/fontawesome-svg-core": "^6.5.1", + "@fortawesome/pro-duotone-svg-icons": "^6.5.1", + "@fortawesome/react-fontawesome": "^0.2.0", "@mdx-js/react": "^1.6.22", "@typeform/embed-react": "^1.21.0", "autoprefixer": "^10.4.13", @@ -3228,6 +3231,50 @@ "resolved": "https://registry.npmjs.org/@exodus/schemasafe/-/schemasafe-1.3.0.tgz", "integrity": "sha512-5Aap/GaRupgNx/feGBwLLTVv8OQFfv3pq2lPRzPg9R+IOBnDgghTGW7l7EuVXOvg5cc/xSAlRW8rBrjIC3Nvqw==" }, + "node_modules/@fortawesome/fontawesome-common-types": { + "version": "6.5.1", + "resolved": "https://registry.npmjs.org/@fortawesome/fontawesome-common-types/-/fontawesome-common-types-6.5.1.tgz", + "integrity": "sha512-GkWzv+L6d2bI5f/Vk6ikJ9xtl7dfXtoRu3YGE6nq0p/FFqA1ebMOAWg3XgRyb0I6LYyYkiAo+3/KrwuBp8xG7A==", + "hasInstallScript": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/@fortawesome/fontawesome-svg-core": { + "version": "6.5.1", + "resolved": "https://registry.npmjs.org/@fortawesome/fontawesome-svg-core/-/fontawesome-svg-core-6.5.1.tgz", + "integrity": "sha512-MfRCYlQPXoLlpem+egxjfkEuP9UQswTrlCOsknus/NcMoblTH2g0jPrapbcIb04KGA7E2GZxbAccGZfWoYgsrQ==", + "hasInstallScript": true, + "dependencies": { + "@fortawesome/fontawesome-common-types": "6.5.1" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/@fortawesome/pro-duotone-svg-icons": { + "version": "6.5.1", + "resolved": "https://npm.fontawesome.com/@fortawesome/pro-duotone-svg-icons/-/6.5.1/pro-duotone-svg-icons-6.5.1.tgz", + "integrity": "sha512-ywRh7WpcUD4To4TBFZc2EzbFblWiccNf9wwLFK56J7t8mO9ITQJAIPpT8x7DBrqejfbw9B4F6aH5fY6mfi0egg==", + "dependencies": { + "@fortawesome/fontawesome-common-types": "6.5.1" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/@fortawesome/react-fontawesome": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/@fortawesome/react-fontawesome/-/react-fontawesome-0.2.0.tgz", + "integrity": "sha512-uHg75Rb/XORTtVt7OS9WoK8uM276Ufi7gCzshVWkUJbHhh3svsUUeqXerrM96Wm7fRiDzfKRwSoahhMIkGAYHw==", + "dependencies": { + "prop-types": "^15.8.1" + }, + "peerDependencies": { + "@fortawesome/fontawesome-svg-core": "~1 || ~6", + "react": ">=16.3" + } + }, "node_modules/@hapi/hoek": { "version": "9.3.0", "resolved": "https://registry.npmjs.org/@hapi/hoek/-/hoek-9.3.0.tgz", diff --git a/package.json b/package.json index ce2670870..2472ac140 100644 --- a/package.json +++ b/package.json @@ -25,6 +25,9 @@ "@docusaurus/plugin-content-docs": "^2.4.3", "@docusaurus/plugin-google-tag-manager": "^2.4.3", "@docusaurus/theme-mermaid": "2.4.3", + "@fortawesome/fontawesome-svg-core": "^6.5.1", + "@fortawesome/pro-duotone-svg-icons": "^6.5.1", + "@fortawesome/react-fontawesome": "^0.2.0", "@mdx-js/react": "^1.6.22", "@typeform/embed-react": "^1.21.0", "autoprefixer": "^10.4.13", diff --git a/plugins.js b/plugins.js index c1e21ce99..a06583047 100644 --- a/plugins.js +++ b/plugins.js @@ -43,49 +43,1573 @@ module.exports = [ to: '/', from: ['/conf', '/developerdays', '/developerdays/agenda'], }, + { + to: '/ambassadors', + from: ['/ambassador-program', '/ambassador'], + }, + { + from: ['/idn/docs/saas-configuration'], + to: '/docs/extensibility/configuration-management/saas-configuration', + }, + { + from: ['/idn/docs/event-triggers'], + to: '/docs/extensibility/event-triggers', + }, + { + from: ['/idn/docs/event-triggers/available'], + to: '/docs/extensibility/event-triggers/available', + }, + { + from: ['/idn/docs/event-triggers/early-access'], + to: '/docs/extensibility/event-triggers/early-access', + }, + { + from: ['/idn/docs/event-triggers/filtering-events'], + to: '/docs/extensibility/event-triggers/filtering-events', + }, + { + from: ['/idn/docs/event-triggers/preparing-subscriber-service'], + to: '/docs/extensibility/event-triggers/preparing-subscriber-service', + }, + { + from: [ + '/idn/docs/event-triggers/responding-request-response-trigger', + ], + to: '/docs/extensibility/event-triggers/responding-request-response-trigger', + }, + { + from: ['/idn/docs/event-triggers/subscribing-to-trigger'], + to: '/docs/extensibility/event-triggers/subscribing-to-trigger', + }, + { + from: ['/idn/docs/event-triggers/testing-triggers'], + to: '/docs/extensibility/event-triggers/testing-triggers', + }, + { + from: ['/idn/docs/event-triggers/trigger-types'], + to: '/docs/extensibility/event-triggers/trigger-types', + }, + { + from: ['/idn/docs/event-triggers/triggers/access-request-decision'], + to: '/docs/extensibility/event-triggers/triggers/access-request-decision', + }, + { + from: [ + '/idn/docs/event-triggers/triggers/access-request-dynamic-approval', + ], + to: '/docs/extensibility/event-triggers/triggers/access-request-dynamic-approval', + }, + { + from: ['/idn/docs/event-triggers/triggers/access-request-submitted'], + to: '/docs/extensibility/event-triggers/triggers/access-request-submitted', + }, + { + from: [ + '/idn/docs/event-triggers/triggers/account-aggregation-completed', + ], + to: '/docs/extensibility/event-triggers/triggers/account-aggregation-completed', + }, + { + from: ['/idn/docs/event-triggers/triggers/campaign-activated'], + to: '/docs/extensibility/event-triggers/triggers/campaign-activated', + }, + { + from: ['/idn/docs/event-triggers/triggers/campaign-ended'], + to: '/docs/extensibility/event-triggers/triggers/campaign-ended', + }, + { + from: ['/idn/docs/event-triggers/triggers/campaign-generated'], + to: '/docs/extensibility/event-triggers/triggers/campaign-generated', + }, + { + from: ['/idn/docs/event-triggers/triggers/certification-signed-off'], + to: '/docs/extensibility/event-triggers/triggers/certification-signed-off', + }, + { + from: ['/idn/docs/event-triggers/triggers/form-submitted'], + to: '/docs/extensibility/event-triggers/triggers/form-submitted', + }, + { + from: [ + '/idn/docs/event-triggers/triggers/identity-attribute-changed', + ], + to: '/docs/extensibility/event-triggers/triggers/identity-attribute-changed', + }, + { + from: ['/idn/docs/event-triggers/triggers/identity-created'], + to: '/docs/extensibility/event-triggers/triggers/identity-created', + }, + { + from: ['/idn/docs/event-triggers/triggers/identity-deleted'], + to: '/docs/extensibility/event-triggers/triggers/identity-deleted', + }, + { + from: [ + '/idn/docs/event-triggers/triggers/native-change-account-created', + ], + to: '/docs/extensibility/event-triggers/triggers/native-change-account-created', + }, + { + from: [ + '/idn/docs/event-triggers/triggers/native-change-account-deleted', + ], + to: '/docs/extensibility/event-triggers/triggers/native-change-account-deleted', + }, + { + from: [ + '/idn/docs/event-triggers/triggers/native-change-account-updated', + ], + to: '/docs/extensibility/event-triggers/triggers/native-change-account-updated', + }, + { + from: ['/idn/docs/event-triggers/triggers/outlier-detected'], + to: '/docs/extensibility/event-triggers/triggers/outlier-detected', + }, + { + from: ['/idn/docs/event-triggers/triggers/provisioning-completed'], + to: '/docs/extensibility/event-triggers/triggers/provisioning-completed', + }, + { + from: ['/idn/docs/event-triggers/triggers/scheduled-search'], + to: '/docs/extensibility/event-triggers/triggers/scheduled-search', + }, + { + from: ['/idn/docs/event-triggers/triggers/source-account-created'], + to: '/docs/extensibility/event-triggers/triggers/source-account-created', + }, + { + from: ['/idn/docs/event-triggers/triggers/source-account-deleted'], + to: '/docs/extensibility/event-triggers/triggers/source-account-deleted', + }, + { + from: ['/idn/docs/event-triggers/triggers/source-account-updated'], + to: '/docs/extensibility/event-triggers/triggers/source-account-updated', + }, + { + from: ['/idn/docs/event-triggers/triggers/source-created'], + to: '/docs/extensibility/event-triggers/triggers/source-created', + }, + { + from: ['/idn/docs/event-triggers/triggers/source-deleted'], + to: '/docs/extensibility/event-triggers/triggers/source-deleted', + }, + { + from: ['/idn/docs/event-triggers/triggers/source-updated'], + to: '/docs/extensibility/event-triggers/triggers/source-updated', + }, + { + from: ['/idn/docs/event-triggers/triggers/va-cluster-status-change'], + to: '/docs/extensibility/event-triggers/triggers/va-cluster-status-change', + }, + { + from: ['/idn/docs/rules'], + to: '/docs/extensibility/rules', + }, + { + from: ['/idn/docs/rules/cloud-rules'], + to: '/docs/extensibility/rules/cloud-rules', + }, + { + from: [ + '/idn/docs/rules/cloud-rules/account-profile-attribute-generator', + ], + to: '/docs/extensibility/rules/cloud-rules/account-profile-attribute-generator', + }, + { + from: [ + '/idn/docs/rules/cloud-rules/account-profile-attribute-generator-template', + ], + to: '/docs/extensibility/rules/cloud-rules/account-profile-attribute-generator-template', + }, + { + from: ['/idn/docs/rules/cloud-rules/before-provisioning-rule'], + to: '/docs/extensibility/rules/cloud-rules/before-provisioning-rule', + }, + { + from: ['/idn/docs/rules/cloud-rules/buildmap-rule'], + to: '/docs/extensibility/rules/cloud-rules/buildmap-rule', + }, + { + from: ['/idn/docs/rules/cloud-rules/correlation-rule'], + to: '/docs/extensibility/rules/cloud-rules/correlation-rule', + }, + { + from: ['/idn/docs/rules/cloud-rules/generic-rule'], + to: '/docs/extensibility/rules/cloud-rules/generic-rule', + }, + { + from: ['/idn/docs/rules/cloud-rules/identity-attribute-rule'], + to: '/docs/extensibility/rules/cloud-rules/identity-attribute-rule', + }, + { + from: ['/idn/docs/rules/cloud-rules/manager-correlation-rule'], + to: '/docs/extensibility/rules/cloud-rules/manager-correlation-rule', + }, + { + from: ['/idn/docs/rules/connector-rules'], + to: '/docs/extensibility/rules/connector-rules', + }, + { + from: [ + '/idn/docs/rules/connector-rules/before-and-after-rule-operations', + ], + to: '/docs/extensibility/rules/connector-rules/before-and-after-rule-operations', + }, + { + from: ['/idn/docs/rules/connector-rules/jdbc-buildmap-rule'], + to: '/docs/extensibility/rules/connector-rules/jdbc-buildmap-rule', + }, + { + from: ['/idn/docs/rules/connector-rules/jdbc-provisioning-rule'], + to: '/docs/extensibility/rules/connector-rules/jdbc-provisioning-rule', + }, + { + from: ['/idn/docs/rules/connector-rules/sap-buildmap-rule'], + to: '/docs/extensibility/rules/connector-rules/sap-buildmap-rule', + }, + { + from: [ + '/idn/docs/rules/connector-rules/sap-provisioning-modify-rule', + ], + to: '/docs/extensibility/rules/connector-rules/sap-provisioning-modify-rule', + }, + { + from: [ + '/idn/docs/rules/connector-rules/webservices-after-provisioning-rule', + ], + to: '/docs/extensibility/rules/connector-rules/webservices-after-provisioning-rule', + }, + { + from: [ + '/idn/docs/rules/connector-rules/webservices-before-provisioning-rule', + ], + to: '/docs/extensibility/rules/connector-rules/webservices-before-provisioning-rule', + }, + { + from: ['/idn/docs/rules/guides'], + to: '/docs/extensibility/rules/guides', + }, + { + from: ['/idn/docs/rules/guides/your-first-rule'], + to: '/docs/extensibility/rules/guides/your-first-rule', + }, + { + from: ['/idn/docs/rules/java-docs'], + to: '/docs/extensibility/rules/java-docs', + }, + { + from: ['/idn/docs/rules/rule-utility'], + to: '/docs/extensibility/rules/rule-utility', + }, + { + from: ['/idn/docs/transforms'], + to: '/docs/extensibility/transforms', + }, + { + from: ['/idn/docs/transforms/guides'], + to: '/docs/extensibility/transforms/guides', + }, + { + from: ['/idn/docs/transforms/guides/identity-context-examples'], + to: '/docs/extensibility/transforms/guides/identity-context-examples', + }, + { + from: ['/idn/docs/transforms/guides/lifecycle-state-transform'], + to: '/docs/extensibility/transforms/guides/lifecycle-state-transform', + }, + { + from: ['/idn/docs/transforms/guides/temporary-password'], + to: '/docs/extensibility/transforms/guides/temporary-password', + }, + { + from: [ + '/idn/docs/transforms/guides/transforms-in-provisioning-policies', + ], + to: '/docs/extensibility/transforms/guides/transforms-in-provisioning-policies', + }, + { + from: ['/idn/docs/transforms/guides/your-first-transform'], + to: '/docs/extensibility/transforms/guides/your-first-transform', + }, + { + from: ['/idn/docs/transforms/operations'], + to: '/docs/extensibility/transforms/operations', + }, + { + from: ['/idn/docs/transforms/operations/account-attribute'], + to: '/docs/extensibility/transforms/operations/account-attribute', + }, + { + from: ['/idn/docs/transforms/operations/base64-decode'], + to: '/docs/extensibility/transforms/operations/base64-decode', + }, + { + from: ['/idn/docs/transforms/operations/base64-encode'], + to: '/docs/extensibility/transforms/operations/base64-encode', + }, + { + from: ['/idn/docs/transforms/operations/concatenation'], + to: '/docs/extensibility/transforms/operations/concatenation', + }, + { + from: ['/idn/docs/transforms/operations/conditional'], + to: '/docs/extensibility/transforms/operations/conditional', + }, + { + from: ['/idn/docs/transforms/operations/date-compare'], + to: '/docs/extensibility/transforms/operations/date-compare', + }, + { + from: ['/idn/docs/transforms/operations/date-format'], + to: '/docs/extensibility/transforms/operations/date-format', + }, + { + from: ['/idn/docs/transforms/operations/date-math'], + to: '/docs/extensibility/transforms/operations/date-math', + }, + { + from: ['/idn/docs/transforms/operations/decompose-diacritical-marks'], + to: '/docs/extensibility/transforms/operations/decompose-diacritical-marks', + }, + { + from: ['/idn/docs/transforms/operations/e164-phone'], + to: '/docs/extensibility/transforms/operations/e164-phone', + }, + { + from: ['/idn/docs/transforms/operations/first-valid'], + to: '/docs/extensibility/transforms/operations/first-valid', + }, + { + from: ['/idn/docs/transforms/operations/generate-random-string'], + to: '/docs/extensibility/transforms/operations/generate-random-string', + }, + { + from: ['/idn/docs/transforms/operations/get-end-of-string'], + to: '/docs/extensibility/transforms/operations/get-end-of-string', + }, + { + from: [ + '/idn/docs/transforms/operations/get-reference-identity-attribute', + ], + to: '/docs/extensibility/transforms/operations/get-reference-identity-attribute', + }, + { + from: ['/idn/docs/transforms/operations/identity-attribute'], + to: '/docs/extensibility/transforms/operations/identity-attribute', + }, + { + from: ['/idn/docs/transforms/operations/index-of'], + to: '/docs/extensibility/transforms/operations/index-of', + }, + { + from: ['/idn/docs/transforms/operations/iso-3166'], + to: '/docs/extensibility/transforms/operations/iso-3166', + }, + { + from: ['/idn/docs/transforms/operations/last-index-of'], + to: '/docs/extensibility/transforms/operations/last-index-of', + }, + { + from: ['/idn/docs/transforms/operations/left-pad'], + to: '/docs/extensibility/transforms/operations/left-pad', + }, + { + from: ['/idn/docs/transforms/operations/lookup'], + to: '/docs/extensibility/transforms/operations/lookup', + }, + { + from: ['/idn/docs/transforms/operations/lower'], + to: '/docs/extensibility/transforms/operations/lower', + }, + { + from: ['/idn/docs/transforms/operations/name-normalizer'], + to: '/docs/extensibility/transforms/operations/name-normalizer', + }, + { + from: ['/idn/docs/transforms/operations/random-alphanumeric'], + to: '/docs/extensibility/transforms/operations/random-alphanumeric', + }, + { + from: ['/idn/docs/transforms/operations/random-numeric'], + to: '/docs/extensibility/transforms/operations/random-numeric', + }, + { + from: ['/idn/docs/transforms/operations/reference'], + to: '/docs/extensibility/transforms/operations/reference', + }, + { + from: ['/idn/docs/transforms/operations/replace'], + to: '/docs/extensibility/transforms/operations/replace', + }, + { + from: ['/idn/docs/transforms/operations/replace-all'], + to: '/docs/extensibility/transforms/operations/replace-all', + }, + { + from: ['/idn/docs/transforms/operations/right-pad'], + to: '/docs/extensibility/transforms/operations/right-pad', + }, + { + from: ['/idn/docs/transforms/operations/rule'], + to: '/docs/extensibility/transforms/operations/rule', + }, + { + from: ['/idn/docs/transforms/operations/split'], + to: '/docs/extensibility/transforms/operations/split', + }, + { + from: ['/idn/docs/transforms/operations/static'], + to: '/docs/extensibility/transforms/operations/static', + }, + { + from: ['/idn/docs/transforms/operations/substring'], + to: '/docs/extensibility/transforms/operations/substring', + }, + { + from: ['/idn/docs/transforms/operations/trim'], + to: '/docs/extensibility/transforms/operations/trim', + }, + { + from: ['/idn/docs/transforms/operations/upper'], + to: '/docs/extensibility/transforms/operations/upper', + }, + { + from: ['/idn/docs/transforms/operations/username-generator'], + to: '/docs/extensibility/transforms/operations/username-generator', + }, + { + from: ['/idn/docs/transforms/operations/uuid-generator'], + to: '/docs/extensibility/transforms/operations/uuid-generator', + }, + { + from: ['/idn/docs/access-intelligence-center'], + to: '/docs/reporting/access-intelligence-center', + }, + { + from: ['/idn/docs/aic-audit-er-diagram'], + to: '/docs/reporting/aic-audit-er-diagram', + }, + { + from: ['/idn/docs/aic-er-diagram'], + to: '/docs/reporting/aic-er-diagram', + }, + { + from: ['/idn/docs/aic-videos'], + to: '/docs/reporting/aic-videos', + }, + { + from: ['/idn/docs/saas-connectivity'], + to: '/docs/connectivity/saas-connectivity', + }, + { + from: ['/idn/docs/saas-connectivity/commands/account-create'], + to: '/docs/connectivity/saas-connectivity/commands/account-create', + }, + { + from: ['/idn/docs/saas-connectivity/commands/account-delete'], + to: '/docs/connectivity/saas-connectivity/commands/account-delete', + }, + { + from: ['/idn/docs/saas-connectivity/commands/account-disable'], + to: '/docs/connectivity/saas-connectivity/commands/account-disable', + }, + { + from: ['/idn/docs/saas-connectivity/commands/account-discover'], + to: '/docs/connectivity/saas-connectivity/commands/account-discover', + }, + { + from: ['/idn/docs/saas-connectivity/commands/account-enable'], + to: '/docs/connectivity/saas-connectivity/commands/account-enable', + }, + { + from: ['/idn/docs/saas-connectivity/commands/account-list'], + to: '/docs/connectivity/saas-connectivity/commands/account-list', + }, + { + from: ['/idn/docs/saas-connectivity/commands/account-read'], + to: '/docs/connectivity/saas-connectivity/commands/account-read', + }, + { + from: ['/idn/docs/saas-connectivity/commands/account-unlock'], + to: '/docs/connectivity/saas-connectivity/commands/account-unlock', + }, + { + from: ['/idn/docs/saas-connectivity/commands/account-update'], + to: '/docs/connectivity/saas-connectivity/commands/account-update', + }, + { + from: ['/idn/docs/saas-connectivity/commands/change-password'], + to: '/docs/connectivity/saas-connectivity/commands/change-password', + }, + { + from: ['/idn/docs/saas-connectivity/commands/entitlement-list'], + to: '/docs/connectivity/saas-connectivity/commands/entitlement-list', + }, + { + from: ['/idn/docs/saas-connectivity/commands/entitlement-read'], + to: '/docs/connectivity/saas-connectivity/commands/entitlement-read', + }, + { + from: ['/idn/docs/saas-connectivity/commands/source-data-discover'], + to: '/docs/connectivity/saas-connectivity/commands/source-data-discover', + }, + { + from: ['/idn/docs/saas-connectivity/commands/source-data-read'], + to: '/docs/connectivity/saas-connectivity/commands/source-data-read', + }, + { + from: ['/idn/docs/saas-connectivity/commands/test-connection'], + to: '/docs/connectivity/saas-connectivity/commands/test-connection', + }, + { + from: ['/idn/docs/saas-connectivity/common-cli-commands'], + to: '/docs/connectivity/saas-connectivity/common-cli-commands', + }, + { + from: ['/idn/docs/saas-connectivity/connector-commands'], + to: '/docs/connectivity/saas-connectivity/connector-commands', + }, + { + from: ['/idn/docs/saas-connectivity/connector-spec'], + to: '/docs/connectivity/saas-connectivity/connector-spec', + }, + { + from: ['/idn/docs/saas-connectivity/connector-spec/card'], + to: '/docs/connectivity/saas-connectivity/connector-spec/card', + }, + { + from: ['/idn/docs/saas-connectivity/connector-spec/initial-value'], + to: '/docs/connectivity/saas-connectivity/connector-spec/initial-value', + }, + { + from: ['/idn/docs/saas-connectivity/connector-spec/key-value'], + to: '/docs/connectivity/saas-connectivity/connector-spec/key-value', + }, + { + from: ['/idn/docs/saas-connectivity/connector-spec/list'], + to: '/docs/connectivity/saas-connectivity/connector-spec/list', + }, + { + from: ['/idn/docs/saas-connectivity/connector-spec/radio'], + to: '/docs/connectivity/saas-connectivity/connector-spec/radio', + }, + { + from: ['/idn/docs/saas-connectivity/connector-spec/select'], + to: '/docs/connectivity/saas-connectivity/connector-spec/select', + }, + { + from: ['/idn/docs/saas-connectivity/customizers'], + to: '/docs/connectivity/saas-connectivity/customizers', + }, + { + from: ['/idn/docs/saas-connectivity/customizers/commands'], + to: '/docs/connectivity/saas-connectivity/customizers/commands', + }, + { + from: [ + '/idn/docs/saas-connectivity/customizers/commands/account-create', + ], + to: '/docs/connectivity/saas-connectivity/customizers/commands/account-create', + }, + { + from: [ + '/idn/docs/saas-connectivity/customizers/commands/account-delete', + ], + to: '/docs/connectivity/saas-connectivity/customizers/commands/account-delete', + }, + { + from: [ + '/idn/docs/saas-connectivity/customizers/commands/account-disable', + ], + to: '/docs/connectivity/saas-connectivity/customizers/commands/account-disable', + }, + { + from: [ + '/idn/docs/saas-connectivity/customizers/commands/account-enable', + ], + to: '/docs/connectivity/saas-connectivity/customizers/commands/account-enable', + }, + { + from: [ + '/idn/docs/saas-connectivity/customizers/commands/account-list', + ], + to: '/docs/connectivity/saas-connectivity/customizers/commands/account-list', + }, + { + from: [ + '/idn/docs/saas-connectivity/customizers/commands/account-read', + ], + to: '/docs/connectivity/saas-connectivity/customizers/commands/account-read', + }, + { + from: [ + '/idn/docs/saas-connectivity/customizers/commands/account-unlock', + ], + to: '/docs/connectivity/saas-connectivity/customizers/commands/account-unlock', + }, + { + from: [ + '/idn/docs/saas-connectivity/customizers/commands/account-update', + ], + to: '/docs/connectivity/saas-connectivity/customizers/commands/account-update', + }, + { + from: [ + '/idn/docs/saas-connectivity/customizers/commands/change-password', + ], + to: '/docs/connectivity/saas-connectivity/customizers/commands/change-password', + }, + { + from: [ + '/idn/docs/saas-connectivity/customizers/commands/entitlement-list', + ], + to: '/docs/connectivity/saas-connectivity/customizers/commands/entitlement-list', + }, + { + from: [ + '/idn/docs/saas-connectivity/customizers/commands/entitlement-read', + ], + to: '/docs/connectivity/saas-connectivity/customizers/commands/entitlement-read', + }, + { + from: [ + '/idn/docs/saas-connectivity/customizers/commands/source-data-discover', + ], + to: '/docs/connectivity/saas-connectivity/customizers/commands/source-data-discover', + }, + { + from: [ + '/idn/docs/saas-connectivity/customizers/commands/source-data-read', + ], + to: '/docs/connectivity/saas-connectivity/customizers/commands/source-data-read', + }, + { + from: [ + '/idn/docs/saas-connectivity/customizers/commands/test-connection', + ], + to: '/docs/connectivity/saas-connectivity/customizers/commands/test-connection', + }, + { + from: ['/idn/docs/saas-connectivity/customizers/example'], + to: '/docs/connectivity/saas-connectivity/customizers/example', + }, + { + from: ['/idn/docs/saas-connectivity/customizers/getting-started'], + to: '/docs/connectivity/saas-connectivity/customizers/getting-started', + }, + { + from: ['/idn/docs/saas-connectivity/customizers/linking'], + to: '/docs/connectivity/saas-connectivity/customizers/linking', + }, + { + from: ['/idn/docs/saas-connectivity/customizers/testing'], + to: '/docs/connectivity/saas-connectivity/customizers/testing', + }, + { + from: ['/idn/docs/saas-connectivity/customizers/upload'], + to: '/docs/connectivity/saas-connectivity/customizers/upload', + }, + { + from: ['/idn/docs/saas-connectivity/example-connectors'], + to: '/docs/connectivity/saas-connectivity/example-connectors', + }, + { + from: ['/idn/docs/saas-connectivity/in-depth/api-calls'], + to: '/docs/connectivity/saas-connectivity/in-depth/api-calls', + }, + { + from: ['/idn/docs/saas-connectivity/in-depth/cli-advanced'], + to: '/docs/connectivity/saas-connectivity/in-depth/cli-advanced', + }, + { + from: ['/idn/docs/saas-connectivity/in-depth/connector-timeouts'], + to: '/docs/connectivity/saas-connectivity/in-depth/connector-timeouts', + }, + { + from: ['/idn/docs/saas-connectivity/in-depth/debugging'], + to: '/docs/connectivity/saas-connectivity/in-depth/debugging', + }, + { + from: ['/idn/docs/saas-connectivity/in-depth/error-handling'], + to: '/docs/connectivity/saas-connectivity/in-depth/error-handling', + }, + { + from: ['/idn/docs/saas-connectivity/in-depth/handling-rate-limits'], + to: '/docs/connectivity/saas-connectivity/in-depth/handling-rate-limits', + }, + { + from: ['/idn/docs/saas-connectivity/in-depth/linting'], + to: '/docs/connectivity/saas-connectivity/in-depth/linting', + }, + { + from: ['/idn/docs/saas-connectivity/in-depth/logging'], + to: '/docs/connectivity/saas-connectivity/in-depth/logging', + }, + { + from: ['/idn/docs/saas-connectivity/in-depth/testing'], + to: '/docs/connectivity/saas-connectivity/in-depth/testing', + }, + { + from: ['/idn/docs/saas-connectivity/limits'], + to: '/docs/connectivity/saas-connectivity/limits', + }, + { + from: ['/idn/docs/saas-connectivity/postman-collection'], + to: '/docs/connectivity/saas-connectivity/postman-collection', + }, + { + from: ['/idn/docs/saas-connectivity/prerequisites'], + to: '/docs/connectivity/saas-connectivity/prerequisites', + }, + { + from: ['/idn/docs/saas-connectivity/test-build-deploy'], + to: '/docs/connectivity/saas-connectivity/test-build-deploy', + }, + { + from: ['/idn/docs/saas-connectivity/videos'], + to: '/docs/connectivity/saas-connectivity/videos', + }, + { + from: ['/idn/docs/sds-audit-er-diagram'], + to: '/docs/reporting/sds-audit-er-diagram', + }, + { + from: ['/idn/docs/sds-er-diagram'], + to: '/docs/reporting/sds-er-diagram', + }, + { + from: ['/idn/docs/secure-data-share'], + to: '/docs/reporting/secure-data-share', + }, + { + from: ['/idn/docs/global-platform-resources/ip-address-allow-list'], + to: '/docs/guides/ip-address-allow-list', + }, + { + from: ['/idn/docs/disable-access-profile-requests'], + to: '/docs/guides/disable-access-profile-requests', + }, + { + from: ['/idn/api/service-accounts'], + to: '/docs/guides/service-accounts', + }, + { + from: ['/iiq/docs'], + to: '/docs/iiq', + }, + { + from: ['/iiq/docs/plugin-developer-guide'], + to: '/docs/iiq/plugin-developer-guide', + }, + { + from: ['/iiq/docs/plugin-developer-guide/overview'], + to: '/docs/iiq/plugin-developer-guide/overview', + }, + { + from: ['/iiq/docs/plugin-developer-guide/manifest'], + to: '/docs/iiq/plugin-developer-guide/manifest', + }, + { + from: ['/iiq/docs/plugin-developer-guide/build-file'], + to: '/docs/iiq/plugin-developer-guide/build-file', + }, + { + from: ['/iiq/docs/plugin-developer-guide/database-scripts'], + to: '/docs/iiq/plugin-developer-guide/database-scripts', + }, + { + from: ['/iiq/docs/plugin-developer-guide/ui-elements'], + to: '/docs/iiq/plugin-developer-guide/ui-elements', + }, + { + from: ['/iiq/docs/plugin-developer-guide/xml-artifacts'], + to: '/docs/iiq/plugin-developer-guide/xml-artifacts', + }, + { + from: [ + '/iiq/docs/plugin-developer-guide/java-classes-rest-resources', + ], + to: '/docs/iiq/plugin-developer-guide/java-classes-rest-resources', + }, + { + from: ['/iiq/docs/plugin-developer-guide/java-classes-executors'], + to: '/docs/iiq/plugin-developer-guide/java-classes-executors', + }, + { + from: ['/iiq/docs/plugin-developer-guide/installation'], + to: '/docs/iiq/plugin-developer-guide/installation', + }, + { + from: ['/iiq/docs/plugin-developer-guide/appendix-migration'], + to: '/docs/iiq/plugin-developer-guide/appendix-migration', + }, + { + from: ['/iiq/docs/plugin-developer-guide/updates'], + to: '/docs/iiq/plugin-developer-guide/updates', + }, + { + from: ['/iiq/api'], + to: '/docs/api/iiq', + }, + { + from: ['/iiq/api/identityiq-scim-rest-api'], + to: '/docs/api/iiq/identityiq-scim-rest-api', + }, + { + from: ['/iiq/api/accounts'], + to: '/docs/api/iiq/accounts', + }, + { + from: ['/iiq/api/alerts'], + to: '/docs/api/iiq/alerts', + }, + { + from: ['/iiq/api/applications'], + to: '/docs/api/iiq/applications', + }, + { + from: ['/iiq/api/check-policy-violations'], + to: '/docs/api/iiq/check-policy-violations', + }, + { + from: ['/iiq/api/checked-policy-violations'], + to: '/docs/api/iiq/checked-policy-violations', + }, + { + from: ['/iiq/api/create-account'], + to: '/docs/api/iiq/create-account', + }, + { + from: ['/iiq/api/create-alert'], + to: '/docs/api/iiq/create-alert', + }, + { + from: ['/iiq/api/create-user'], + to: '/docs/api/iiq/create-user', + }, + { + from: ['/iiq/api/delete-account'], + to: '/docs/api/iiq/delete-account', + }, + { + from: ['/iiq/api/delete-user'], + to: '/docs/api/iiq/delete-user', + }, + { + from: ['/iiq/api/entitlements'], + to: '/docs/api/iiq/entitlements', + }, + { + from: ['/iiq/api/get-account-by-id'], + to: '/docs/api/iiq/get-account-by-id', + }, + { + from: ['/iiq/api/get-accounts'], + to: '/docs/api/iiq/get-accounts', + }, + { + from: ['/iiq/api/get-alert-by-id'], + to: '/docs/api/iiq/get-alert-by-id', + }, + { + from: ['/iiq/api/get-alerts'], + to: '/docs/api/iiq/get-alerts', + }, + { + from: ['/iiq/api/get-application'], + to: '/docs/api/iiq/get-application', + }, + { + from: ['/iiq/api/get-applications'], + to: '/docs/api/iiq/get-applications', + }, + { + from: ['/iiq/api/get-entitlement-by-id'], + to: '/docs/api/iiq/get-entitlement-by-id', + }, + { + from: ['/iiq/api/get-entitlements'], + to: '/docs/api/iiq/get-entitlements', + }, + { + from: ['/iiq/api/get-launched-workflow-by-id'], + to: '/docs/api/iiq/get-launched-workflow-by-id', + }, + { + from: ['/iiq/api/get-object-config-by-id'], + to: '/docs/api/iiq/get-object-config-by-id', + }, + { + from: ['/iiq/api/get-object-configs'], + to: '/docs/api/iiq/get-object-configs', + }, + { + from: ['/iiq/api/get-policy-violation-by-id'], + to: '/docs/api/iiq/get-policy-violation-by-id', + }, + { + from: ['/iiq/api/get-policy-violations'], + to: '/docs/api/iiq/get-policy-violations', + }, + { + from: ['/iiq/api/get-resource-type-by-id'], + to: '/docs/api/iiq/get-resource-type-by-id', + }, + { + from: ['/iiq/api/get-resource-types'], + to: '/docs/api/iiq/get-resource-types', + }, + { + from: ['/iiq/api/get-role'], + to: '/docs/api/iiq/get-role', + }, + { + from: ['/iiq/api/get-roles'], + to: '/docs/api/iiq/get-roles', + }, + { + from: ['/iiq/api/get-schema-by-id'], + to: '/docs/api/iiq/get-schema-by-id', + }, + { + from: ['/iiq/api/get-schemas'], + to: '/docs/api/iiq/get-schemas', + }, + { + from: ['/iiq/api/get-task-result-by-id'], + to: '/docs/api/iiq/get-task-result-by-id', + }, + { + from: ['/iiq/api/get-user-by-id'], + to: '/docs/api/iiq/get-user-by-id', + }, + { + from: ['/iiq/api/get-users'], + to: '/docs/api/iiq/get-users', + }, + { + from: ['/iiq/api/get-workflow-by-id'], + to: '/docs/api/iiq/get-workflow-by-id', + }, + { + from: ['/iiq/api/launch-workflow'], + to: '/docs/api/iiq/launch-workflow', + }, + { + from: ['/iiq/api/launched-workflows'], + to: '/docs/api/iiq/launched-workflows', + }, + { + from: ['/iiq/api/launched-workflows-get'], + to: '/docs/api/iiq/launched-workflows-get', + }, + { + from: ['/iiq/api/object-config'], + to: '/docs/api/iiq/object-config', + }, + { + from: ['/iiq/api/policy-violations'], + to: '/docs/api/iiq/policy-violations', + }, + { + from: ['/iiq/api/resource-types'], + to: '/docs/api/iiq/resource-types', + }, + { + from: ['/iiq/api/roles'], + to: '/docs/api/iiq/roles', + }, + { + from: ['/iiq/api/schemas'], + to: '/docs/api/iiq/schemas', + }, + { + from: ['/iiq/api/service-provider-config'], + to: '/docs/api/iiq/service-provider-config', + }, + { + from: ['/iiq/api/service-provider-config-get'], + to: '/docs/api/iiq/service-provider-config-get', + }, + { + from: ['/iiq/api/task-results'], + to: '/docs/api/iiq/task-results', + }, + { + from: ['/iiq/api/task-results-get'], + to: '/docs/api/iiq/task-results-get', + }, + { + from: ['/iiq/api/update-account'], + to: '/docs/api/iiq/update-account', + }, + { + from: ['/iiq/api/update-user'], + to: '/docs/api/iiq/update-user', + }, + { + from: ['/iiq/api/users'], + to: '/docs/api/iiq/users', + }, + { + from: ['/iiq/api/workflows'], + to: '/docs/api/iiq/workflows', + }, + { + from: ['/iiq/api/workflows-get'], + to: '/docs/api/iiq/workflows-get', + }, + { + from: ['/nerm/api/nerm-api'], + to: '/docs/api/nerm/v1/nerm-api', + }, + { + from: ['/nerm/api'], + to: '/docs/api/nerm/v1', + }, + { + from: ['/nerm/api/authentication'], + to: '/docs/api/nerm/authentication', + }, + { + from: ['/nerm/api/create-approval-action'], + to: '/docs/api/nerm/v1/create-approval-action', + }, + { + from: ['/nerm/api/create-ask-security-question-action'], + to: '/docs/api/nerm/v1/create-ask-security-question-action', + }, + { + from: ['/nerm/api/create-auto-assign-action'], + to: '/docs/api/nerm/v1/create-auto-assign-action', + }, + { + from: ['/nerm/api/create-automated-workflow'], + to: '/docs/api/nerm/v1/create-automated-workflow', + }, + { + from: ['/nerm/api/create-batch-update-action'], + to: '/docs/api/nerm/v1/create-batch-update-action', + }, + { + from: ['/nerm/api/create-batch-workflow'], + to: '/docs/api/nerm/v1/create-batch-workflow', + }, + { + from: ['/nerm/api/create-close-session-action'], + to: '/docs/api/nerm/v1/create-close-session-action', + }, + { + from: ['/nerm/api/create-contributors-action'], + to: '/docs/api/nerm/v1/create-contributors-action', + }, + { + from: ['/nerm/api/create-create-profile-action'], + to: '/docs/api/nerm/v1/create-create-profile-action', + }, + { + from: ['/nerm/api/create-create-workflow'], + to: '/docs/api/nerm/v1/create-create-workflow', + }, + { + from: ['/nerm/api/create-duplicate-prevention-action'], + to: '/docs/api/nerm/v1/create-duplicate-prevention-action', + }, + { + from: ['/nerm/api/create-email-verification-action'], + to: '/docs/api/nerm/v1/create-email-verification-action', + }, + { + from: ['/nerm/api/create-form'], + to: '/docs/api/nerm/v1/create-form', + }, + { + from: ['/nerm/api/create-form-attribute'], + to: '/docs/api/nerm/v1/create-form-attribute', + }, + { + from: ['/nerm/api/create-fulfillment-action'], + to: '/docs/api/nerm/v1/create-fulfillment-action', + }, + { + from: ['/nerm/api/create-identity-proofing-action'], + to: '/docs/api/nerm/v1/create-identity-proofing-action', + }, + { + from: ['/nerm/api/create-invitation-action'], + to: '/docs/api/nerm/v1/create-invitation-action', + }, + { + from: ['/nerm/api/create-ldap-action'], + to: '/docs/api/nerm/v1/create-ldap-action', + }, + { + from: ['/nerm/api/create-login-workflow'], + to: '/docs/api/nerm/v1/create-login-workflow', + }, + { + from: ['/nerm/api/create-notification-action'], + to: '/docs/api/nerm/v1/create-notification-action', + }, + { + from: ['/nerm/api/create-password-reset-action'], + to: '/docs/api/nerm/v1/create-password-reset-action', + }, + { + from: ['/nerm/api/create-password-update-workflow'], + to: '/docs/api/nerm/v1/create-password-update-workflow', + }, + { + from: ['/nerm/api/create-permission'], + to: '/docs/api/nerm/v1/create-permission', + }, + { + from: ['/nerm/api/create-profile-check-action'], + to: '/docs/api/nerm/v1/create-profile-check-action', + }, + { + from: ['/nerm/api/create-profile-page'], + to: '/docs/api/nerm/v1/create-profile-page', + }, + { + from: ['/nerm/api/create-profile-select-action'], + to: '/docs/api/nerm/v1/create-profile-select-action', + }, + { + from: ['/nerm/api/create-profile-type-role'], + to: '/docs/api/nerm/v1/create-profile-type-role', + }, + { + from: ['/nerm/api/create-registration-workflow'], + to: '/docs/api/nerm/v1/create-registration-workflow', + }, + { + from: ['/nerm/api/create-request-action'], + to: '/docs/api/nerm/v1/create-request-action', + }, + { + from: ['/nerm/api/create-rest-api-action'], + to: '/docs/api/nerm/v1/create-rest-api-action', + }, + { + from: ['/nerm/api/create-review-action'], + to: '/docs/api/nerm/v1/create-review-action', + }, + { + from: ['/nerm/api/create-run-workflow-action'], + to: '/docs/api/nerm/v1/create-run-workflow-action', + }, + { + from: ['/nerm/api/create-set-attributes-action'], + to: '/docs/api/nerm/v1/create-set-attributes-action', + }, + { + from: ['/nerm/api/create-set-security-question-action'], + to: '/docs/api/nerm/v1/create-set-security-question-action', + }, + { + from: ['/nerm/api/create-soap-api-action'], + to: '/docs/api/nerm/v1/create-soap-api-action', + }, + { + from: ['/nerm/api/create-status-change-action'], + to: '/docs/api/nerm/v1/create-status-change-action', + }, + { + from: ['/nerm/api/create-synced-attribute'], + to: '/docs/api/nerm/v1/create-synced-attribute', + }, + { + from: ['/nerm/api/create-unassign-action'], + to: '/docs/api/nerm/v1/create-unassign-action', + }, + { + from: ['/nerm/api/create-update-profile-action'], + to: '/docs/api/nerm/v1/create-update-profile-action', + }, + { + from: ['/nerm/api/create-update-workflow'], + to: '/docs/api/nerm/v1/create-update-workflow', + }, + { + from: ['/nerm/api/create-user-profiles'], + to: '/docs/api/nerm/v1/create-user-profiles', + }, + { + from: ['/nerm/api/create-username-password-action'], + to: '/docs/api/nerm/v1/create-username-password-action', + }, + { + from: ['/nerm/api/create-workflow-page'], + to: '/docs/api/nerm/v1/create-workflow-page', + }, + { + from: ['/nerm/api/delete-attribute-option'], + to: '/docs/api/nerm/v1/delete-attribute-option', + }, + { + from: ['/nerm/api/delete-profile'], + to: '/docs/api/nerm/v1/delete-profile', + }, + { + from: ['/nerm/api/delete-profile-type'], + to: '/docs/api/nerm/v1/delete-profile-type', + }, + { + from: ['/nerm/api/delete-profiles'], + to: '/docs/api/nerm/v1/delete-profiles', + }, + { + from: ['/nerm/api/delete-role-profile'], + to: '/docs/api/nerm/v1/delete-role-profile', + }, + { + from: ['/nerm/api/delete-synced-attribute'], + to: '/docs/api/nerm/v1/delete-synced-attribute', + }, + { + from: ['/nerm/api/delete-user'], + to: '/docs/api/nerm/v1/delete-user', + }, + { + from: ['/nerm/api/delete-user-profile'], + to: '/docs/api/nerm/v1/delete-user-profile', + }, + { + from: ['/nerm/api/delete-user-profiles'], + to: '/docs/api/nerm/v1/delete-user-profiles', + }, + { + from: ['/nerm/api/delete-user-role'], + to: '/docs/api/nerm/v1/delete-user-role', + }, + { + from: ['/nerm/api/get-advanced-search'], + to: '/docs/api/nerm/v1/get-advanced-search', + }, + { + from: ['/nerm/api/get-attribute'], + to: '/docs/api/nerm/v1/get-attribute', + }, + { + from: ['/nerm/api/get-attribute-option'], + to: '/docs/api/nerm/v1/get-attribute-option', + }, + { + from: ['/nerm/api/get-attribute-options'], + to: '/docs/api/nerm/v1/get-attribute-options', + }, + { + from: ['/nerm/api/get-attributes'], + to: '/docs/api/nerm/v1/get-attributes', + }, + { + from: ['/nerm/api/get-identity-proofing-results'], + to: '/docs/api/nerm/v1/get-identity-proofing-results', + }, + { + from: ['/nerm/api/get-job-status'], + to: '/docs/api/nerm/v1/get-job-status', + }, + { + from: ['/nerm/api/get-profile'], + to: '/docs/api/nerm/v1/get-profile', + }, + { + from: ['/nerm/api/get-profile-avatar'], + to: '/docs/api/nerm/v1/get-profile-avatar', + }, + { + from: ['/nerm/api/get-profile-type'], + to: '/docs/api/nerm/v1/get-profile-type', + }, + { + from: ['/nerm/api/get-profile-type-attributes'], + to: '/docs/api/nerm/v1/get-profile-type-attributes', + }, + { + from: ['/nerm/api/get-profile-types'], + to: '/docs/api/nerm/v1/get-profile-types', + }, + { + from: ['/nerm/api/get-profile-upload'], + to: '/docs/api/nerm/v1/get-profile-upload', + }, + { + from: ['/nerm/api/get-profiles'], + to: '/docs/api/nerm/v1/get-profiles', + }, + { + from: ['/nerm/api/get-risk-level'], + to: '/docs/api/nerm/v1/get-risk-level', + }, + { + from: ['/nerm/api/get-risk-levels'], + to: '/docs/api/nerm/v1/get-risk-levels', + }, + { + from: ['/nerm/api/get-risk-score'], + to: '/docs/api/nerm/v1/get-risk-score', + }, + { + from: ['/nerm/api/get-risk-scores'], + to: '/docs/api/nerm/v1/get-risk-scores', + }, + { + from: ['/nerm/api/get-role'], + to: '/docs/api/nerm/v1/get-role', + }, + { + from: ['/nerm/api/get-role-profile'], + to: '/docs/api/nerm/v1/get-role-profile', + }, + { + from: ['/nerm/api/get-role-profiles'], + to: '/docs/api/nerm/v1/get-role-profiles', + }, + { + from: ['/nerm/api/get-roles'], + to: '/docs/api/nerm/v1/get-roles', + }, + { + from: ['/nerm/api/get-user'], + to: '/docs/api/nerm/v1/get-user', + }, + { + from: ['/nerm/api/get-user-avatar'], + to: '/docs/api/nerm/v1/get-user-avatar', + }, + { + from: ['/nerm/api/get-user-manager'], + to: '/docs/api/nerm/v1/get-user-manager', + }, + { + from: ['/nerm/api/get-user-managers'], + to: '/docs/api/nerm/v1/get-user-managers', + }, + { + from: ['/nerm/api/get-user-profile'], + to: '/docs/api/nerm/v1/get-user-profile', + }, + { + from: ['/nerm/api/get-user-profiles'], + to: '/docs/api/nerm/v1/get-user-profiles', + }, + { + from: ['/nerm/api/get-user-role'], + to: '/docs/api/nerm/v1/get-user-role', + }, + { + from: ['/nerm/api/get-user-roles'], + to: '/docs/api/nerm/v1/get-user-roles', + }, + { + from: ['/nerm/api/get-users'], + to: '/docs/api/nerm/v1/get-users', + }, + { + from: ['/nerm/api/get-workflow-actions'], + to: '/docs/api/nerm/v1/get-workflow-actions', + }, + { + from: ['/nerm/api/get-workflow-session'], + to: '/docs/api/nerm/v1/get-workflow-session', + }, + { + from: ['/nerm/api/get-workflow-session-upload'], + to: '/docs/api/nerm/v1/get-workflow-session-upload', + }, + { + from: ['/nerm/api/get-workflow-sessions'], + to: '/docs/api/nerm/v1/get-workflow-sessions', + }, + { + from: ['/nerm/api/getting-started'], + to: '/docs/api/nerm/getting-started', + }, + { + from: ['/nerm/api/pagination-metadata-filtering'], + to: '/docs/api/nerm/pagination-metadata-filtering', + }, + { + from: ['/nerm/api/patch-advanced-search'], + to: '/docs/api/nerm/v1/patch-advanced-search', + }, + { + from: ['/nerm/api/patch-attribute-option'], + to: '/docs/api/nerm/v1/patch-attribute-option', + }, + { + from: ['/nerm/api/patch-attribute-options'], + to: '/docs/api/nerm/v1/patch-attribute-options', + }, + { + from: ['/nerm/api/patch-profile'], + to: '/docs/api/nerm/v1/patch-profile', + }, + { + from: ['/nerm/api/patch-profile-type'], + to: '/docs/api/nerm/v1/patch-profile-type', + }, + { + from: ['/nerm/api/patch-profiles'], + to: '/docs/api/nerm/v1/patch-profiles', + }, + { + from: ['/nerm/api/patch-role'], + to: '/docs/api/nerm/v1/patch-role', + }, + { + from: ['/nerm/api/patch-role-profile'], + to: '/docs/api/nerm/v1/patch-role-profile', + }, + { + from: ['/nerm/api/patch-role-profiles'], + to: '/docs/api/nerm/v1/patch-role-profiles', + }, + { + from: ['/nerm/api/patch-roles'], + to: '/docs/api/nerm/v1/patch-roles', + }, + { + from: ['/nerm/api/patch-user'], + to: '/docs/api/nerm/v1/patch-user', + }, + { + from: ['/nerm/api/patch-user-manager'], + to: '/docs/api/nerm/v1/patch-user-manager', + }, + { + from: ['/nerm/api/patch-user-managers'], + to: '/docs/api/nerm/v1/patch-user-managers', + }, + { + from: ['/nerm/api/patch-user-profile'], + to: '/docs/api/nerm/v1/patch-user-profile', + }, + { + from: ['/nerm/api/patch-user-profiles'], + to: '/docs/api/nerm/v1/patch-user-profiles', + }, + { + from: ['/nerm/api/patch-user-role'], + to: '/docs/api/nerm/v1/patch-user-role', + }, + { + from: ['/nerm/api/patch-user-roles'], + to: '/docs/api/nerm/v1/patch-user-roles', + }, + { + from: ['/nerm/api/patch-users'], + to: '/docs/api/nerm/v1/patch-users', + }, + { + from: ['/nerm/api/patch-workflow-session'], + to: '/docs/api/nerm/v1/patch-workflow-session', + }, + { + from: ['/nerm/api/post-advanced-search'], + to: '/docs/api/nerm/v1/post-advanced-search', + }, + { + from: ['/nerm/api/post-attribute-option'], + to: '/docs/api/nerm/v1/post-attribute-option', + }, + { + from: ['/nerm/api/post-attribute-options'], + to: '/docs/api/nerm/v1/post-attribute-options', + }, + { + from: ['/nerm/api/post-profile'], + to: '/docs/api/nerm/v1/post-profile', + }, + { + from: ['/nerm/api/post-profile-avatar'], + to: '/docs/api/nerm/v1/post-profile-avatar', + }, + { + from: ['/nerm/api/post-profile-type'], + to: '/docs/api/nerm/v1/post-profile-type', + }, + { + from: ['/nerm/api/post-profile-upload'], + to: '/docs/api/nerm/v1/post-profile-upload', + }, + { + from: ['/nerm/api/post-profiles'], + to: '/docs/api/nerm/v1/post-profiles', + }, + { + from: ['/nerm/api/post-role'], + to: '/docs/api/nerm/v1/post-role', + }, + { + from: ['/nerm/api/post-role-profile'], + to: '/docs/api/nerm/v1/post-role-profile', + }, + { + from: ['/nerm/api/post-role-profiles'], + to: '/docs/api/nerm/v1/post-role-profiles', + }, + { + from: ['/nerm/api/post-roles'], + to: '/docs/api/nerm/v1/post-roles', + }, + { + from: ['/nerm/api/post-user'], + to: '/docs/api/nerm/v1/post-user', + }, + { + from: ['/nerm/api/post-user-avatar'], + to: '/docs/api/nerm/v1/post-user-avatar', + }, + { + from: ['/nerm/api/post-user-manager'], + to: '/docs/api/nerm/v1/post-user-manager', + }, + { + from: ['/nerm/api/post-user-managers'], + to: '/docs/api/nerm/v1/post-user-managers', + }, + { + from: ['/nerm/api/post-user-profile'], + to: '/docs/api/nerm/v1/post-user-profile', + }, + { + from: ['/nerm/api/post-user-role'], + to: '/docs/api/nerm/v1/post-user-role', + }, + { + from: ['/nerm/api/post-user-roles'], + to: '/docs/api/nerm/v1/post-user-roles', + }, + { + from: ['/nerm/api/post-users'], + to: '/docs/api/nerm/v1/post-users', + }, + { + from: ['/nerm/api/post-workflow-session'], + to: '/docs/api/nerm/v1/post-workflow-session', + }, + { + from: ['/nerm/api/post-workflow-session-upload'], + to: '/docs/api/nerm/v1/post-workflow-session-upload', + }, + { + from: ['/nerm/api/run-advanced-search'], + to: '/docs/api/nerm/v1/run-advanced-search', + }, + { + from: ['/nerm/api/run-advanced-searchby-id'], + to: '/docs/api/nerm/v1/run-advanced-searchby-id', + }, ], - }, - ], - [ - '@docusaurus/plugin-content-docs', - { - id: 'idn', - path: 'products/idn', - routeBasePath: 'idn', - editUrl: - 'https://github.com/sailpoint-oss/developer-community-site/edit/main/', - showLastUpdateAuthor: true, - showLastUpdateTime: true, - sidebarPath: require.resolve('./products/idn/sidebar.js'), - docItemComponent: '@theme/ApiItem', - }, - ], - [ - '@docusaurus/plugin-content-docs', - { - id: 'iiq', - path: 'products/iiq', - routeBasePath: 'iiq', - editUrl: - 'https://github.com/sailpoint-oss/developer-community-site/edit/main/', - showLastUpdateAuthor: true, - showLastUpdateTime: true, - sidebarPath: require.resolve('./products/iiq/sidebar.js'), - docItemComponent: '@theme/ApiItem', - }, - ], - [ - '@docusaurus/plugin-content-docs', - { - id: 'nerm', - path: 'products/nerm', - routeBasePath: 'nerm', - editUrl: - 'https://github.com/sailpoint-oss/developer-community-site/edit/main/', - showLastUpdateAuthor: true, - showLastUpdateTime: true, - sidebarPath: require.resolve('./products/nerm/sidebar.js'), - docItemComponent: '@theme/ApiItem', + createRedirects(existingPath) { + if (existingPath.startsWith('/docs')) { + return [existingPath.replace('/docs', '/idn')]; + } + return undefined; // Return a falsy value: no redirect created + }, }, ], [ @@ -96,7 +1620,7 @@ module.exports = [ config: { idn_v3: { specPath: 'static/api-specs/idn/sailpoint-api.v3.yaml', - outputDir: 'products/idn/api/v3', + outputDir: 'docs/api/v3', downloadUrl: 'https://raw.githubusercontent.com/sailpoint-oss/api-specs/main/dereferenced/deref-sailpoint-api.v3.yaml', sidebarOptions: { @@ -107,7 +1631,7 @@ module.exports = [ }, idn_beta: { specPath: 'static/api-specs/idn/sailpoint-api.beta.yaml', - outputDir: 'products/idn/api/beta', + outputDir: 'docs/api/beta', downloadUrl: 'https://raw.githubusercontent.com/sailpoint-oss/api-specs/main/dereferenced/deref-sailpoint-api.beta.yaml', sidebarOptions: { @@ -127,7 +1651,7 @@ module.exports = [ config: { iiq: { specPath: 'static/api-specs/iiq/sailpoint-api.iiq.yaml', - outputDir: 'products/iiq/api', + outputDir: 'docs/api/iiq', downloadUrl: 'https://raw.githubusercontent.com/sailpoint-oss/api-specs/main/iiq/sailpoint-api.iiq.yaml', sidebarOptions: { @@ -147,7 +1671,7 @@ module.exports = [ config: { nerm: { specPath: 'static/api-specs/nerm/openapi.yaml', - outputDir: 'products/nerm/api', + outputDir: 'docs/api/nerm/v1', downloadUrl: 'https://raw.githubusercontent.com/sailpoint-oss/api-specs/main/dereferenced/deref-sailpoint-api.nerm.yaml', sidebarOptions: { diff --git a/products/idn/docs/identity-now/global-platform-resources/index.md b/products/idn/docs/identity-now/global-platform-resources/index.md deleted file mode 100644 index cb9bda8fb..000000000 --- a/products/idn/docs/identity-now/global-platform-resources/index.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -id: global-platform-resources -title: Global Platform Resources -pagination_label: Global Platform Resources -sidebar_label: Global Platform Resources -sidebar_position: 1 -sidebar_class_name: globalResources -keywords: ['IdentityNow', 'resources', 'configuration'] -description: Our global platform resource documentation provides comprehensive insights applicable to multiple features or the entire platform, complementing our feature-specific resources. -slug: /docs/global-platform-resources -tags: ['Connectivity'] ---- - -Within other areas of our documentation, you will find resources that are tailored to specific features of our platform, providing in-depth information and guidance on each individual aspect. However, our Global Platform Resources section includes documents that are applicable to multiple features or sometimes the entire platform. These resources offer valuable insights that are relevant across different areas of the platform, ensuring you have a comprehensive understanding of our platform as a whole. - -```mdx-code-block -import DocCardList from '@theme/DocCardList'; -import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; - - -``` diff --git a/products/idn/docs/identity-now/index.mdx b/products/idn/docs/identity-now/index.mdx deleted file mode 100644 index 1f5b2e4c2..000000000 --- a/products/idn/docs/identity-now/index.mdx +++ /dev/null @@ -1,146 +0,0 @@ ---- -id: docs -title: IdentityNow -pagination_label: Introduction -sidebar_label: IdentityNow -sidebar_position: 1 -sidebar_class_name: IdentityNow -hide_title: true -keywords: - [ - 'IdentityNow', - 'development', - 'developer', - 'portal', - 'getting started', - 'docs', - 'documentation', - ] -description: This is the intoduction documentation to development on the IdentityNow platform. -slug: /docs -tags: ['Introduction', 'Getting Started'] ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -🧭 There are many different ways in which you are able to extend the IdentityNow platform beyond what comes out of the box. Please, explore our documentation and see what is possible! This documentation assumes that you are a current customer or partner and already have access to the IdentityNow application. - -:::info Are you a partner? - -Looking to become a partner? If you are interested in becoming a partner, be it an ISV or Channel/Implementation partner, [click here](https://www.sailpoint.com/partners/become-partner/). - -::: - -## Before You Get Started - -Please read this introduction carefully, as it contains recommendations and need-to-know information pertaining to all features of the IdentityNow platform. - -### Authentication - -Many of the interactions you have through our various features will have you interacting with our APIs either directly or indirectly. It would be valuable to familiarize yourself with [Authentication](../../api/authentication.md) on our platform. - -### Understanding JSON - -JSON (JavaScript Object Notation) is a lightweight data-interchange format. It is easy for humans to read and write. It is easy for machines to parse and generate. JSON is at the heart of every API and development feature that SailPoint offers in IdentityNow—usually either inputs or outputs to/from a system. [Learn more about JSON here](https://www.w3schools.com/js/js_json_intro.asp). - -### Understanding Webhooks - -A webhook in web development is a method of augmenting or altering the behavior of a web page or web application with custom callbacks. These callbacks may be maintained, modified, and managed by third-party users and developers who may not necessarily be affiliated with the originating website or application. Our [Event Triggers](docs/event-triggers) are a form of webhook, for example. [Learn more about webhooks here](https://zapier.com/blog/what-are-webhooks/). - -## Recommended Technologies - -While you can use whichever development tools you are most comfortable with or find most useful, we will recommend tools here for those that are new to development. - -:::tip - -Our team, when developing documentation, example code/applications, videos, etc. will almost always use one of the tools listed below. We will soon add programming languages to this list! - -::: - -### IDEs (Integrated Development Environments) - -IDEs are great for consolidating different aspects of programming into one tool. They're great for not only writing code, but managing your code as well. While you can use any IDE you feel is best fit for you and the task, here is what we use: - - - - -| IDE | Description | -| --- | --- | -| [VS Code](https://code.visualstudio.com/) | VS Code is a lightweight IDE that we believe is perfect for development on our IdentityNow platform. We also have great plug-in support from our community, like [this one](https://marketplace.visualstudio.com/items?itemName=yannick-beot-sp.vscode-sailpoint-identitynow)! | -| [IntelliJ](https://www.jetbrains.com/idea/) | If you happen to be writing in Java or developing Rules on our platform, we typically recommend IntelliJ. While Java development can be done in VS Code, you will have an easier time using an IDE that was purpose-built for Java. | - - - - -| IDE | Description | -| --- | --- | -| [VS Code](https://code.visualstudio.com/) | VS Code is a lightweight IDE that we believe is perfect for development on our IdentityNow platform. We also have great plug-in support from our community, like [this one](https://marketplace.visualstudio.com/items?itemName=yannick-beot-sp.vscode-sailpoint-identitynow)! | -| [IntelliJ](https://www.jetbrains.com/idea/) | If you happen to be writing in Java or developing Rules on our platform, we typically recommend IntelliJ. While Java development can be done in VS Code, you will have an easier time using an IDE that was purpose-built for Java. | - - - - -| IDE | Description | -| --- | --- | -| [VS Code](https://code.visualstudio.com/) | VS Code is a lightweight IDE that we believe is perfect for development on our IdentityNow platform. We also have great plug-in support from our community, like [this one](https://marketplace.visualstudio.com/items?itemName=yannick-beot-sp.vscode-sailpoint-identitynow)! | -| [IntelliJ](https://www.jetbrains.com/idea/) | If you happen to be writing in Java or developing Rules on our platform, we typically recommend IntelliJ. While Java development can be done in VS Code, you will have an easier time using an IDE that was purpose-built for Java. | - - - - ---- - -### CLI Environments - -When interacting with our platform or writing code related to IdentityNow, we often use the CLI. While you can use any CLI that you feel is best fit for you and your job, here are the CLI environments we use and recommend: - - - - -| CLI Tool | Description | -| --- | --- | -| Windows PowerShell | Windows PowerShell is a modern terminal on windows (also available on Mac/Linux) that offers versatile CLI, task automation, and configuration management options. | -| [Windows Terminal](https://apps.microsoft.com/store/detail/windows-terminal/9N0DX20HK701?hl=en-us&gl=us) | The Windows Terminal is a modern, fast, efficient, powerful, and productive terminal application for users of command-line tools and shells like Command Prompt, PowerShell, and WSL. Its main features include multiple tabs, panes, Unicode and UTF-8 character support, a GPU accelerated text rendering engine, and custom themes, styles, and configurations. Terminal is just a more beautiful version of PowerShell 😁 | - - - - -| CLI Tool | Description | -| ---------------------- | ------------------------------------------------ | -| Mac Terminal (default) | On Mac, we recommend using the default terminal. | - - - - -| CLI Tool | Description | -| --- | --- | -| Linux Terminal (default) | On Linux, we recommend using the default terminal. | - - - - ---- - -### Version Control - -Writing code typically requires version control to adequately track changes in sets of files. While you can use any version control that you feel is best fit for you and your job, here are the version control tools that we use and recommend: - -| Version Control Tool | Description | -| --- | --- | -| [git](https://git-scm.com/) | Git is a free and open-source, distributed version control system designed to handle everything from small to very large projects. Git runs locally on your machine. | -| [GitHub](https://github.com) | GitHub is an internet hosting service for managing git in the cloud. We use GitHub on our team to collaborate amongst the other developers on our team, as well as with our community. | - ---- - -### API Clients - -API clients make it easy to call APIs without having to first write code. API clients are great for testing and getting familiar with APIs to get a better understanding of what the inputs/outputs are and how they work. - -| API Client | Description | -| --- | --- | -| [Postman](https://www.postman.com/downloads/) | Postman is an API platform for building and using APIs. Postman simplifies each step of the API lifecycle and streamlines collaboration so you can create better APIs—faster. | - -## Glossary - -Identity is a complex topic and there are many terms used, and quite often! Please [refer to our glossary](https://documentation.sailpoint.com/saas/help/common/glossary.html) whenever possible if you aren't sure what something means. diff --git a/products/idn/sidebar.js b/products/idn/sidebar.js deleted file mode 100644 index 18ec130a6..000000000 --- a/products/idn/sidebar.js +++ /dev/null @@ -1,88 +0,0 @@ -const sidebars = { - openApiSidebar: [ - { - type: 'category', - label: 'IdentityNow', - collapsible: false, - items: [ - { - type: 'doc', - id: 'api/getting-started', - }, - { - type: 'doc', - id: 'api/authentication', - }, - { - type: 'doc', - id: 'api/authorization', - }, - { - type: 'doc', - id: 'api/service-accounts', - }, - { - type: 'doc', - id: 'api/standard-collection-parameters', - }, - { - type: 'doc', - id: 'api/rate-limit', - }, - { - type: 'doc', - id: 'api/postman-collections', - }, - { - type: 'doc', - id: 'api/patch-requests' - }, - { - type: 'category', - label: 'V3 APIs', - link: { - type: 'generated-index', - title: 'V3 APIs', - 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.', - slug: '/api/v3', - }, - // @ts-ignore - items: require('./api/v3/sidebar.js'), - }, - { - type: 'category', - label: 'Beta APIs', - link: { - type: 'generated-index', - title: 'Beta APIs', - description: - 'Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.', - slug: '/api/beta', - }, - // @ts-ignore - items: require('./api/beta/sidebar.js'), - }, - ], - }, - ], - idnDocs: [ - { - type: 'autogenerated', - dirName: 'docs', - }, - ], - sdkSidebar: [ - { - type: 'category', - label: 'Tools', - items: [ - { - type: 'autogenerated', - dirName: 'tools', - } - ] - }, - ], -}; -module.exports = sidebars; diff --git a/products/idn/tools/cli/_category_.json b/products/idn/tools/cli/_category_.json deleted file mode 100644 index 9e90632aa..000000000 --- a/products/idn/tools/cli/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "collapsible": false -} \ No newline at end of file diff --git a/products/idn/tools/sdk/_category_.json b/products/idn/tools/sdk/_category_.json deleted file mode 100644 index 9e90632aa..000000000 --- a/products/idn/tools/sdk/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "collapsible": false -} \ No newline at end of file diff --git a/products/idn/tools/sdk/index.md b/products/idn/tools/sdk/index.md deleted file mode 100644 index 72a0ceeea..000000000 --- a/products/idn/tools/sdk/index.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -id: sdk -title: SDKs -pagination_label: SDKs -sidebar_label: SDKs -sidebar_position: 2 -sidebar_class_name: sdk -keywords: ['sdk'] -description: A SailPoint SDK makes it easy to access the SailPoint API and extend your IDN platform. -slug: /tools/sdk -tags: ['SDK'] ---- - -## SDKs - -A SailPoint software development kit (SDK) makes it easy to access the SailPoint APIs and extend your IDN platform. - -In addition to the APIs, each SDK includes SaaS connector, IDN search, and transform functionality. Each SDK also includes prebuilt examples you can use to learn how to get started. - -Try one of these SDKs to get started: -- [Go SDK](./go/index.mdx) -- [Powershell SDK](./powershell/index.mdx) -- [TypeScript SDK](./typescript/index.mdx) \ No newline at end of file diff --git a/products/iiq/docs/identity-iq/_category_.json b/products/iiq/docs/identity-iq/_category_.json deleted file mode 100644 index 9e90632aa..000000000 --- a/products/iiq/docs/identity-iq/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "collapsible": false -} \ No newline at end of file diff --git a/products/iiq/docs/identity-iq/index.mdx b/products/iiq/docs/identity-iq/index.mdx deleted file mode 100644 index ea5000dab..000000000 --- a/products/iiq/docs/identity-iq/index.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: docs -title: IdentityIQ -pagination_label: Introduction -sidebar_label: IdentityIQ -sidebar_position: 1 -sidebar_class_name: IdentityIQ -hide_title: true -keywords: - [ - 'IdentityIQ', - 'development', - 'developer', - 'portal', - 'getting started', - 'docs', - 'documentation', - ] -description: This is the intoduction documentation to development on the IdentityIQ platform. -slug: /docs -tags: ['Introduction', 'Getting Started'] ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -🧭 There are many different ways to extend the IdentityIQ platform beyond what comes out of the box. Explore our documentation and see what is possible! This documentation assumes that you are a current customer or partner and already have access to the IdentityIQ application. - -:::info Are you a partner? - -Looking to become a partner? If you are interested in becoming a partner, be it an ISV or Channel/Implementation partner, [click here](https://www.sailpoint.com/partners/become-partner/). - -::: - -## Glossary - -Identity is a complex topic, and there are many terms used, and they're used quite often! Please [refer to this glossary](https://documentation.sailpoint.com/saas/help/common/glossary.html) whenever possible if you aren't sure what something means. diff --git a/products/iiq/sidebar.js b/products/iiq/sidebar.js deleted file mode 100644 index 4d0d163a9..000000000 --- a/products/iiq/sidebar.js +++ /dev/null @@ -1,25 +0,0 @@ -const sidebars = { - iiqOpenApiSidebar: [ - { - type: 'category', - label: 'IdentityIQ API', - link: { - type: 'generated-index', - title: 'IdentityIQ API', - description: - "These are the SCIM APIs for SailPoint's on-premise service, IdentityIQ. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.", - slug: '/api', - }, - // @ts-ignore - items: require('./api/sidebar.js'), - }, - ], - idnDocs: [ - { - type: 'autogenerated', - dirName: 'docs', - }, - ] -}; - -module.exports = sidebars; diff --git a/products/nerm/sidebar.js b/products/nerm/sidebar.js deleted file mode 100644 index 9dc9e2b94..000000000 --- a/products/nerm/sidebar.js +++ /dev/null @@ -1,38 +0,0 @@ -const sidebars = { - nermOpenApiSidebar: [ - { - type: 'category', - label: 'NERM', - collapsible: false, - items: [ - { - type: 'doc', - id: 'api/getting-started' - }, - { - type: 'doc', - id: 'api/authentication' - }, - { - type: 'doc', - id: 'api/pagination-metadata-filtering' - }, - { - type: 'category', - label: 'NERM v1 API', - link: { - type: 'generated-index', - title: 'NERM v1 API', - description: - "These are the Non-employee Risk Management APIs for SailPoint. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.", - slug: '/api', - }, - // @ts-ignore - items: require('./api/sidebar.js'), - } - ] - } - ], - }; - - module.exports = sidebars; \ No newline at end of file diff --git a/sidebars.js b/sidebars.js index f053ebf79..e051b50ac 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1 +1,264 @@ -module.exports = {}; +const sidebars = { + openApiSidebar: [ + { + type: 'category', + label: 'Documentation', + collapsible: false, + link: { + type: 'doc', + id: 'docs', + }, + items: [ + { + type: 'category', + label: 'API Specifications', + collapsible: true, + link: { + type: 'doc', + id: 'api/api-specifications', + }, + items: [ + { + type: 'category', + label: 'Identity Security Cloud', + collapsible: true, + link: { + type: 'doc', + id: 'api/identity-security-cloud', + }, + customProps: { + description: "ISC API specifications." + }, + items: [ + { + type: 'doc', + id: 'api/getting-started', + }, + { + type: 'doc', + id: 'api/authentication', + }, + { + type: 'doc', + id: 'api/authorization', + }, + { + type: 'doc', + id: 'api/standard-collection-parameters', + }, + { + type: 'doc', + id: 'api/rate-limit', + }, + { + type: 'doc', + id: 'api/postman-collections', + }, + { + type: 'doc', + id: 'api/patch-requests', + }, + { + type: 'category', + label: 'V3 APIs', + link: { + type: 'generated-index', + title: 'V3 APIs', + 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.', + slug: '/api/v3', + }, + // @ts-ignore + items: require('./docs/api/v3/sidebar.js'), + }, + { + type: 'category', + label: 'Beta APIs', + link: { + type: 'generated-index', + title: 'Beta APIs', + description: + 'Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.', + slug: '/api/beta', + }, + // @ts-ignore + items: require('./docs/api/beta/sidebar.js'), + }, + ], + }, + { + type: 'category', + label: 'NERM', + collapsible: true, + link: { + type: 'doc', + id: 'api/non-employee', + }, + customProps: { + description: "NERM API specifications." + }, + items: [ + { + type: 'doc', + id: 'api/nerm/getting-started', + }, + { + type: 'doc', + id: 'api/nerm/authentication', + }, + { + type: 'doc', + id: 'api/nerm/pagination-metadata-filtering', + }, + { + type: 'category', + label: 'NERM v1 API', + link: { + type: 'generated-index', + title: 'NERM v1 API', + description: + 'These are the Non-employee Risk Management APIs for SailPoint. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.', + slug: '/api/nerm/v1', + }, + // @ts-ignore + items: require('./docs/api/nerm/v1/sidebar.js'), + }, + ], + }, + ], + }, + { + type: 'category', + label: 'Extensibility', + link: { + type: 'doc', + id: 'extensibility', + }, + items: [ + { + type: 'autogenerated', + dirName: 'extensibility', + }, + ], + }, + { + type: 'category', + label: 'Connectivity', + link: { + type: 'doc', + id: 'connectivity', + }, + items: [ + { + type: 'autogenerated', + dirName: 'connectivity', + }, + ], + }, + { + type: 'category', + label: 'Tools', + link: { + type: 'doc', + id: 'tools', + }, + items: [ + { + type: 'autogenerated', + dirName: 'tools', + }, + ], + }, + { + type: 'category', + label: 'Reporting', + link: { + type: 'doc', + id: 'reporting', + }, + items: [ + { + type: 'autogenerated', + dirName: 'reporting', + }, + ], + }, + { + type: 'category', + label: 'Guides', + link: { + type: 'doc', + id: 'guides', + }, + items: [ + { + type: 'autogenerated', + dirName: 'guides', + }, + ], + }, + { + type: 'link', + label: 'Product Documentation', + href: 'https://documentation.sailpoint.com', + }, + { + type: 'link', + label: 'Certifications', + href: 'https://university.sailpoint.com/Saba/Web_spf/NA10P1PRD075/guest/categorydetail/categ000000000003041/true/xxemptyxx/', + }, + ], + }, + ], + iiqSideBar: [ + { + type: 'category', + label: 'Documentation', + collapsible: false, + link: { + type: 'doc', + id: 'iiq', + }, + items: [ + { + type: 'category', + label: 'API Specifications', + link: { + type: 'generated-index', + title: 'API Specifications', + description: + "These are the SCIM APIs for SailPoint's on-premise service, IdentityIQ. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.", + slug: '/api/iiq', + }, + // @ts-ignore + items: require('./docs/api/iiq/sidebar.js'), + }, + { + type: 'category', + label: 'Plugin Developer Guide', + link: { + type: 'doc', + id: 'plugin-developer-guide', + }, + items: [ + { + type: 'autogenerated', + dirName: 'iiq/plugin-developer-guide', + }, + ], + }, + { + type: 'link', + label: 'Product Documentation', + href: 'https://documentation.sailpoint.com/#identityiq', + }, + { + type: 'link', + label: 'Certifications', + href: 'https://university.sailpoint.com/Saba/Web_spf/NA10P1PRD075/guest/categorydetail/categ000000000003042/true/xxemptyxx/', + }, + ], + }, + ], +}; +module.exports = sidebars; diff --git a/src/components/blog/BlogSidebar/index.js b/src/components/blog/BlogSidebar/index.js index 155690f9f..3a86608ca 100644 --- a/src/components/blog/BlogSidebar/index.js +++ b/src/components/blog/BlogSidebar/index.js @@ -18,7 +18,7 @@ export default function BlogSidebar({ const tagTechnologyResultset = [] const tagProductResultset = [] for (const tagGroup of data.extras.tag_groups) { - if (tagGroup.id === 20) { + if (tagGroup.id === 45) { for (const tag of tagGroup.tags) { tagProductResultset.push(tag.text) } diff --git a/src/components/homepage/DiscussCard/styles.module.css b/src/components/homepage/DiscussCard/styles.module.css index 5e6eadd4f..03c6c8148 100644 --- a/src/components/homepage/DiscussCard/styles.module.css +++ b/src/components/homepage/DiscussCard/styles.module.css @@ -119,15 +119,14 @@ } .tags { - position: absolute; - margin: 20px; - width: 230px; + grid-gap: 3px; bottom: 50px; - left: 0; - display: grid; - grid-template-columns: max-content max-content max-content; - grid-gap: 10px; + position: absolute; + padding: -4%; + margin-top: 5%; + margin-bottom: 6%; + margin-left: 8%; } .idn { diff --git a/src/components/homepage/HomepageCard/index.js b/src/components/homepage/HomepageCard/index.js index a218b15d2..5fd6bd32f 100644 --- a/src/components/homepage/HomepageCard/index.js +++ b/src/components/homepage/HomepageCard/index.js @@ -6,7 +6,7 @@ import ThemedImage from '@theme/ThemedImage'; import {addDarkToFileName} from '../../../util/util'; export default function HomepageCard({link, title, image, product}) { - const productStyles = product === 'idn' ? styles.idn : styles.iiq; + const productStyles = product === 'isc' ? styles.idn : styles.iiq; return ( diff --git a/src/components/homepage/HomepageGettingStarted/index.js b/src/components/homepage/HomepageGettingStarted/index.js index f9fc989ff..527b310b6 100644 --- a/src/components/homepage/HomepageGettingStarted/index.js +++ b/src/components/homepage/HomepageGettingStarted/index.js @@ -23,8 +23,8 @@ export default function HomepageGettingStarted() {
    - -
    - -
    +
    + +
    -
    word.charAt(0).toUpperCase() + word.slice(1)) + .join(" "); } +} + React.useEffect(() => { diff --git a/src/css/custom.css b/src/css/custom.css index e0405b1a0..6a097d0bc 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -416,6 +416,12 @@ html[data-theme='dark'] .header-github-link:before { border-bottom: 1px solid var(--ifm-color-emphasis-400); } +.navbar__section__link { + font-weight: bolder; + background-color: transparent !important; + border-radius: 0; +} + .indent { padding-left: 1rem; } @@ -466,6 +472,14 @@ div[class^='announcementBar_'] { height: 35px; } +@media screen and (max-width: 750px) { + div[class^='announcementBar_'] { + background: repeating-linear-gradient(145deg,rgba(0,51,161,1),rgba(0,79,181,1),rgba(0,113,206,1)); + color: #ffffff; + height: 52.5px; + } +} + div[class^='responseTabsContainer_'] { max-width: 590px !important; } diff --git a/src/pages/ambassador.module.css b/src/pages/ambassador.module.css index 6f4ce2d30..47534cca4 100644 --- a/src/pages/ambassador.module.css +++ b/src/pages/ambassador.module.css @@ -1,106 +1,95 @@ - .gridContainer { - display: grid; - place-content: center; - grid-template-columns: repeat(auto-fit, minmax(400px, 1fr)); - grid-gap: 40px; - margin-left: 40px; - margin-right: 40px; - } - - .center { - margin: 50px auto; - max-width: 1000px; - } - - .headerText { - text-align: center; - display: flex; - margin: 100px auto 0px auto; - width: calc(100% - 100px); - justify-content: center; - } - - .headerTextOne { - color: var(--ifm-color-primary); - font-size: 30px; - font-weight: bold; - line-height: 100%; - } - - - - - - .spanLeft { - width: 35%; - margin: 14px; - position: relative; - top: -45px; - border-bottom-width:2px; - border-bottom-style:solid; - border-bottom-color:var(--ifm-color-primary); - } - - - - .imageContainer { - text-align: center; - display: flex; - justify-content: center; - } - - .ambassadorImage { - margin-left: 5px; - padding: 20px; - height: 120px; - width: 120px; - } - - - .ambassadorPurposeContainer { - display: flex; - justify-content: center; - width: calc(75% + 75px); - align-items: center; - margin: 0px auto 0px auto; - } - - - .ambassadorPurposeText { - font-size: 21px; - padding: 50px 0px 50px 50px; - font-weight: 500; - color: var(--dev-text-color-normal); - } - - .ambassadorPurposeImage { - width: 40%; - box-shadow: var(--dev-card-selected); - border-radius: 40px; - margin: 50px 50px 50px 0px; - } - - @media only screen and (max-width: 1460px) { - .ambassadorPurposeContainer { - flex-direction: column; - } - .ambassadorPurposeImage { - width: 80%; - margin: 50px 50px 50px 50px; - } - .ambassadorPurposeText { - padding: 50px 50px 50px 50px; - } + display: grid; + place-content: center; + grid-template-columns: repeat(auto-fit, minmax(400px, 1fr)); + grid-gap: 40px; + margin-left: 40px; + margin-right: 40px; } +.center { + margin: 50px auto; + max-width: 1000px; +} +.headerText { + text-align: center; + display: flex; + margin: 100px auto 0px auto; + width: calc(100% - 100px); + justify-content: center; +} +.headerTextOne { + color: var(--ifm-color-primary); + font-size: 30px; + font-weight: bold; + line-height: 100%; +} +.spanLeft { + width: 35%; + margin: 14px; + position: relative; + top: -45px; + border-bottom-width: 2px; + border-bottom-style: solid; + border-bottom-color: var(--ifm-color-primary); +} +.imageContainer { + text-align: center; + display: flex; + justify-content: center; +} +.ambassadorImage { + margin-left: 5px; + padding: 20px; + height: 120px; + width: 120px; +} +.expertAmbassadorImage { + margin-left: 5px; + height: 120px; + width: 120px; +} +.ambassadorPurposeContainer { + display: flex; + justify-content: center; + width: calc(75% + 75px); + align-items: center; + margin: 0px auto 0px auto; +} + +.ambassadorPurposeText { + font-size: 21px; + padding: 50px 0px 50px 50px; + font-weight: 500; + color: var(--dev-text-color-normal); +} + +.ambassadorPurposeImage { + width: 40%; + box-shadow: var(--dev-card-selected); + border-radius: 40px; + margin: 50px 50px 50px 0px; +} + +@media only screen and (max-width: 1460px) { + .ambassadorPurposeContainer { + flex-direction: column; + } + .ambassadorPurposeImage { + width: 80%; + margin: 50px 50px 50px 50px; + } + .ambassadorPurposeText { + padding: 50px 50px 50px 50px; + } +} .button:hover { cursor: pointer; @@ -130,7 +119,7 @@ box-shadow: 0px 20px 60px #00000015; border: 2px solid #df61ca; border-radius: 5px; - transition: all 0.3s; + transition: all 0.3s; } .link { diff --git a/src/pages/ambassador-program.js b/src/pages/ambassadors.js similarity index 98% rename from src/pages/ambassador-program.js rename to src/pages/ambassadors.js index 3b6047c1b..bda6a6bdc 100644 --- a/src/pages/ambassador-program.js +++ b/src/pages/ambassadors.js @@ -37,7 +37,7 @@ export default function Ambassador() {
    diff --git a/src/theme/DocCard/index.js b/src/theme/DocCard/index.js new file mode 100644 index 000000000..dbbcfa835 --- /dev/null +++ b/src/theme/DocCard/index.js @@ -0,0 +1,93 @@ +import React from 'react'; +import clsx from 'clsx'; +import Link from '@docusaurus/Link'; +import { + findFirstCategoryLink, + useDocById, +} from '@docusaurus/theme-common/internal'; +import isInternalUrl from '@docusaurus/isInternalUrl'; +import {translate} from '@docusaurus/Translate'; +import styles from './styles.module.css'; +import { FontAwesomeIcon } from '@fortawesome/react-fontawesome' +import { faFolderOpen, faLink, faBook, faArrowUpRightFromSquare } from '@fortawesome/pro-duotone-svg-icons' +import { useColorMode } from '@docusaurus/theme-common'; + +function CardContainer({href, children}) { + return ( + + {children} + + ); +} +function CardLayout({href, icon, title, description}) { + return ( + +

    + {icon}{title} +

    + {description && ( +

    + {description} +

    + )} +     + ); +} +function CardCategory({item}) { + const href = findFirstCategoryLink(item); + const {colorMode} = useColorMode(); + //const icon = colorMode === 'dark' ? : ; + //const icon = ; + //console.log(item) + // Unexpected: categories that don't have a link have been filtered upfront + if (!href) { + return null; + } + return ( + } + //icon={icon} + title={item.label} + description={ + item.customProps?.description ?? + translate( + { + message: '{count} items', + id: 'theme.docs.DocCard.categoryDescription', + description: + 'The default description for a category card in the generated index about how many items this category includes', + }, + {count: item.items.length}, + ) + } + /> + ); +} +function CardLink({item}) { + const {colorMode} = useColorMode(); + const icon = isInternalUrl(item.href) ? : ; + const doc = useDocById(item.docId ?? undefined); + return ( + + ); +} +export default function DocCard({item}) { + switch (item.type) { + case 'link': + return ; + case 'category': + return ; + default: + throw new Error(`unknown item type ${JSON.stringify(item)}`); + } +} diff --git a/src/theme/DocCard/styles.module.css b/src/theme/DocCard/styles.module.css new file mode 100644 index 000000000..e53779bd4 --- /dev/null +++ b/src/theme/DocCard/styles.module.css @@ -0,0 +1,28 @@ +.cardContainer { + --ifm-link-color: var(--ifm-color-emphasis-800); + --ifm-link-hover-color: var(--ifm-color-emphasis-700); + --ifm-link-hover-decoration: none; + + box-shadow: 0 1.5px 3px 0 rgb(0 0 0 / 15%); + border: 1px solid var(--ifm-color-emphasis-200); + transition: all var(--ifm-transition-fast) ease; + transition-property: border, box-shadow; + height: 9.5em; +} + +.cardContainer:hover { + border-color: var(--ifm-color-primary); + box-shadow: 0 3px 6px 0 rgb(0 0 0 / 20%); +} + +.cardContainer *:last-child { + margin-bottom: 0; +} + +.cardTitle { + font-size: 1.2rem; +} + +.cardDescription { + font-size: 0.9rem; +} diff --git a/src/util/util.js b/src/util/util.js index 596d19d67..4948b6ad1 100644 --- a/src/util/util.js +++ b/src/util/util.js @@ -26,7 +26,7 @@ export function discourseProductTag() { if (discourseBaseURL().includes('soon')) { return 11; } else { - return 20; + return 45 } } diff --git a/static/api-specs/idn/beta/paths/access-profile-bulk-update-requestable.yaml b/static/api-specs/idn/beta/paths/access-profile-bulk-update-requestable.yaml new file mode 100644 index 000000000..5ccb9b493 --- /dev/null +++ b/static/api-specs/idn/beta/paths/access-profile-bulk-update-requestable.yaml @@ -0,0 +1,61 @@ +post: + operationId: updateAccessProfilesInBulk + summary: Update Access Profile(s) requestable field. + tags: + - Access Profiles + description: >- + This API initiates a bulk update of field requestable for one or more Access Profiles. + + + > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** + list of the response.Requestable field of these Access Profiles marked as **true** or **false**. + + > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** + list of the response. Access Profiles marked as **notFound** will not be updated. + + > A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, + a SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able + to administer. + requestBody: + required: true + content: + application/json: + schema: + $ref: '../../v3/schemas/access/AccessProfileBulkUpdateRequest.yaml' + example: + [ + { + "id": "464ae7bf-791e-49fd-b746-06a2e4a89635", + "requestable": false + } + ] + responses: + '207': + description: List of updated and not updated Access Profiles. + content: + application/json: + schema: + $ref: '../../v3/schemas/access/AccessProfileBulkUpdateResponse.yaml' + example: + [ + { + "id": "464ae7bf-791e-49fd-b746-06a2e4a89635", + "status": "201", + "requestable": false, + "description": "Access Profile updated successfully." + } + ] + '400': + $ref: '../../v3/responses/400.yaml' + '401': + $ref: '../../v3/responses/401.yaml' + '403': + $ref: '../../v3/responses/403.yaml' + '412': + $ref: '../../v3/responses/412.yaml' + '429': + $ref: '../../v3/responses/429.yaml' + '500': + $ref: '../../v3/responses/500.yaml' + security: + - UserContextAuth: [idn:access-profile:manage] diff --git a/static/api-specs/idn/beta/paths/access-request-identity-metrics.yaml b/static/api-specs/idn/beta/paths/access-request-identity-metrics.yaml new file mode 100644 index 000000000..db7efa317 --- /dev/null +++ b/static/api-specs/idn/beta/paths/access-request-identity-metrics.yaml @@ -0,0 +1,52 @@ +get: + tags: + - Access Request Identity Metrics + summary: Return access request identity metrics + description: >- + Use this API to return information access metrics. + operationId: getAccessRequestIdentityMetrics + parameters: + - name: identityId + in: path + description: Manager's identity ID. + required: true + schema: + type: string + example: '7025c863-c270-4ba6-beea-edf3cb091573' + - name: requestedObjectId + in: path + description: Requested access item's ID. + required: true + schema: + type: string + example: '2db501be-f0fb-4cc5-a695-334133c52891' + - name: type + in: path + description: Requested access item's type. + required: true + schema: + type: string + items: + $ref: '../schemas/AccessItemRef.yaml' + example: ENTITLEMENT + security: + - UserContextAuth: [idn:access-request-approvals:read] + responses: + '200': + description: Summary of the resource access and source activity for the direct reports of the provided manager. + content: + application/json: + schema: + type: object + items: + $ref: '../schemas/AccessRequestIdentityMetrics.yaml' + '400': + $ref: '../../v3/responses/400.yaml' + '401': + $ref: '../../v3/responses/401.yaml' + '403': + $ref: '../../v3/responses/403.yaml' + '429': + $ref: '../../v3/responses/429.yaml' + '500': + $ref: '../../v3/responses/500.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/beta/paths/account.yaml b/static/api-specs/idn/beta/paths/account.yaml index ac8b6efb3..416ba4fb9 100644 --- a/static/api-specs/idn/beta/paths/account.yaml +++ b/static/api-specs/idn/beta/paths/account.yaml @@ -4,7 +4,7 @@ get: - Accounts summary: Account Details description: >- - This API returns the details for a single account based on the ID. + Use this API to return the details for a single account by its ID. A token with ORG_ADMIN authority is required to call this API. security: @@ -15,11 +15,11 @@ get: schema: type: string required: true - description: The account ID + description: Account ID. example: ef38f94347e94562b5bb8424a56397d8 responses: "200": - description: An account object + description: Account object. content: application/json: schema: @@ -42,7 +42,9 @@ patch: - Accounts summary: Update Account description: >- - This updates account details. + Use this endpoint to update an account with a PATCH request. + + The request must provide a JSONPatch payload. A token with ORG_ADMIN authority is required to call this API. security: @@ -53,7 +55,7 @@ patch: schema: type: string required: true - description: The account ID + description: Account ID. example: ef38f94347e94562b5bb8424a56397d8 requestBody: required: true @@ -92,9 +94,13 @@ put: - Accounts summary: Update Account description: >- - This API submits an account update task and returns the task ID. + Use this API to update an account with a PUT request. + + This endpoint submits an account update task and returns the task ID. A token with ORG_ADMIN authority is required to call this API. + + >**NOTE: You can only use this PUT endpoint to update accounts from sources of the "DelimitedFile" type.** security: - UserContextAuth: [idn:accounts:manage] parameters: @@ -103,7 +109,7 @@ put: schema: type: string required: true - description: The account ID + description: Account ID. example: ef38f94347e94562b5bb8424a56397d8 requestBody: required: true @@ -113,7 +119,7 @@ put: $ref: "../schemas/AccountAttributes.yaml" responses: "202": - description: Async task details + description: Async task details. content: application/json: schema: @@ -136,9 +142,16 @@ delete: - Accounts summary: Delete Account description: >- - This API submits an account delete task and returns the task ID. + Use this API to delete an account. + + This endpoint submits an account delete task and returns the task ID. + + This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account's returning with the next aggregation between the source and IdentityNow. + To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. A token with ORG_ADMIN authority is required to call this API. + + >**NOTE:** You can only delete accounts from sources of the "DelimitedFile" type.** security: - UserContextAuth: [idn:accounts:manage] parameters: @@ -147,11 +160,11 @@ delete: schema: type: string required: true - description: The account ID + description: Account ID. example: ef38f94347e94562b5bb8424a56397d8 responses: "202": - description: Async task details + description: Async task details. content: application/json: schema: @@ -167,4 +180,4 @@ delete: "429": $ref: "../../v3/responses/429.yaml" "500": - $ref: "../../v3/responses/500.yaml" + $ref: "../../v3/responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/idn/beta/paths/accounts.yaml b/static/api-specs/idn/beta/paths/accounts.yaml index d1dc278ee..f53b603ab 100644 --- a/static/api-specs/idn/beta/paths/accounts.yaml +++ b/static/api-specs/idn/beta/paths/accounts.yaml @@ -70,9 +70,7 @@ get: schema: type: array items: - anyOf: - - $ref: '../schemas/SlimAccount.yaml' - - $ref: '../schemas/FullAccount.yaml' + $ref: "../schemas/Account.yaml" examples: SlimAccounts: description: List of slim accounts that would result with *detailLevel = SLIM* @@ -136,6 +134,8 @@ post: The `sourceId` where this account will be created must be included in the `attributes` object. + >**Note: This API only supports account creation for file based sources.** + A token with ORG_ADMIN authority is required to call this API. security: - UserContextAuth: [idn:accounts:manage] diff --git a/static/api-specs/idn/beta/paths/auth-profile.yaml b/static/api-specs/idn/beta/paths/auth-profile.yaml new file mode 100644 index 000000000..7d395e978 --- /dev/null +++ b/static/api-specs/idn/beta/paths/auth-profile.yaml @@ -0,0 +1,134 @@ +get: + operationId: getProfileConfig + tags: + - Auth Profile + summary: Get Auth Profile. + description: >- + This API returns auth profile information. + security: + - UserContextAuth: [sp:auth-profile:read] + responses: + '200': + description: Auth Profile + content: + application/json: + schema: + $ref: '../schemas/AuthProfile.yaml' + '400': + $ref: '../../v3/responses/400.yaml' + '401': + $ref: '../../v3/responses/401.yaml' + '403': + $ref: '../../v3/responses/403.yaml' + '404': + $ref: '../../v3/responses/404.yaml' + '429': + $ref: '../../v3/responses/429.yaml' + '500': + $ref: '../../v3/responses/500.yaml' +post: + operationId: createProfileConfig + tags: + - Auth Profile + summary: Create Auth Profile. + description: >- + This API creates an auth profile. + security: + - UserContextAuth: [sp:auth-profile:create] + requestBody: + required: true + content: + application/json: + schema: + $ref: "../schemas/AuthProfileRequest.yaml" + responses: + '202': + description: Auth Profile details + content: + application/json: + schema: + $ref: '../schemas/AuthProfile.yaml' + '400': + $ref: '../../v3/responses/400.yaml' + '401': + $ref: '../../v3/responses/401.yaml' + '403': + $ref: '../../v3/responses/403.yaml' + '429': + $ref: '../../v3/responses/429.yaml' + '500': + $ref: '../../v3/responses/500.yaml' +patch: + operationId: patchProfileConfig + tags: + - Auth Profile + summary: Patch a specified Auth Profile + description: >- + This API updates an existing Auth Profile. The following fields are patchable: + + **offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** + parameters: + - name: id + in: path + description: ID of the Auth Profile to patch + required: true + schema: + type: string + example: 2c91808a7813090a017814121919ecca + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '../schemas/JsonPatchOperation.yaml' + required: true + responses: + '200': + description: Responds with the Access Profile as updated. + content: + application/json: + schema: + $ref: '../schemas/AuthProfile.yaml' + '400': + $ref: '../../v3/responses/400.yaml' + '401': + $ref: '../../v3/responses/401.yaml' + '403': + $ref: '../../v3/responses/403.yaml' + '429': + $ref: '../../v3/responses/429.yaml' + '500': + $ref: '../../v3/responses/500.yaml' + security: + - UserContextAuth: [sp:auth-profile:update] +delete: + operationId: deleteProfileConfig + tags: + - Auth Profile + summary: Delete the specified Auth Profile + description: >- + This API deletes an existing Auth Profile. + parameters: + - name: id + in: path + description: ID of the Access Profile to delete + required: true + schema: + type: string + example: 2c91808a7813090a017814121919ecca + responses: + '204': + $ref: "../../v3/responses/204.yaml" + '400': + $ref: '../../v3/responses/400.yaml' + '401': + $ref: '../../v3/responses/401.yaml' + '403': + $ref: '../../v3/responses/403.yaml' + '429': + $ref: '../../v3/responses/429.yaml' + '500': + $ref: '../../v3/responses/500.yaml' + security: + - UserContextAuth: [sp:auth-profile:delete] diff --git a/static/api-specs/idn/beta/paths/auth-profiles.yaml b/static/api-specs/idn/beta/paths/auth-profiles.yaml new file mode 100644 index 000000000..fdb592bf8 --- /dev/null +++ b/static/api-specs/idn/beta/paths/auth-profiles.yaml @@ -0,0 +1,26 @@ +get: + operationId: getProfileConfigList + tags: + - Auth Profile + summary: Get list of Auth Profiles. + description: >- + This API returns a list of auth profiles. + security: + - UserContextAuth: [sp:auth-profile:read] + responses: + '200': + description: List of Auth Profiles + content: + application/json: + schema: + $ref: '../schemas/AuthProfileSummary.yaml' + '400': + $ref: '../../v3/responses/400.yaml' + '401': + $ref: '../../v3/responses/401.yaml' + '403': + $ref: '../../v3/responses/403.yaml' + '429': + $ref: '../../v3/responses/429.yaml' + '500': + $ref: '../../v3/responses/500.yaml' diff --git a/static/api-specs/idn/beta/paths/notification-preferences.yaml b/static/api-specs/idn/beta/paths/notification-preferences.yaml index 5ca8944ff..581f8fa33 100644 --- a/static/api-specs/idn/beta/paths/notification-preferences.yaml +++ b/static/api-specs/idn/beta/paths/notification-preferences.yaml @@ -6,13 +6,13 @@ get: description: >- Returns the notification preferences for tenant. Note that if the key doesn't exist, then a 404 will be returned. - Request will require the following legacy roles: ORG_ADMIN and API - # security: - # - oauth2: [ORG_ADMIN,API] + security: + - UserContextAuth: [ idn:notification-preferences:read ] parameters: - in: path name: key required: true + example: cloud_manual_work_item_summary schema: type: string description: The notification key. @@ -33,28 +33,24 @@ get: $ref: '../../v3/responses/404.yaml' '429': $ref: '../../v3/responses/429.yaml' + '500': + $ref: '../../v3/responses/500.yaml' put: operationId: putNotificationPreference tags: - Notifications - summary: Overwrite the preferences for the given notification key. + summary: Overwrite preferences notification key. description: >- - In the notification world, a notification flows through these salient stages - - 1. Interest matching, - 2. Preferences - 3. Template Rendering. - - The default notification preferences make up a part of the second stage, along with user preferences (which is a future goal). The expectation is for - admins to be able to set default preferences for their org, like opting in to or out of certain notifications, and configuring future preferences as - we tack on more features. The key in the Dto is not necessary but if it is provided and doesn't match the key in the URI, then a 400 will be thrown. + Allows admins to opt in to or out of certain notifications for their org. The default state is opted in. `key` is optional but if it is provided and doesn't match the key in the URI, then a 400 will be thrown. + + security: + - UserContextAuth: [ idn:notification-preferences:create ] - Request will require the following legacy roles: ORG_ADMIN and API - # security: - # - oauth2: [ORG_ADMIN,API] parameters: - in: path name: key required: true + example: cloud_manual_work_item_summary schema: type: string description: The notification key. @@ -81,6 +77,5 @@ put: $ref: '../../v3/responses/404.yaml' '429': $ref: '../../v3/responses/429.yaml' - - - + '500': + $ref: '../../v3/responses/500.yaml' diff --git a/static/api-specs/idn/beta/paths/notification-template-context.yaml b/static/api-specs/idn/beta/paths/notification-template-context.yaml index 3ada451de..e9a9d05f9 100644 --- a/static/api-specs/idn/beta/paths/notification-template-context.yaml +++ b/static/api-specs/idn/beta/paths/notification-template-context.yaml @@ -4,15 +4,12 @@ get: - Notifications summary: Get Notification Template Context description: >- - The notification service (Hermes) maintains metadata to construct the notification templates or supply any information during the event propagation. - The data-store where this information is retrieved is called "Global Context" (a.k.a. notification template context). It defines a set of attributes + The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. + The data-store where this information is retrieved is called "Global Context" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization). - - Regarding authorization, the access token contains the tenant and will grant access to the one requested. - Requires the following security scope: idn:notification-templates:read - # security: - # - oauth2: [idn:notification-templates:read] + security: + - UserContextAuth: [ idn:notification-templates:read ] responses: '200': @@ -20,9 +17,7 @@ get: content: application/json: schema: - type: array - items: - $ref: '../schemas/NotificationTemplateContext.yaml' + $ref: '../schemas/NotificationTemplateContext.yaml' '400': $ref: '../../v3/responses/400.yaml' '401': diff --git a/static/api-specs/idn/beta/paths/notification-template-defaults.yaml b/static/api-specs/idn/beta/paths/notification-template-defaults.yaml index af6af45b2..dc61dbf26 100644 --- a/static/api-specs/idn/beta/paths/notification-template-defaults.yaml +++ b/static/api-specs/idn/beta/paths/notification-template-defaults.yaml @@ -4,7 +4,9 @@ get: - Notifications summary: List Notification Template Defaults description: >- - This lists the default templates used for notifications, such as emails from IdentityNow. Since this is a beta feature, it doesn't include all the templates. + This lists the default templates used for notifications, such as emails from IdentityNow. + security: + - UserContextAuth: [ idn:notification-template-defaults:read ] parameters: - $ref: '../../v3/parameters/limit.yaml' - $ref: '../../v3/parameters/offset.yaml' @@ -12,6 +14,7 @@ get: name: filters schema: type: string + example: key eq "cloud_manual_work_item_summary" 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) diff --git a/static/api-specs/idn/beta/paths/notification-templates-bulk-delete.yaml b/static/api-specs/idn/beta/paths/notification-templates-bulk-delete.yaml index dee8b43f0..6727dceab 100644 --- a/static/api-specs/idn/beta/paths/notification-templates-bulk-delete.yaml +++ b/static/api-specs/idn/beta/paths/notification-templates-bulk-delete.yaml @@ -4,7 +4,9 @@ post: - Notifications summary: Bulk Delete Notification Templates description: >- - This lets you bulk delete templates that you previously created for your site. Since this is a beta feature, you can only delete a subset of your notifications, i.e. ones that show up in the list call. + This lets you bulk delete templates that you previously created for your site. Since this is a beta feature, please contact support to enable usage. + security: + - UserContextAuth: [ idn:notification-templates:delete ] requestBody: required: true content: @@ -25,4 +27,4 @@ post: '429': $ref: '../../v3/responses/429.yaml' '500': - $ref: '../../v3/responses/500.yaml' \ No newline at end of file + $ref: '../../v3/responses/500.yaml' diff --git a/static/api-specs/idn/beta/paths/notification-templates.yaml b/static/api-specs/idn/beta/paths/notification-templates.yaml index 0b85c8285..031eed3ed 100644 --- a/static/api-specs/idn/beta/paths/notification-templates.yaml +++ b/static/api-specs/idn/beta/paths/notification-templates.yaml @@ -4,7 +4,9 @@ get: - Notifications summary: List Notification Templates description: >- - This lists the templates that you have modified for your site. Since this is a beta feature, it doesn't include all your modified templates. + This lists the templates that you have modified for your site. + security: + - UserContextAuth: [ idn:notification-templates:read ] parameters: - $ref: '../../v3/parameters/limit.yaml' - $ref: '../../v3/parameters/offset.yaml' @@ -58,6 +60,8 @@ post: You can also use this endpoint to update a template. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. + security: + - UserContextAuth: [ idn:notification-templates:create] requestBody: required: true content: diff --git a/static/api-specs/idn/beta/paths/role-entitlements.yaml b/static/api-specs/idn/beta/paths/role-entitlements.yaml new file mode 100644 index 000000000..1d61ea14e --- /dev/null +++ b/static/api-specs/idn/beta/paths/role-entitlements.yaml @@ -0,0 +1,92 @@ +get: + operationId: getRoleEntitlements + tags: + - Roles + summary: List role's Entitlements + description: >- + This API lists the Entitlements associated with a given role. + + + A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + parameters: + - name: id + in: path + description: ID of the containing role + required: true + schema: + type: string + example: 2c91808a7813090a017814121919ecca + - $ref: '../../v3/parameters/limit.yaml' + - $ref: '../../v3/parameters/offset.yaml' + - $ref: '../../v3/parameters/count.yaml' + - in: query + name: filters + schema: + type: string + description: >- + Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) + + + Filtering is supported for the following fields and operators: + + + **id**: *eq, in* + + + **name**: *eq, sw* + + + **attribute**: *eq, sw* + + + **value**: *eq, sw* + + + **created**: *gt, lt, ge, le* + + + **modified**: *gt, lt, ge, le* + + + **owner.id**: *eq, in* + + + **source.id**: *eq, in* + example: attribute eq "memberOf" + required: false + - in: query + name: sorters + schema: + type: string + format: comma-separated + description: >- + Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **name, attribute, value, created, modified** + example: name,-modified + required: false + responses: + '200': + description: List of Entitlements + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/Entitlement.yaml' + '400': + $ref: '../../v3/responses/400.yaml' + '401': + $ref: '../../v3/responses/401.yaml' + '403': + $ref: '../../v3/responses/403.yaml' + '429': + $ref: '../../v3/responses/429.yaml' + '500': + $ref: '../../v3/responses/500.yaml' + security: + - UserContextAuth: [idn:role-unchecked:read, idn:role-unchecked:manage, idn:role-checked:manage, idn:role-checked:read] + + + diff --git a/static/api-specs/idn/beta/paths/service-desk-integration.yaml b/static/api-specs/idn/beta/paths/service-desk-integration.yaml index 5afcc45ea..808237ac7 100644 --- a/static/api-specs/idn/beta/paths/service-desk-integration.yaml +++ b/static/api-specs/idn/beta/paths/service-desk-integration.yaml @@ -136,26 +136,30 @@ patch: description: | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - PATCH can only be applied to the following fields: - * `beforeProvisioningRule` - * `description` - * `ownerRef` - - A 403 Forbidden Error indicates that you attempted to PATCH a field that is not allowed. + Only `replace` operations are accepted by this endpoint. + + A 403 Forbidden Error indicates that you attempted to PATCH a operation that is not allowed. content: application/json-patch+json: schema: - $ref: '../schemas/JsonPatch.yaml' - example: + type: object + description: A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902). Only `replace` operations are accepted by this endpoint. + properties: + operations: + description: Operations to be applied + type: array + items: + $ref: '../schemas/JsonPatchOperation.yaml' + example: >- [ { - "op": "replace", - "path": "/ownerRef", - "value": { - "id": "2c9180867d05b227017d09921a205b4d", - "type": "IDENTITY", - "name": "Angelo2 tester" - } + "op": "replace", + "path": "/ownerRef", + "value": { + "id": "2c9180867d05b227017d09921a205b4d", + "type": "IDENTITY", + "name": "Angelo2 tester" + } } ] responses: diff --git a/static/api-specs/idn/beta/paths/tagged-objects-type.yaml b/static/api-specs/idn/beta/paths/tagged-objects-type.yaml index 747413f35..69177edd1 100644 --- a/static/api-specs/idn/beta/paths/tagged-objects-type.yaml +++ b/static/api-specs/idn/beta/paths/tagged-objects-type.yaml @@ -4,7 +4,7 @@ get: - UserContextAuth: [ idn:tag:read, idn:tag:manage ] tags: - Tagged Objects - summary: List Tagged Objects + summary: List Tagged Objects by Type description: >- This API returns a list of all tagged objects by type. @@ -16,9 +16,14 @@ get: schema: type: string enum: - - ROLE + - ACCESS_PROFILE + - APPLICATION + - CAMPAIGN + - ENTITLEMENT - IDENTITY + - ROLE - SOD_POLICY + - SOURCE required: true description: The type of tagged object to retrieve. example: ROLE diff --git a/static/api-specs/idn/beta/paths/tenant.yaml b/static/api-specs/idn/beta/paths/tenant.yaml new file mode 100644 index 000000000..3d182c82a --- /dev/null +++ b/static/api-specs/idn/beta/paths/tenant.yaml @@ -0,0 +1,28 @@ +get: + operationId: getTenant + tags: + - Tenant + summary: Get Tenant Information. + description: >- + This rest endpoint can be used to retrieve tenant details. + security: + - UserContextAuth: [sp:tenant:read] + responses: + '200': + description: Tenant Info + content: + application/json: + schema: + $ref: '../schemas/Tenant.yaml' + '400': + $ref: '../../v3/responses/400.yaml' + '401': + $ref: '../../v3/responses/401.yaml' + '403': + $ref: '../../v3/responses/403.yaml' + '404': + $ref: '../../v3/responses/404.yaml' + '429': + $ref: '../../v3/responses/429.yaml' + '500': + $ref: '../../v3/responses/500.yaml' diff --git a/static/api-specs/idn/beta/paths/workgroups/workgroup.yaml b/static/api-specs/idn/beta/paths/workgroups/workgroup.yaml index 5fe353485..8aa7c1229 100644 --- a/static/api-specs/idn/beta/paths/workgroups/workgroup.yaml +++ b/static/api-specs/idn/beta/paths/workgroups/workgroup.yaml @@ -67,12 +67,15 @@ patch: tags: - Governance Groups summary: Patch a Governance Group - description: This API updates existing Governance Group by its ID. Following fields are patchable. - - **name**, **description** + description: >- + This API updates an existing governance group by ID. - A token with API, ORG_ADMIN is required to call this API. In addition. - + The following fields and objects are patchable: + * name + * description + * owner + + A token with API or ORG_ADMIN authority is required to call this API. parameters: - in: path name: id diff --git a/static/api-specs/idn/beta/schemas/AccessItemRef.yaml b/static/api-specs/idn/beta/schemas/AccessItemRef.yaml index 0769fa677..012d918ea 100644 --- a/static/api-specs/idn/beta/schemas/AccessItemRef.yaml +++ b/static/api-specs/idn/beta/schemas/AccessItemRef.yaml @@ -2,12 +2,12 @@ type: object properties: id: type: string - description: The ID of the access item for which to retrieve the recommendation + description: ID of the access item to retrieve the recommendation for. example: '2c938083633d259901633d2623ec0375' type: type: string example: ENTITLEMENT - description: The type of the access item. + description: Access item's type. enum: - ENTITLEMENT - ACCESS_PROFILE diff --git a/static/api-specs/idn/beta/schemas/AccessRequestIdentityMetrics.yaml b/static/api-specs/idn/beta/schemas/AccessRequestIdentityMetrics.yaml new file mode 100644 index 000000000..1eebadab6 --- /dev/null +++ b/static/api-specs/idn/beta/schemas/AccessRequestIdentityMetrics.yaml @@ -0,0 +1,52 @@ +type: object +properties: + identitiesWithAccess: + type: integer + format: int64 + nullable: true + description: + A count of the provided manager's direct reports that have already been granted the access item in question. + example: 8 + identitiesWithActivity: + type: integer + format: int64 + nullable: true + description: >- + A count of the provided manager's direct reports that have activity within the associated source. + example: 5 + totalIdentities: + type: integer + format: int64 + nullable: true + description: >- + Total number of identities who share a manager with the identity requesting access. + example: 10 + squadAvailable: + type: boolean + default: false + description: >- + True if the manager's ID can be found. + False if the manager's ID cannot be found. + example: true + validActivityObject: + type: boolean + default: false + description: >- + True if the requested access item is associated with a single Activity Data Insights connector source. + False if the requested access item type is a role. If it's a role, it matches to multiple sources, + so a single relevant source can't be determined for activity metrics. + example: true + activitySourceConfigured: + type: boolean + default: false + description: >- + True if the Activity Data Insights connector is configured for the source associated with the requested access item. + False if the matching Activity Data Insights connector is not configured. + example: true + requestedObjectActive: + type: boolean + default: false + description: >- + True if the requested access item exists and is available. + False if the requested access item is either missing or deleted. + example: true \ No newline at end of file diff --git a/static/api-specs/idn/beta/schemas/Account.yaml b/static/api-specs/idn/beta/schemas/Account.yaml index 736867a92..effb69b02 100644 --- a/static/api-specs/idn/beta/schemas/Account.yaml +++ b/static/api-specs/idn/beta/schemas/Account.yaml @@ -1,5 +1,5 @@ allOf: - - $ref: './BaseCommonDto.yaml' + - $ref: "./BaseCommonDto.yaml" - type: object required: - sourceId @@ -77,4 +77,23 @@ allOf: hasEntitlements: type: boolean description: Indicates if the account has entitlements - example: true \ No newline at end of file + example: true + identity: + $ref: './BaseReferenceDto.yaml' + description: The identity this account is correlated to + example: + id: "2c918084660f45d6016617daa9210584" + type: "IDENTITY" + name: "Adam Kennedy" + sourceOwner: + $ref: './BaseReferenceDto.yaml' + description: The owner of the source this account belongs to + example: + id: "4c5c8534e99445de98eef6c75e25eb01" + type: "IDENTITY" + name: "SailPoint Support" + features: + type: string + description: A string list containing the owning source's features + example: 'ENABLE' + nullable: true diff --git a/static/api-specs/idn/beta/schemas/AuthProfile.yaml b/static/api-specs/idn/beta/schemas/AuthProfile.yaml new file mode 100644 index 000000000..d308667cd --- /dev/null +++ b/static/api-specs/idn/beta/schemas/AuthProfile.yaml @@ -0,0 +1,38 @@ +type: object +properties: + name: + type: string + description: Authentication Profile name. + example: EndToEnd-Profile + offNetwork: + type: boolean + description: Use it to block access from off network. + default: false + example: true + untrustedGeography: + type: boolean + description: Use it to block access from untrusted geoographies. + default: false + example: true + applicationId: + type: string + description: Application ID. + example: 2c91808458ae7a4f0158b1bbf8af0628 + applicationName: + type: string + description: Application name. + example: EndToEnd-Source + type: + type: string + enum: + - BLOCK + - MFA + - NON_PTA + - PTA + description: Type of the Authentication Profile. + example: PTA + strongAuthLogin: + type: boolean + description: Use it to enable strong authentication. + default: false + example: true diff --git a/static/api-specs/idn/beta/schemas/AuthProfileRequest.yaml b/static/api-specs/idn/beta/schemas/AuthProfileRequest.yaml new file mode 100644 index 000000000..d308667cd --- /dev/null +++ b/static/api-specs/idn/beta/schemas/AuthProfileRequest.yaml @@ -0,0 +1,38 @@ +type: object +properties: + name: + type: string + description: Authentication Profile name. + example: EndToEnd-Profile + offNetwork: + type: boolean + description: Use it to block access from off network. + default: false + example: true + untrustedGeography: + type: boolean + description: Use it to block access from untrusted geoographies. + default: false + example: true + applicationId: + type: string + description: Application ID. + example: 2c91808458ae7a4f0158b1bbf8af0628 + applicationName: + type: string + description: Application name. + example: EndToEnd-Source + type: + type: string + enum: + - BLOCK + - MFA + - NON_PTA + - PTA + description: Type of the Authentication Profile. + example: PTA + strongAuthLogin: + type: boolean + description: Use it to enable strong authentication. + default: false + example: true diff --git a/static/api-specs/idn/beta/schemas/AuthProfileSummary.yaml b/static/api-specs/idn/beta/schemas/AuthProfileSummary.yaml new file mode 100644 index 000000000..b180db3b2 --- /dev/null +++ b/static/api-specs/idn/beta/schemas/AuthProfileSummary.yaml @@ -0,0 +1,11 @@ +type: object +properties: + tenant: + type: string + description: Tenant name. + example: "test-tenant" + id: + type: string + description: Identity ID. + example: 2c91808458ae7a4f0158b1bbf8af0628 + diff --git a/static/api-specs/idn/beta/schemas/CampaignReportsConfig.yaml b/static/api-specs/idn/beta/schemas/CampaignReportsConfig.yaml index 7ccf8c4a5..a367aec62 100644 --- a/static/api-specs/idn/beta/schemas/CampaignReportsConfig.yaml +++ b/static/api-specs/idn/beta/schemas/CampaignReportsConfig.yaml @@ -3,6 +3,7 @@ title: Campaign Reports Configuration properties: identityAttributeColumns: type: array + nullable: true description: list of identity attribute columns items: type: string diff --git a/static/api-specs/idn/beta/schemas/CancelableAccountActivity.yaml b/static/api-specs/idn/beta/schemas/CancelableAccountActivity.yaml index a522fe48f..3c0781a78 100644 --- a/static/api-specs/idn/beta/schemas/CancelableAccountActivity.yaml +++ b/static/api-specs/idn/beta/schemas/CancelableAccountActivity.yaml @@ -13,16 +13,19 @@ properties: example: '2017-07-11T18:45:37.098Z' modified: type: string + nullable: true format: 'date-time' example: '2018-06-25T20:22:28.104Z' completed: type: string + nullable: true format: 'date-time' example: '2018-10-19T13:49:37.385Z' completionStatus: $ref: '../../v3/schemas/CompletionStatus.yaml' type: type: string + nullable: true example: appRequest requesterIdentitySummary: $ref: '../../v3/schemas/IdentitySummary.yaml' @@ -30,22 +33,26 @@ properties: $ref: '../../v3/schemas/IdentitySummary.yaml' errors: type: array + nullable: true 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: type: array + nullable: true items: type: string example: null items: type: array + nullable: true items: $ref: '../../v3/schemas/AccountActivityItem.yaml' executionStatus: $ref: '../../v3/schemas/ExecutionStatus.yaml' clientMetadata: type: object + nullable: true additionalProperties: type: string description: >- diff --git a/static/api-specs/idn/beta/schemas/CommonAccessItemAccess.yaml b/static/api-specs/idn/beta/schemas/CommonAccessItemAccess.yaml index c82486bce..e5b9c13dc 100644 --- a/static/api-specs/idn/beta/schemas/CommonAccessItemAccess.yaml +++ b/static/api-specs/idn/beta/schemas/CommonAccessItemAccess.yaml @@ -12,6 +12,7 @@ properties: description: type: string description: Common access description + nullable: true ownerName: type: string description: Common access owner name diff --git a/static/api-specs/idn/beta/schemas/CommonAccessResponse.yaml b/static/api-specs/idn/beta/schemas/CommonAccessResponse.yaml index 2d95849dd..561351068 100644 --- a/static/api-specs/idn/beta/schemas/CommonAccessResponse.yaml +++ b/static/api-specs/idn/beta/schemas/CommonAccessResponse.yaml @@ -1,5 +1,9 @@ type : object properties: + id: + type: string + description: Unique ID of the common access item + example: 555ab47a-0d32-4813-906f-adf3567de6a4 access: $ref: './CommonAccessItemAccess.yaml' description: common access item @@ -17,3 +21,8 @@ properties: type: string readOnly: true format: date-time + nullable: true + createdByUser: + type: boolean + default: false + example: false diff --git a/static/api-specs/idn/beta/schemas/CompletedApproval.yaml b/static/api-specs/idn/beta/schemas/CompletedApproval.yaml index 421dd317a..7e631f081 100644 --- a/static/api-specs/idn/beta/schemas/CompletedApproval.yaml +++ b/static/api-specs/idn/beta/schemas/CompletedApproval.yaml @@ -29,7 +29,12 @@ properties: requester: $ref: './AccessItemRequesterDto.yaml' requestedFor: - $ref: './AccessItemRequestedForDto.yaml' + type: array + description: Identities access was requested for. + items: + $ref: './AccessItemRequestedForDto.yaml' + minItems: 1 + maxItems: 10 reviewedBy: type: object description: Identity who reviewed the access item request. @@ -74,6 +79,7 @@ properties: description: The history of approval forward action. commentRequiredWhenRejected: type: boolean + default: false example: true description: When true the rejector has to provide comments when rejecting state: @@ -87,6 +93,7 @@ properties: example: '2020-07-11T00:00:00Z' removeDateUpdateRequested: type: boolean + default: false example: true description: If true, then the request was to change the remove date or sunset date. currentRemoveDate: @@ -97,4 +104,37 @@ properties: example: '2020-07-11T00:00:00Z' sodViolationContext: $ref: './SodViolationContextCheckCompleted.yaml' - description: The details of the SOD violations for the associated approval. \ No newline at end of file + description: The details of the SOD violations for the associated approval. + preApprovalTriggerResult: + nullable: true + type: object + description: If the access request submitted event trigger is configured and this access request was intercepted by it, then this is the result of the trigger's decision to either approve or deny the request. + properties: + comment: + type: string + description: The comment from the trigger + example: This request was autoapproved by our automated ETS subscriber + decision: + $ref: './CompletedApprovalState.yaml' + description: The approval decision of the trigger + reviewer: + type: string + description: The name of the approver + example: Automated AR Approval + date: + type: string + format: date-time + example: '2022-06-07T19:18:40.748Z' + description: The date and time the trigger decided on the request + clientMetadata: + type: object + additionalProperties: + type: string + description: >- + Arbitrary key-value pairs provided during the request. + example: + requestedAppName: test-app + requestedAppId: 2c91808f7892918f0178b78da4a305a1 + requestedAccounts: + type: string + nullable: true \ No newline at end of file diff --git a/static/api-specs/idn/beta/schemas/Entitlement.yaml b/static/api-specs/idn/beta/schemas/Entitlement.yaml index b3bd7165d..0c415dd95 100644 --- a/static/api-specs/idn/beta/schemas/Entitlement.yaml +++ b/static/api-specs/idn/beta/schemas/Entitlement.yaml @@ -22,6 +22,7 @@ properties: type: string description: The entitlement attribute name example: "memberOf" + nullable: true value: type: string description: The value of the entitlement @@ -42,6 +43,7 @@ properties: example: true description: type: string + nullable: true description: The description of the entitlement example: "CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local" requestable: @@ -69,8 +71,11 @@ properties: type: string description: The source name example: ODS-AD-Source + nullable: true owner: - $ref: '../schemas/gov-entitlement/OwnerReferenceDto.yaml' + allOf: + - $ref: '../schemas/gov-entitlement/OwnerReferenceDto.yaml' + - nullable: true directPermissions: type: array items: @@ -86,14 +91,16 @@ properties: "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ] manuallyUpdatedFields: - description: >- - Object contains entitlement manually updated fields. - Field value is true if is was updated manually via entitlement import csv or patch endpoint. - Field value is false if that property value has not been changed after first entitlement aggregation. - Values for all manually updatable fields must be specified. - For now only two entitlement fields support this: DISPLAY_NAME and DESCRIPTION. - example: { - "DISPLAY_NAME": true, - "DESCRIPTION": true - } - $ref: '../schemas/gov-entitlement/ManuallyUpdatedFieldsDTO.yaml' + allOf: + - $ref: '../schemas/gov-entitlement/ManuallyUpdatedFieldsDTO.yaml' + - nullable: true + description: >- + Object contains entitlement manually updated fields. + Field value is true if is was updated manually via entitlement import csv or patch endpoint. + Field value is false if that property value has not been changed after first entitlement aggregation. + Values for all manually updatable fields must be specified. + For now only two entitlement fields support this: DISPLAY_NAME and DESCRIPTION. + example: { + "DISPLAY_NAME": true, + "DESCRIPTION": true + } diff --git a/static/api-specs/idn/beta/schemas/FullAccount.yaml b/static/api-specs/idn/beta/schemas/FullAccount.yaml index 9e433043a..c50737cc3 100644 --- a/static/api-specs/idn/beta/schemas/FullAccount.yaml +++ b/static/api-specs/idn/beta/schemas/FullAccount.yaml @@ -20,5 +20,6 @@ allOf: example: false features: type: string + nullable: true description: A string list containing the owning source's features example: 'ENABLE' diff --git a/static/api-specs/idn/beta/schemas/GetPersonalAccessTokenResponse.yaml b/static/api-specs/idn/beta/schemas/GetPersonalAccessTokenResponse.yaml index 5c75203dc..78515cbf6 100644 --- a/static/api-specs/idn/beta/schemas/GetPersonalAccessTokenResponse.yaml +++ b/static/api-specs/idn/beta/schemas/GetPersonalAccessTokenResponse.yaml @@ -29,6 +29,11 @@ properties: format: 'date-time' description: The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed. example: '2017-07-11T18:45:37.098Z' + managed: + type: boolean + default: false + example: false + description: If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows. required: - id - name diff --git a/static/api-specs/idn/beta/schemas/Identity.yaml b/static/api-specs/idn/beta/schemas/Identity.yaml index 0ff125736..8bd2c3d55 100644 --- a/static/api-specs/idn/beta/schemas/Identity.yaml +++ b/static/api-specs/idn/beta/schemas/Identity.yaml @@ -12,6 +12,7 @@ allOf: type: string description: The email address of the identity example: 'sender@example.com' + nullable: true processingState: type: string nullable: true @@ -19,6 +20,7 @@ allOf: enum: - ERROR - OK + - null example: ERROR identityStatus: type: string @@ -38,6 +40,7 @@ allOf: managerRef: type: object description: Identity's manager. + nullable: true properties: type: type: string @@ -68,5 +71,7 @@ allOf: description: A map with the identity attributes for the identity example: '{"uid":"Walter White","firstname":"walter","cloudStatus":"UNREGISTERED","displayName":"Walter White","identificationNumber":"942","lastSyncDate":1470348809380,"email":"walter@gmail.com","lastname":"white"}' lifecycleState: - $ref: '../../v3/schemas/LifecycleStateDto.yaml' - description: Lifecycle state details that include lifecycle state name and whether this lifecycle state has been set manually + allOf: + - $ref: '../../v3/schemas/LifecycleStateDto.yaml' + - nullable: true + description: Lifecycle state details that include lifecycle state name and whether this lifecycle state has been set manually diff --git a/static/api-specs/idn/beta/schemas/License.yaml b/static/api-specs/idn/beta/schemas/License.yaml new file mode 100644 index 000000000..608be5bf0 --- /dev/null +++ b/static/api-specs/idn/beta/schemas/License.yaml @@ -0,0 +1,10 @@ +type: object +properties: + licenseId: + type: string + description: Name of the license + example: 'idn:access-request' + legacyFeatureName: + type: string + description: Legacy name of the license + example: ACCESS_REQUEST diff --git a/static/api-specs/idn/beta/schemas/ManagedCluster.yaml b/static/api-specs/idn/beta/schemas/ManagedCluster.yaml index 6c77cef96..7b538e28c 100644 --- a/static/api-specs/idn/beta/schemas/ManagedCluster.yaml +++ b/static/api-specs/idn/beta/schemas/ManagedCluster.yaml @@ -112,3 +112,15 @@ properties: type: string default: "0" example: "1533" + createdAt: + description: The date/time this cluster was created + example: '2023-08-04T20:48:01.865Z' + nullable: true + type: string + format: date-time + updatedAt: + description: The date/time this cluster was last updated + example: '2023-08-04T20:48:01.865Z' + nullable: true + type: string + format: date-time \ No newline at end of file diff --git a/static/api-specs/idn/beta/schemas/NotificationTemplateContext.yaml b/static/api-specs/idn/beta/schemas/NotificationTemplateContext.yaml index e04a0adee..cff1ad61b 100644 --- a/static/api-specs/idn/beta/schemas/NotificationTemplateContext.yaml +++ b/static/api-specs/idn/beta/schemas/NotificationTemplateContext.yaml @@ -2,6 +2,7 @@ type: object properties: attributes: type: object + additionalProperties: true description: A JSON object that stores the context. example: {"productUrl":"https://test-org.identitysoon.com","brandingConfigs":{"default":{"narrowLogoURL":null,"productName":"SailPoint","standardLogoURL":null,"navigationColor":"011E64","actionButtonColor":"20B2DE","emailFromAddress":null,"activeLinkColor":"20B2DE","loginInformationalMessage":null}}} created: diff --git a/static/api-specs/idn/beta/schemas/Outlier.yaml b/static/api-specs/idn/beta/schemas/Outlier.yaml index e568ba9df..a711be1bf 100644 --- a/static/api-specs/idn/beta/schemas/Outlier.yaml +++ b/static/api-specs/idn/beta/schemas/Outlier.yaml @@ -48,15 +48,19 @@ properties: enum: - MANUAL - AUTOMATIC + - null description: Enum value of if the outlier manually or automatically un-ignored. Will be NULL if outlier is not ignored example: MANUAL + nullable: true unignoreDate: type: string format: date-time description: shows date when last time has been unignored outlier example: "2021-06-01T18:40:35.772Z" + nullable: true ignoreDate: type: string format: date-time description: shows date when last time has been ignored outlier - example: "2021-06-01T18:40:35.772Z" \ No newline at end of file + example: "2021-06-01T18:40:35.772Z" + nullable: true \ No newline at end of file diff --git a/static/api-specs/idn/beta/schemas/OutlierSummary.yaml b/static/api-specs/idn/beta/schemas/OutlierSummary.yaml index 1daf721b1..67d06a164 100644 --- a/static/api-specs/idn/beta/schemas/OutlierSummary.yaml +++ b/static/api-specs/idn/beta/schemas/OutlierSummary.yaml @@ -20,5 +20,7 @@ properties: type: integer description: Total number of identities for the customer making the request example: 5000 - - + totalIgnored: + type: integer + default: 0 + example: 0 \ No newline at end of file diff --git a/static/api-specs/idn/beta/schemas/PendingApproval.yaml b/static/api-specs/idn/beta/schemas/PendingApproval.yaml index aa3ab9344..ccf67017a 100644 --- a/static/api-specs/idn/beta/schemas/PendingApproval.yaml +++ b/static/api-specs/idn/beta/schemas/PendingApproval.yaml @@ -29,7 +29,12 @@ properties: requester: $ref: './AccessItemRequesterDto.yaml' requestedFor: - $ref: './AccessItemRequestedForDto.yaml' + type: array + description: Identities access was requested for. + items: + $ref: './AccessItemRequestedForDto.yaml' + minItems: 1 + maxItems: 10 owner: $ref: './AccessItemOwnerDto.yaml' requestedObject: @@ -50,6 +55,7 @@ properties: description: The history of approval forward action. commentRequiredWhenRejected: type: boolean + default: false example: true description: When true the rejector has to provide comments when rejecting actionInProcess: @@ -62,6 +68,7 @@ properties: example: '2020-07-11T00:00:00Z' removeDateUpdateRequested: type: boolean + default: false example: true description: If true, then the request is to change the remove date or sunset date. currentRemoveDate: diff --git a/static/api-specs/idn/beta/schemas/Product.yaml b/static/api-specs/idn/beta/schemas/Product.yaml new file mode 100644 index 000000000..60072cb98 --- /dev/null +++ b/static/api-specs/idn/beta/schemas/Product.yaml @@ -0,0 +1,88 @@ +type: object +properties: + productName: + type: string + description: Name of the Product + example: idn + url: + type: string + description: URL of the Product + example: 'https://tenant-name.identitynow.com' + productTenantId: + type: string + description: An identifier for a specific product-tenant combination + example: tenant#product + productRegion: + type: string + description: Product region + example: us-east-1 + productRight: + type: string + description: Right needed for the Product + example: 'idn:ui:view' + apiUrl: + nullable: true + type: string + description: API URL of the Product + example: 'https://tenant-name.api.identitynow.com' + licenses: + type: array + items: + $ref: './License.yaml' + attributes: + type: object + additionalProperties: true + description: Additional attributes for a product + example: { + domain: 'https://tenant-name.identitynow.com', + maxRegisteredUsers: 250 + } + zone: + type: string + description: Zone + example: Deployment zone for the Product + status: + type: string + description: Status of the product + example: active + statusDateTime: + type: string + format: date-time + description: Status datetime + example: '2020-05-19T13:49:37.385Z' + reason: + type: string + description: If there's a tenant provisioning failure then reason will have the description of error + example: Reason + notes: + type: string + description: Product could have additional notes added during tenant provisioning. + example: Example notes + dateCreated: + nullable: true + type: string + format: date-time + description: Date when the product was created + example: '2020-05-19T13:49:37.385Z' + lastUpdated: + nullable: true + type: string + format: date-time + description: Date when the product was last updated + example: '2020-05-19T13:49:37.385Z' + orgType: + nullable: true + type: string + enum: + - development + - staging + - production + - test + - partner + - training + - demonstration + - sandbox + - null + description: Type of org + example: test + diff --git a/static/api-specs/idn/beta/schemas/ProvisioningConfig.yaml b/static/api-specs/idn/beta/schemas/ProvisioningConfig.yaml index 2dbd37a69..4bb511483 100644 --- a/static/api-specs/idn/beta/schemas/ProvisioningConfig.yaml +++ b/static/api-specs/idn/beta/schemas/ProvisioningConfig.yaml @@ -5,6 +5,7 @@ properties: description: Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed. type: boolean readOnly: true + default: false example: true managedResourceRefs: description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. @@ -43,6 +44,7 @@ properties: noProvisioningRequests: description: Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. type: boolean + default: false example: true provisioningRequestExpiration: description: When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation. diff --git a/static/api-specs/idn/beta/schemas/PublicIdentityConfig.yaml b/static/api-specs/idn/beta/schemas/PublicIdentityConfig.yaml index ce30db549..bea08ab8e 100644 --- a/static/api-specs/idn/beta/schemas/PublicIdentityConfig.yaml +++ b/static/api-specs/idn/beta/schemas/PublicIdentityConfig.yaml @@ -13,3 +13,4 @@ properties: description: "the date/time of the modification" format: 'date-time' example: '2018-06-25T20:22:28.104Z' + nullable: true diff --git a/static/api-specs/idn/beta/schemas/ServiceDeskIntegrationDto.yaml b/static/api-specs/idn/beta/schemas/ServiceDeskIntegrationDto.yaml index ecf7bb9c1..85ef46073 100644 --- a/static/api-specs/idn/beta/schemas/ServiceDeskIntegrationDto.yaml +++ b/static/api-specs/idn/beta/schemas/ServiceDeskIntegrationDto.yaml @@ -1,19 +1,23 @@ allOf: - - $ref: './BaseCommonDto.yaml' - type: object - description: Specification of a Service Desk integration. + description: Service Desk integration's specification. required: + - name - description - type - attributes properties: + name: + description: Service Desk integration's name. The name must be unique. + type: string + example: Service Desk Integration Name description: - description: Description of the Service Desk integration. + description: Service Desk integration's description. type: string example: A very nice Service Desk integration type: description: | - Service Desk integration types + Service Desk integration types: - ServiceNowSDIM - ServiceNow @@ -27,7 +31,7 @@ allOf: allOf: - $ref: '../../v3/schemas/SourceClusterDto.yaml' cluster: - description: ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility). + description: Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility). type: string example: xyzzy999 deprecated: true @@ -44,7 +48,7 @@ allOf: description: The 'provisioningConfig' property specifies the configuration used to provision integrations. $ref: './ProvisioningConfig.yaml' attributes: - description: Attributes of the Service Desk integration. Validation constraints enforced by the implementation. + description: Service Desk integration's attributes. Validation constraints enforced by the implementation. type: object additionalProperties: true example: { diff --git a/static/api-specs/idn/beta/schemas/SlimAccount.yaml b/static/api-specs/idn/beta/schemas/SlimAccount.yaml index cfdc5c182..abd9e8b48 100644 --- a/static/api-specs/idn/beta/schemas/SlimAccount.yaml +++ b/static/api-specs/idn/beta/schemas/SlimAccount.yaml @@ -7,7 +7,6 @@ allOf: properties: uuid: type: string - format: uuid description: Unique ID from the owning source example: '2c9180857893f12901789445619b0366' nullable: true diff --git a/static/api-specs/idn/beta/schemas/SodExemptCriteria.yaml b/static/api-specs/idn/beta/schemas/SodExemptCriteria.yaml index a30028579..cc7d71991 100644 --- a/static/api-specs/idn/beta/schemas/SodExemptCriteria.yaml +++ b/static/api-specs/idn/beta/schemas/SodExemptCriteria.yaml @@ -3,6 +3,7 @@ type: object properties: existing: type: boolean + default: false example: true description: If the entitlement already belonged to the user or not. type: diff --git a/static/api-specs/idn/beta/schemas/Source.yaml b/static/api-specs/idn/beta/schemas/Source.yaml index 50ef86c74..4dc20414f 100644 --- a/static/api-specs/idn/beta/schemas/Source.yaml +++ b/static/api-specs/idn/beta/schemas/Source.yaml @@ -293,7 +293,17 @@ properties: type: string description: The connector implementation id example: "delimited-file" + created: + type: string + description: The date-time when the source was created + format: date-time + example: 2022-02-08T14:50:03.827Z + modified: + type: string + description: The date-time when the source was last modified + format: date-time + example: 2024-01-23T18:08:50.897Z required: - name - owner - - connector \ No newline at end of file + - connector diff --git a/static/api-specs/idn/beta/schemas/TemplateDtoDefault.yaml b/static/api-specs/idn/beta/schemas/TemplateDtoDefault.yaml index 89ee414b7..41ae8c205 100644 --- a/static/api-specs/idn/beta/schemas/TemplateDtoDefault.yaml +++ b/static/api-specs/idn/beta/schemas/TemplateDtoDefault.yaml @@ -28,6 +28,7 @@ properties: "You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}." description: The subject of the default template + nullable: true header: type: string nullable: true @@ -48,12 +49,16 @@ properties: type: string example: "$__global.emailFromAddress" description: The "From:" address of the default template + nullable: true replyTo: type: string example: "$__global.emailFromAddress" description: The "Reply To" field of the default template + nullable: true description: type: string example: "Daily digest - sent if number of outstanding tasks for task owner > 0" description: The description of the default template + nullable: true + diff --git a/static/api-specs/idn/beta/schemas/Tenant.yaml b/static/api-specs/idn/beta/schemas/Tenant.yaml new file mode 100644 index 000000000..ea939ca0b --- /dev/null +++ b/static/api-specs/idn/beta/schemas/Tenant.yaml @@ -0,0 +1,31 @@ +type: object +properties: + id: + type: string + readOnly: true + description: The unique identifier for the Tenant + example: "2c91808568c529c60168cca6f90c1324" + name: + type: string + description: Abbreviated name of the Tenant + example: acme + fullName: + type: string + description: Human-readable name of the Tenant + example: Acme, Inc + pod: + type: string + description: Deployment pod for the Tenant + example: example-pod + region: + type: string + description: Deployment region for the Tenant + example: us-east-1 + description: + type: string + description: Description of the Tenant + example: Description of the Tenant + products: + type: array + items: + $ref: './Product.yaml' diff --git a/static/api-specs/idn/beta/schemas/TranslationMessage.yaml b/static/api-specs/idn/beta/schemas/TranslationMessage.yaml index 5726e81aa..9159ebd88 100644 --- a/static/api-specs/idn/beta/schemas/TranslationMessage.yaml +++ b/static/api-specs/idn/beta/schemas/TranslationMessage.yaml @@ -1,3 +1,4 @@ +type: object properties: key: type: string diff --git a/static/api-specs/idn/beta/schemas/forms/CreateFormInstanceRequest.yaml b/static/api-specs/idn/beta/schemas/forms/CreateFormInstanceRequest.yaml index 6ae8835d2..4832e2dc4 100644 --- a/static/api-specs/idn/beta/schemas/forms/CreateFormInstanceRequest.yaml +++ b/static/api-specs/idn/beta/schemas/forms/CreateFormInstanceRequest.yaml @@ -12,7 +12,7 @@ properties: type: string x-go-name: FormDefinitionID formInput: - additionalProperties: { } + additionalProperties: true description: FormInput is an object of form input labels to value example: input1: Sales diff --git a/static/api-specs/idn/beta/schemas/trigger/example-input/AccessRequestDynamicApprover.yaml b/static/api-specs/idn/beta/schemas/trigger/example-input/AccessRequestDynamicApprover.yaml index cc60655a3..68ba1a49b 100644 --- a/static/api-specs/idn/beta/schemas/trigger/example-input/AccessRequestDynamicApprover.yaml +++ b/static/api-specs/idn/beta/schemas/trigger/example-input/AccessRequestDynamicApprover.yaml @@ -12,8 +12,12 @@ properties: The unique ID of the access request object. Can be used with the [access request status endpoint](https://developer.sailpoint.com/idn/api/beta/list-access-request-status) to get the status of the request. example: 4b4d982dddff4267ab12f0f1e72b5a6d requestedFor: - allOf: - - $ref: './AccessItemRequestedForDto.yaml' + type: array + description: Identities access was requested for. + items: + $ref: './AccessItemRequestedForDto.yaml' + minItems: 1 + maxItems: 10 requestedItems: description: The access items that are being requested. type: array @@ -56,6 +60,8 @@ properties: type: string description: A comment from the requestor on why the access is needed. example: William needs this access for his day to day job activities. + minItems: 1 + maxItems: 25 requestedBy: allOf: - $ref: './AccessItemRequesterDto.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/beta/schemas/trigger/example-input/AccessRequestPostApproval.yaml b/static/api-specs/idn/beta/schemas/trigger/example-input/AccessRequestPostApproval.yaml index 92653ff51..f4e554577 100644 --- a/static/api-specs/idn/beta/schemas/trigger/example-input/AccessRequestPostApproval.yaml +++ b/static/api-specs/idn/beta/schemas/trigger/example-input/AccessRequestPostApproval.yaml @@ -15,8 +15,12 @@ properties: - id - type - name - allOf: - - $ref: './AccessItemRequestedForDto.yaml' + type: array + description: Identities access was requested for. + items: + $ref: './AccessItemRequestedForDto.yaml' + minItems: 1 + maxItems: 10 requestedItemsStatus: description: Details on the outcome of each access item. type: array diff --git a/static/api-specs/idn/beta/schemas/trigger/example-input/AccessRequestPreApproval.yaml b/static/api-specs/idn/beta/schemas/trigger/example-input/AccessRequestPreApproval.yaml index 08cf398d9..164568f5e 100644 --- a/static/api-specs/idn/beta/schemas/trigger/example-input/AccessRequestPreApproval.yaml +++ b/static/api-specs/idn/beta/schemas/trigger/example-input/AccessRequestPreApproval.yaml @@ -15,8 +15,12 @@ properties: - id - type - name - allOf: - - $ref: './AccessItemRequestedForDto.yaml' + type: array + description: Identities access was requested for. + items: + $ref: './AccessItemRequestedForDto.yaml' + minItems: 1 + maxItems: 10 requestedItems: description: Details of the access items being requested. type: array @@ -59,6 +63,8 @@ properties: type: string description: A comment from the identity requesting the access. example: William needs this access to do his job. + minItems: 1 + maxItems: 25 requestedBy: required: - id diff --git a/static/api-specs/idn/beta/schemas/trigger/example-input/SourceAccount.yaml b/static/api-specs/idn/beta/schemas/trigger/example-input/SourceAccount.yaml deleted file mode 100644 index 69a96b742..000000000 --- a/static/api-specs/idn/beta/schemas/trigger/example-input/SourceAccount.yaml +++ /dev/null @@ -1,55 +0,0 @@ -type: object -required: -- id -- nativeIdentifier -- sourceId -- sourceName -- identityId -- identityName -- attributes -properties: - uuid: - type: string - description: Source unique identifier for the identity. UUID is generated by the source system. - example: 'b7264868-7201-415f-9118-b581d431c688' - id: - type: string - description: SailPoint generated unique identifier. - example: ee769173319b41d19ccec35ba52f237b - nativeIdentifier: - type: string - description: Unique ID of the account on the source. - example: E009 - sourceId: - type: string - description: The ID of the source. - example: 2c918082814e693601816e09471b29b6 - sourceName: - type: string - description: The name of the source. - example: Active Directory - identityId: - type: string - description: The ID of the identity that is correlated with this account. - example: ee769173319b41d19ccec6c235423237b - identityName: - type: string - description: The name of the identity that is correlated with this account. - example: john.doe - attributes: - type: object - additionalProperties: true - description: The attributes of the account. The contents of attributes depends on the account schema for the source. - example: { - "firstname": "John", - "lastname": "Doe", - "email": "john.doe@gmail.com", - "department": "Sales", - "displayName": "John Doe", - "created": "2020-04-27T16:48:33.597Z", - "employeeNumber": "E009", - "uid": "E009", - "inactive": "true", - "phone": null, - "identificationNumber": "E009" - } \ No newline at end of file diff --git a/static/api-specs/idn/beta/schemas/trigger/example-input/SourceAccountCreated.yaml b/static/api-specs/idn/beta/schemas/trigger/example-input/SourceAccountCreated.yaml index 1d8fea140..a46487a5c 100644 --- a/static/api-specs/idn/beta/schemas/trigger/example-input/SourceAccountCreated.yaml +++ b/static/api-specs/idn/beta/schemas/trigger/example-input/SourceAccountCreated.yaml @@ -1,2 +1,56 @@ title: Source Account Created -$ref: './SourceAccount.yaml' \ No newline at end of file +type: object +required: +- id +- nativeIdentifier +- sourceId +- sourceName +- identityId +- identityName +- attributes +properties: + uuid: + type: string + description: Source unique identifier for the identity. UUID is generated by the source system. + example: 'b7264868-7201-415f-9118-b581d431c688' + id: + type: string + description: SailPoint generated unique identifier. + example: ee769173319b41d19ccec35ba52f237b + nativeIdentifier: + type: string + description: Unique ID of the account on the source. + example: E009 + sourceId: + type: string + description: The ID of the source. + example: 2c918082814e693601816e09471b29b6 + sourceName: + type: string + description: The name of the source. + example: Active Directory + identityId: + type: string + description: The ID of the identity that is correlated with this account. + example: ee769173319b41d19ccec6c235423237b + identityName: + type: string + description: The name of the identity that is correlated with this account. + example: john.doe + attributes: + type: object + additionalProperties: true + description: The attributes of the account. The contents of attributes depends on the account schema for the source. + example: { + "firstname": "John", + "lastname": "Doe", + "email": "john.doe@gmail.com", + "department": "Sales", + "displayName": "John Doe", + "created": "2020-04-27T16:48:33.597Z", + "employeeNumber": "E009", + "uid": "E009", + "inactive": "true", + "phone": null, + "identificationNumber": "E009" + } \ No newline at end of file diff --git a/static/api-specs/idn/beta/schemas/trigger/example-input/SourceAccountDeleted.yaml b/static/api-specs/idn/beta/schemas/trigger/example-input/SourceAccountDeleted.yaml index a834a8f15..bb836017b 100644 --- a/static/api-specs/idn/beta/schemas/trigger/example-input/SourceAccountDeleted.yaml +++ b/static/api-specs/idn/beta/schemas/trigger/example-input/SourceAccountDeleted.yaml @@ -1,2 +1,56 @@ title: Source Account Deleted -$ref: './SourceAccount.yaml' \ No newline at end of file +type: object +required: +- id +- nativeIdentifier +- sourceId +- sourceName +- identityId +- identityName +- attributes +properties: + uuid: + type: string + description: Source unique identifier for the identity. UUID is generated by the source system. + example: 'b7264868-7201-415f-9118-b581d431c688' + id: + type: string + description: SailPoint generated unique identifier. + example: ee769173319b41d19ccec35ba52f237b + nativeIdentifier: + type: string + description: Unique ID of the account on the source. + example: E009 + sourceId: + type: string + description: The ID of the source. + example: 2c918082814e693601816e09471b29b6 + sourceName: + type: string + description: The name of the source. + example: Active Directory + identityId: + type: string + description: The ID of the identity that is correlated with this account. + example: ee769173319b41d19ccec6c235423237b + identityName: + type: string + description: The name of the identity that is correlated with this account. + example: john.doe + attributes: + type: object + additionalProperties: true + description: The attributes of the account. The contents of attributes depends on the account schema for the source. + example: { + "firstname": "John", + "lastname": "Doe", + "email": "john.doe@gmail.com", + "department": "Sales", + "displayName": "John Doe", + "created": "2020-04-27T16:48:33.597Z", + "employeeNumber": "E009", + "uid": "E009", + "inactive": "true", + "phone": null, + "identificationNumber": "E009" + } \ No newline at end of file diff --git a/static/api-specs/idn/beta/schemas/trigger/example-input/SourceAccountUpdated.yaml b/static/api-specs/idn/beta/schemas/trigger/example-input/SourceAccountUpdated.yaml index 62080ebb3..96f3a5ffa 100644 --- a/static/api-specs/idn/beta/schemas/trigger/example-input/SourceAccountUpdated.yaml +++ b/static/api-specs/idn/beta/schemas/trigger/example-input/SourceAccountUpdated.yaml @@ -1,2 +1,56 @@ title: Source Account Updated -$ref: './SourceAccount.yaml' \ No newline at end of file +type: object +required: +- id +- nativeIdentifier +- sourceId +- sourceName +- identityId +- identityName +- attributes +properties: + uuid: + type: string + description: Source unique identifier for the identity. UUID is generated by the source system. + example: 'b7264868-7201-415f-9118-b581d431c688' + id: + type: string + description: SailPoint generated unique identifier. + example: ee769173319b41d19ccec35ba52f237b + nativeIdentifier: + type: string + description: Unique ID of the account on the source. + example: E009 + sourceId: + type: string + description: The ID of the source. + example: 2c918082814e693601816e09471b29b6 + sourceName: + type: string + description: The name of the source. + example: Active Directory + identityId: + type: string + description: The ID of the identity that is correlated with this account. + example: ee769173319b41d19ccec6c235423237b + identityName: + type: string + description: The name of the identity that is correlated with this account. + example: john.doe + attributes: + type: object + additionalProperties: true + description: The attributes of the account. The contents of attributes depends on the account schema for the source. + example: { + "firstname": "John", + "lastname": "Doe", + "email": "john.doe@gmail.com", + "department": "Sales", + "displayName": "John Doe", + "created": "2020-04-27T16:48:33.597Z", + "employeeNumber": "E009", + "uid": "E009", + "inactive": "true", + "phone": null, + "identificationNumber": "E009" + } \ No newline at end of file diff --git a/static/api-specs/idn/beta/schemas/work-reassignment/ConfigType.yaml b/static/api-specs/idn/beta/schemas/work-reassignment/ConfigType.yaml index f761cb53d..ed9ec482d 100644 --- a/static/api-specs/idn/beta/schemas/work-reassignment/ConfigType.yaml +++ b/static/api-specs/idn/beta/schemas/work-reassignment/ConfigType.yaml @@ -1,7 +1,12 @@ type: object description: Type of Reassignment Configuration. properties: + priority: + type: integer + example: 1 internalName: + $ref: 'ConfigTypeEnumCamel.yaml' + internalNameCamel: $ref: 'ConfigTypeEnum.yaml' displayName: type: string diff --git a/static/api-specs/idn/beta/schemas/work-reassignment/ConfigTypeEnumCamel.yaml b/static/api-specs/idn/beta/schemas/work-reassignment/ConfigTypeEnumCamel.yaml new file mode 100644 index 000000000..b229943d0 --- /dev/null +++ b/static/api-specs/idn/beta/schemas/work-reassignment/ConfigTypeEnumCamel.yaml @@ -0,0 +1,7 @@ +type: string +description: Enum list of valid work types that can be selected for a Reassignment Configuration +enum: + - accessRequests + - certifications + - manualTasks +example: accessRequests \ No newline at end of file diff --git a/static/api-specs/idn/beta/securitySchemes/OAuth2.yaml b/static/api-specs/idn/beta/securitySchemes/OAuth2.yaml index 562909998..bdb15cb10 100644 --- a/static/api-specs/idn/beta/securitySchemes/OAuth2.yaml +++ b/static/api-specs/idn/beta/securitySchemes/OAuth2.yaml @@ -4,8 +4,8 @@ description: >- [Best Practices: IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) flows: authorizationCode: - authorizationUrl: 'https://tenant.identitynow.com/oauth/authorize' - tokenUrl: 'https://tenant.identitynow.com/oauth/token' + authorizationUrl: 'https://tenant.login.sailpoint.com/oauth/authorize' + tokenUrl: 'https://tenant.api.identitynow.com/oauth/token' scopes: 'idn:task-definition:read': Task Definition read access 'idn:task-definition:write': Task Definition write access diff --git a/static/api-specs/idn/sailpoint-api.beta.yaml b/static/api-specs/idn/sailpoint-api.beta.yaml index 24097d420..661f3f381 100644 --- a/static/api-specs/idn/sailpoint-api.beta.yaml +++ b/static/api-specs/idn/sailpoint-api.beta.yaml @@ -96,6 +96,12 @@ tags: They can use the My Requests tab under Request Center to track and/or cancel the requests. Refer to [Requesting Access](https://documentation.sailpoint.com/saas/user-help/requests/requesting_access.html) for more information about access requests. + - name: Access Request Identity Metrics + description: | + Use this API to implement access request identity metrics functionality. + With this functionality in place, access request reviewers can see relevant details about the requested access item and associated source activity. + This allows reviewers to see how many of the identities who share a manager with the access requester have this same type of access and how many of them have had activity in the related source. + This additional context about whether the access has been granted before and how often it has been used can help those approving access requests make more informed decisions. - name: Account Activities description: | Use this API to implement account activity tracking functionality. @@ -831,7 +837,63 @@ tags: - name: SP-Config description: Import and export configuration for some objects between tenants. - name: Tagged Objects + description: | + Use this API to implement object tagging functionality. + With object tagging functionality in place, any user in an organization can use tags as a way to group objects together and find them more quickly when the user searches IdentityNow. + + In IdentityNow, users can search their tenants for information and add tags objects they find. + Tagging an object provides users with a way of grouping objects together and makes it easier to find these objects in the future. + + For example, if a user is searching for an entitlement that grants a risky level of access to Active Directory, it's possible that the user may have to search through hundreds of entitlements to find the correct one. + Once the user finds that entitlement, the user can add a tag to the entitlement, "AD_RISKY" to make it easier to find the entitlement again. + The user can add the same tag to multiple objects the user wants to group together for an easy future search, and the user can also do so in bulk. + When the user wants to find that tagged entitlement again, the user can search for "tags:AD_RISKY" to find all objects with that tag. + + With the API, you can tag even more different object types than you can in IdentityNow (access profiles, entitlements, identities, and roles). + You can use the API to tag all these objects: + + - Access profiles + + - Applications + + - Certification campaigns + + - Entitlements + + - Identities + + - Roles + + - SOD (separation of duties) policies + + - Sources + + You can also use the API to directly find, create, and manage tagged objects without using search queries. + + There are limits to tags: + + - You can have up to 500 different tags in your tenant. + + - You can apply up to 30 tags to one object. + + - You can have up to 10,000 tag associations, pairings of 1 tag to 1 object, in your tenant. + + Because of these limits, it is recommended that you work with your governance experts and security teams to establish a list of tags that are most expressive of governance objects and access managed by IdentityNow. + + These are the types of information often expressed in tags: + + - Affected departments + + - Compliance and regulatory categories + + - Remediation urgency levels + + - Risk levels + + Refer to [Tagging Items in Search](https://documentation.sailpoint.com/saas/help/search/index.html?h=tags#tagging-items-in-search) for more information about tagging objects in IdentityNow. - name: Task Management + - name: Tenant + description: API for reading tenant details. - name: Transforms description: Operations for creating, managing, and deleting transforms - name: Triggers @@ -934,7 +996,7 @@ components: "sp:scopes:default": "default scope" "sp:scopes:all": "access to all scopes" authorizationCode: - authorizationUrl: https://tenant.identitynow.com/oauth/authorize + authorizationUrl: https://tenant.login.sailpoint.com/oauth/authorize tokenUrl: https://tenant.api.identitynow.com/oauth/token scopes: "sp:scopes:default": "default scope" @@ -1009,6 +1071,8 @@ paths: $ref: './beta/paths/access-profile.yaml' /access-profiles/bulk-delete: $ref: './beta/paths/access-profile-bulk-delete.yaml' + /access-profiles/bulk-update-requestable: + $ref: './beta/paths/access-profile-bulk-update-requestable.yaml' /access-profiles/{id}/entitlements: $ref: './beta/paths/access-profile-entitlements.yaml' /access-requests: @@ -1075,6 +1139,10 @@ paths: $ref: './beta/paths/account-activity.yaml' /account-aggregations/{id}/status: $ref: './beta/paths/account-aggregation-status.yaml' + /auth-profiles: + $ref: './beta/paths/auth-profiles.yaml' + /auth-profiles/{id}: + $ref: './beta/paths/auth-profile.yaml' /campaigns: $ref: './beta/paths/campaigns.yaml' /campaigns/delete: @@ -1411,6 +1479,8 @@ paths: $ref: './beta/paths/role-bulk-delete.yaml' /roles/{id}/assigned-identities: $ref: './beta/paths/role-assigned-identities.yaml' + /roles/{id}/entitlements: + $ref: './beta/paths/role-entitlements.yaml' /segments: $ref: './beta/paths/segments.yaml' /segments/{id}: @@ -1479,10 +1549,10 @@ paths: $ref: './beta/paths/source-synchronize-attributes.yaml' /sources/{id}/entitlement-request-config: $ref: './beta/paths/sources-entitlement-request-config.yaml' - /task-status: - $ref: "./beta/paths/task-status-list.yaml" /task-status/{id}: $ref: "./beta/paths/task-status.yaml" + /task-status: + $ref: "./beta/paths/task-status-list.yaml" /task-status/pending-tasks: $ref: "./beta/paths/task-status-pending.yaml" /tagged-objects: @@ -1495,6 +1565,8 @@ paths: $ref: './beta/paths/bulk-add-tagged-objects.yaml' /tagged-objects/bulk-remove: $ref: './beta/paths/bulk-remove-tagged-objects.yaml' + /tenant: + $ref: './beta/paths/tenant.yaml' /transforms: $ref: './beta/paths/transforms.yaml' /transforms/{id}: @@ -1641,3 +1713,5 @@ paths: $ref: "./beta/paths/source-usages.yaml" /account-usages/{accountId}/summaries: $ref: "./beta/paths/account-usages.yaml" + /access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type}: + $ref: "./beta/paths/access-request-identity-metrics.yaml" diff --git a/static/api-specs/idn/sailpoint-api.cc.yaml b/static/api-specs/idn/sailpoint-api.cc.yaml deleted file mode 100644 index 5c0182c9d..000000000 --- a/static/api-specs/idn/sailpoint-api.cc.yaml +++ /dev/null @@ -1,1205 +0,0 @@ -openapi: 3.0.0 -info: - title: IdentityNow cc (private) APIs - version: 1.0.0 -servers: - - url: https://{tenant}.api.identitynow.com - description: This is the production API server. - variables: - tenant: - default: sailpoint - description: - This is the name of your tenant, typically your company's name. - - url: https://{apiUrl} - description: This is the CC API server. - variables: - apiUrl: - default: sailpoint.api.identitynow.com - description: This is the api url of your tenant -components: - securitySchemes: - UserContextAuth: - type: oauth2 - description: | - OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information. - - Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) - - Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) - - Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow) - - Which authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use) - - Learn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details) - flows: - clientCredentials: - tokenUrl: https://tenant.api.identitynow.com/oauth/token - scopes: - "sp:scopes:default": "default scope" - "sp:scopes:all": "access to all scopes" - authorizationCode: - authorizationUrl: https://tenant.identitynow.com/oauth/authorize - tokenUrl: https://tenant.api.identitynow.com/oauth/token - scopes: - "sp:scopes:default": "default scope" - "sp:scopes:all": "access to all scopes" -tags: - - name: Accounts - - name: Applications - - name: Connectors - - name: User - - name: Sources > Aggregation - - name: Sources > Accounts - - name: System -paths: - /cc/api/account/list: - get: - tags: - - Accounts - summary: List Accounts - operationId: listAccounts - security: - - UserContextAuth: [] - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - example: 17248154 - type: - type: string - example: SYSTEM_CONTROLLED - displayName: - type: string - example: tyler.mairose - username: - type: string - example: tyler.mairose - passwordRequired: - type: boolean - passwordProvided: - type: boolean - apps: - type: array - items: - type: object - ssoMethod: - type: string - example: NONE - idEncryption: - type: string - example: NONE - passwordEncryption: - type: string - example: NONE - lastPasswdChange: - type: string - nullable: true - serviceName: - type: string - example: airtable v4 - dateDisabled: - type: string - nullable: true - accountServiceId: - type: integer - format: int32 - example: 44663 - serviceId: - type: integer - format: int32 - example: 44663 - pendingPasswordRequestId: - type: string - nullable: true - passwordChangeStatus: - type: string - example: SUCCESS - passwordChangeResult: - type: object - properties: - completionStatus: - type: string - example: SUCCESS - /cc/api/account/remove/{id}: - post: - tags: - - Accounts - summary: Remove Account - operationId: removeAccount - security: - - UserContextAuth: [] - parameters: - - name: id - in: path - schema: - type: string - example: 12345 - required: true - responses: - '200': - description: Successful response - content: - application/json: {} - /cc/api/app/list: - get: - tags: - - Applications - summary: List Applications - operationId: listApplications - security: - - UserContextAuth: [] - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - appId: - type: string - serviceId: - type: string - serviceAppId: - type: string - name: - type: string - description: - type: string - appCenterEnabled: - type: boolean - provisionRequestEnabled: - type: boolean - controlType: - type: string - mobile: - type: boolean - privateApp: - type: boolean - scriptName: - type: string - status: - type: string - icon: - type: string - health: - type: object - properties: - status: - type: string - lastChanged: - type: string - since: - type: number - healthy: - type: boolean - enableSso: - type: boolean - ssoMethod: - type: string - hasLinks: - type: boolean - hasAutomations: - type: boolean - stepUpAuthData: - type: object - stepUpAuthType: - type: string - usageAnalytics: - type: boolean - usageCertRequired: - type: boolean - usageCertText: - type: object - launchpadEnabled: - type: boolean - passwordManaged: - type: boolean - owner: - type: object - properties: - id: - type: string - name: - type: string - dateCreated: - type: number - lastUpdated: - type: number - defaultAccessProfile: - type: object - service: - type: string - selectedSsoMethod: - type: string - supportedSsoMethods: - type: number - offNetworkBlockedRoles: - type: object - supportedOffNetwork: - type: string - accountServiceId: - type: number - launcherCount: - type: number - accountServiceName: - type: string - accountServiceExternalId: - type: string - accountServiceMatchAllAccounts: - type: boolean - externalId: - type: string - accountServiceUseForPasswordManagement: - type: boolean - accountServicePolicyId: - type: string - accountServicePolicyName: - type: string - requireStrongAuthn: - type: boolean - accountServicePolicies: - type: array - items: - type: object - properties: - policyId: - type: string - policyName: - type: string - selectors: - type: object - xsdVersion: - type: string - appProfiles: - type: array - items: - type: object - properties: - id: - type: number - filename: - type: string - createdBy: - type: string - dateCreated: - type: string - xsdVersion: - type: string - passwordServiceId: - type: number - accessProfileIds: - type: array - items: - type: string - /cc/api/app/get/{id}: - get: - tags: - - Applications - summary: Get Single Application - operationId: GetApplication - security: - - UserContextAuth: [] - parameters: - - name: id - in: path - schema: - type: string - example: 12345 - required: true - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - properties: - id: - type: string - appId: - type: string - serviceId: - type: string - serviceAppId: - type: string - name: - type: string - description: - type: string - appCenterEnabled: - type: boolean - provisionRequestEnabled: - type: boolean - controlType: - type: string - mobile: - type: boolean - privateApp: - type: boolean - scriptName: - type: string - status: - type: string - icon: - type: string - health: - type: object - properties: - status: - type: string - lastChanged: - type: string - since: - type: number - healthy: - type: boolean - enableSso: - type: boolean - ssoMethod: - type: string - hasLinks: - type: boolean - hasAutomations: - type: boolean - stepUpAuthData: - type: object - stepUpAuthType: - type: string - usageAnalytics: - type: boolean - usageCertRequired: - type: boolean - usageCertText: - type: object - launchpadEnabled: - type: boolean - passwordManaged: - type: boolean - owner: - type: object - properties: - id: - type: string - name: - type: string - dateCreated: - type: number - lastUpdated: - type: number - defaultAccessProfile: - type: object - service: - type: string - selectedSsoMethod: - type: string - supportedSsoMethods: - type: number - offNetworkBlockedRoles: - type: object - supportedOffNetwork: - type: string - accountServiceId: - type: number - launcherCount: - type: number - accountServiceName: - type: string - accountServiceExternalId: - type: string - accountServiceMatchAllAccounts: - type: boolean - externalId: - type: string - accountServiceUseForPasswordManagement: - type: boolean - accountServicePolicyId: - type: string - accountServicePolicyName: - type: string - requireStrongAuthn: - type: boolean - accountServicePolicies: - type: array - items: - type: object - properties: - policyId: - type: string - policyName: - type: string - selectors: - type: object - xsdVersion: - type: string - appProfiles: - type: array - items: - type: object - properties: - id: - type: number - filename: - type: string - createdBy: - type: string - dateCreated: - type: string - xsdVersion: - type: string - passwordServiceId: - type: number - accessProfileIds: - type: object - /cc/api/app/getAccessProfiles/{id}: - get: - tags: - - Applications - summary: Get Access Profiles for Application - operationId: GetApplicationAccessProfiles - parameters: - - name: id - in: path - schema: - type: string - example: 12345 - required: true - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - additionalProperties: true - /cc/api/app/create: - post: - tags: - - Applications - summary: Create Application - operationId: CreateApplication - security: - - UserContextAuth: [] - requestBody: - content: - application/json: - schema: - type: object - properties: - name: - type: string - example: 'My App' - description: - type: string - format: 'This is my application' - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - additionalProperties: true - /cc/api/app/update/{id}: - post: - tags: - - Applications - summary: Update Application - operationId: UpdateApplication - security: - - UserContextAuth: [] - parameters: - - name: id - in: path - schema: - type: string - example: 12345 - required: true - requestBody: - content: - application/json: - schema: - type: object - additionalProperties: true - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - additionalProperties: true - /cc/api/app/delete/{id}: - post: - tags: - - Applications - summary: Delete Application - operationId: DeleteApplication - security: - - UserContextAuth: [] - parameters: - - name: id - in: path - schema: - type: string - example: 12345 - required: true - responses: - '200': - description: Successful response - content: - application/json: {} - /cc/api/connector/list: - get: - tags: - - Connectors - summary: List Connectors - operationId: listConnectors - security: - - UserContextAuth: [] - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - properties: - total: - type: number - items: - type: array - items: - type: object - properties: - applicationXml: - type: string - nullable: true - className: - type: string - nullable: true - connectorMetadata: - type: object - correlationConfigXml: - type: string - nullable: true - directConnect: - type: boolean - fileUpload: - type: boolean - id: - type: integer - format: int32 - example: 8017 - name: - type: string - example: ACF2 - s3Location: - type: string - nullable: true - scope: - type: string - example: global - scriptName: - type: string - example: acf2-angularsc - sourceConfig: - type: string - nullable: true - sourceConfigFrom: - type: string - nullable: true - sourceConfigXml: - type: string - nullable: true - status: - type: string - example: RELEASED - translationProperties: - type: object - type: - type: string - example: ACF2 - Full - uploadedFiles: - type: array - items: - type: object - example: [] - /cc/api/connector/create: - post: - tags: - - Connectors - summary: Create Connector - operationId: createConnector - security: - - UserContextAuth: [] - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - properties: - name: - type: string - example: My Connector - description: - type: string - example: My Connector - className: - type: string - example: sailpoint.connector.OpenConnectorAdapter - directConnect: - type: boolean - example: 'true' - status: - type: string - example: released - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/x-www-form-urlencoded - responses: - '200': - description: Successful response - content: - application/json: {} - /cc/api/connector/delete/{id}: - post: - tags: - - Connectors - summary: Delete Connector - operationId: deleteConnector - security: - - UserContextAuth: [] - parameters: - - name: id - in: path - schema: - type: string - required: true - responses: - '200': - description: Successful response - content: - application/json: {} - /cc/api/connector/export/{id}: - get: - tags: - - Connectors - summary: Export Connector Config - operationId: exportConnectorConfig - security: - - UserContextAuth: [] - parameters: - - name: id - in: path - schema: - type: string - required: true - responses: - '200': - description: Successful response - content: - application/json: {} - /cc/api/connector/import/{id}: - post: - tags: - - Connectors - summary: Import Connector Config - operationId: importConnectorConfig - security: - - UserContextAuth: [] - requestBody: - content: - multipart/form-data: - schema: - type: object - properties: - file: - type: string - description: This is the connector config zip bundle which gets uploaded. - format: binary - parameters: - - name: id - in: path - schema: - type: string - required: true - responses: - '200': - description: Successful response - content: - application/json: {} - /cc/api/user/updatePermissions: - post: - tags: - - User - summary: Update User Permissions - operationId: updateUserPermissions - security: - - UserContextAuth: [] - requestBody: - content: - application/json: - schema: - type: object - properties: - ids: - type: string - example: '71624,71625' - isAdmin: - type: string - description: Indicates if user should be an IDN Admin. "0" for false, "1" for true. - example: "1" - adminType: - type: string - enum: - - ADMIN - - CERT_ADMIN - - HELPDESK - - REPORT_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - responses: - '200': - description: Successful response - content: - application/json: {} - /cc/api/user/get/{id}: - get: - tags: - - User - summary: Get Single Identity - operationId: GetIdentity - security: - - UserContextAuth: [] - parameters: - - name: id - in: path - schema: - type: string - example: 5433236 - required: true - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - properties: - id: - type: string - alias: - type: string - uid: - type: string - name: - type: string - displayName: - type: string - uuid: - type: string - encryptionKey: - type: object - encryptionCheck: - type: object - status: - type: string - pending: - type: boolean - passwordResetSinceLastLogin: - type: boolean - usageCertAttested: - type: object - userFlags: - type: object - enabled: - type: boolean - altAuthVia: - type: string - altAuthViaIntegrationData: - type: object - kbaAnswers: - type: number - disablePasswordReset: - type: boolean - ptaSourceId: - type: object - supportsPasswordPush: - type: boolean - attributes: - type: object - externalId: - type: string - role: - type: array - items: - type: object - phone: - type: object - email: - type: string - personalEmail: - type: object - employeeNumber: - type: object - riskScore: - type: number - featureFlags: - type: object - feature: - type: array - items: - type: string - orgEncryptionKey: - type: string - orgEncryptionKeyId: - type: string - meta: - type: object - org: - type: object - properties: - name: - type: string - scriptName: - type: string - mode: - type: string - numQuestions: - type: number - status: - type: string - maxRegisteredUsers: - type: number - pod: - type: string - pwdResetPersonalPhone: - type: boolean - pwdResetPersonalEmail: - type: boolean - pwdResetKba: - type: boolean - pwdResetEmail: - type: boolean - pwdResetDuo: - type: boolean - pwdResetPhoneMask: - type: boolean - authErrorText: - type: object - strongAuthKba: - type: boolean - strongAuthPersonalPhone: - type: boolean - strongAuthPersonalEmail: - type: boolean - integrations: - type: array - items: - type: object - productName: - type: string - kbaReqForAuthn: - type: number - kbaReqAnswers: - type: number - lockoutAttemptThreshold: - type: number - lockoutTimeMinutes: - type: number - usageCertRequired: - type: boolean - adminStrongAuthRequired: - type: boolean - enableExternalPasswordChange: - type: boolean - enablePasswordReplay: - type: boolean - enableAutomaticPasswordReplay: - type: boolean - notifyAuthenticationSettingChange: - type: boolean - netmasks: - type: object - countryCodes: - type: object - whiteList: - type: boolean - usernameEmptyText: - type: object - usernameLabel: - type: object - enableAutomationGeneration: - type: boolean - emailTestMode: - type: boolean - emailTestAddress: - type: string - orgType: - type: string - passwordReplayState: - type: string - systemNotificationConfig: - type: string - redirectPatterns: - type: string - maxClusterDebugHours: - type: string - brandName: - type: string - logo: - type: object - emailFromAddress: - type: object - standardLogoUrl: - type: object - narrowLogoUrl: - type: object - actionButtonColor: - type: string - activeLinkColor: - type: string - navigationColor: - type: string - stepUpAuth: - type: boolean - bxInstallPrompted: - type: boolean - federatedLogin: - type: boolean - auth: - type: object - properties: - service: - type: string - encryption: - type: string - onNetwork: - type: boolean - onTrustedGeo: - type: boolean - loginUrl: - type: string - /cc/api/source/loadAccounts/{id}: - post: - tags: - - Sources > Aggregation - summary: Account Aggregation (File) - operationId: loadAccounts - security: - - UserContextAuth: [] - description: >- - Aggregates a delimited file for the given source. This only works for - file-based sources. - requestBody: - content: - multipart/form-data: - schema: - type: object - properties: - disableOptimization: - type: boolean - example: 'true' - file: - type: string - format: binary - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/x-www-form-urlencoded - - name: id - in: path - schema: - type: string - required: true - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - additionalProperties: true - /cc/api/source/loadEntitlements/{id}: - post: - tags: - - Sources > Aggregation - summary: Account Aggregation (File) - operationId: loadEntitlements - security: - - UserContextAuth: [] - description: >- - Aggregates a delimited file for the given source. This only works for - file-based sources. - requestBody: - content: - multipart/form-data: - schema: - type: object - properties: - file: - type: string - format: binary - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/x-www-form-urlencoded - - name: id - in: path - schema: - type: string - required: true - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - additionalProperties: true - /cc/api/source/exportAccountFeed/{id}: - get: - tags: - - Sources > Accounts - summary: Export Account Feed - operationId: exportAccountFeed - security: - - UserContextAuth: [] - description: Exports a CSV of the accounts for a particular source. - parameters: - - name: id - in: path - schema: - type: string - required: true - responses: - '200': - description: Successful response - content: - application/json: {} - /cc/api/system/refreshIdentities: - post: - tags: - - System - summary: Refresh Identities - operationId: refreshIdentities - security: - - UserContextAuth: [] - description: >- - This kicks off an identity refresh for a specified set of identity - attributes. This can be a long running process. IdentityNow has - pre-scheduled versions of this task at set intervals and events already, - so only run this when directed by SailPoint. - - - _Note: If the identities specified by the filter do not exist, a full - identity refresh will be run. Use with caution._ - - - Refresh Arguments: - - - | Key | - Description | - - |-----------------------|----------------------------------------------------| - - | correlateEntitlements | Analyzes entitlements, access profiles, and - roles. | - - | promoteAttributes | Calculates identity - attributes. | - - | refreshManagerStatus | Calculates manager correlation and manager - status. | - - | synchronizeAttributes | Performs attribute sync - provisioning. | - - | pruneIdentities | Removes any identities which don't have - accounts. | - - | provision | Provisions any assigned roles or access - profiles. | - requestBody: - content: - application/json: - schema: - type: object - properties: - filter: - type: string - description: | - Defines the identity or identities which this refresh applies to. - The filter must use searchable identity attributes. - If the filter cannot be understood or parsed, all identities will be refreshed. - refreshArgs: - type: object - properties: - correlateEntitlements: - type: boolean - example: true - description: This will refresh entitlement, role, and access profile calculations. - promoteAttributes: - type: boolean - example: true - description: This will calculate identity attributes. - refreshManagerStatus: - type: boolean - example: false - description: | - This recalculates manager correlation and manager status. Note: This is computationally expensive to run. - synchronizeAttributes: - type: boolean - example: false - description: Enables attribute synchronization. - pruneIdentities: - type: boolean - example: false - description: | - Option that will enable deletion of an identity objects if there are no account objects. Note: This is not typically used in IdentityNow, except by guidance from SailPoint. - provision: - type: boolean - example: false - description: Enables provisioning of role assignments with entitlements that are not currently fulfilled. - example: >- - "{\n \"filter\" : \"uid == \\\"1219028\\\"\",\n - \"refreshArgs\" : {\n \"correlateEntitlements\" : - \"true\",\n \"promoteAttributes\" : \"true\",\n - \"refreshManagerStatus\" : \"false\",\n - \"synchronizeAttributes\" : \"false\",\n \"pruneIdentities\" - : \"false\",\n \"provision\" : \"true\"\n }\n}" - parameters: - - name: Content-Type - in: header - schema: - type: string - example: application/json - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - additionalProperties: true diff --git a/static/api-specs/idn/sailpoint-api.v2.yaml b/static/api-specs/idn/sailpoint-api.v2.yaml deleted file mode 100644 index 79301e23e..000000000 --- a/static/api-specs/idn/sailpoint-api.v2.yaml +++ /dev/null @@ -1,988 +0,0 @@ -openapi: 3.0.1 -info: - title: SailPoint SaaS API - version: 2.0.0 -servers: - - url: https://{tenant}.api.identitynow.com/v2 - description: This is the production API server. - variables: - tenant: - default: sailpoint - description: - This is the name of your tenant, typically your company's name. - - url: https://{apiUrl}/v2 - description: This is the V2 API server. - variables: - apiUrl: - default: sailpoint.api.identitynow.com - description: This is the api url of your tenant -components: - securitySchemes: - UserContextAuth: - type: oauth2 - description: | - OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information. - - Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) - - Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) - - Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow) - Which authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use) - Learn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details) - flows: - clientCredentials: - tokenUrl: https://tenant.api.identitynow.com/oauth/token - scopes: - "sp:scopes:default": "default scope" - "sp:scopes:all": "access to all scopes" - authorizationCode: - authorizationUrl: https://tenant.identitynow.com/oauth/authorize - tokenUrl: https://tenant.api.identitynow.com/oauth/token - scopes: - "sp:scopes:default": "default scope" - "sp:scopes:all": "access to all scopes" -tags: - - name: org - -paths: - '/org': - get: - tags: - - org - summary: Retrieves your org settings. - description: Retrieves information and operational settings for your org (as determined - by the URL domain). - operationId: getOrgSettings - responses: - '200': - description: OK. - content: - application/json: - schema: - type: object - properties: - id: - type: string - name: - type: string - description: - type: string - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - scriptName: - type: string - ssoDomain: - type: string - status: - type: string - enum: - - inactive - - active - - demo - - test - maxRegisteredIdentities: - type: integer - identityCount: - type: integer - kbaReqForAuthn: - type: integer - kbaReqAnswers: - type: integer - lockoutAttemptThreshold: - type: integer - lockoutTimeMinutes: - type: integer - usageCertRequired: - type: boolean - adminStrongAuthRequired: - type: boolean - enableExternalPasswordChange: - type: boolean - enablePasswordReplay: - type: boolean - enableAutomaticPasswordReplay: - type: boolean - netmasks: - type: array - items: - type: string - countryCodes: - type: array - items: - type: string - whiteList: - type: boolean - emailTestMode: - type: boolean - emailTestAddress: - type: string - format: email - usernameEmptyText: - type: string - usernameLabel: - type: string - enableAutomationGeneration: - type: boolean - passwordReplayState: - type: string - enum: - - enabled - - passive - - disabled - systemNotificationConfig: - type: object - properties: - notifications: - type: array - items: - type: object - properties: - type: - type: string - byEmail: - type: boolean - thresholds: - type: object - properties: - healthy: - type: string - unhealthy: - type: string - recipientType: - type: string - enum: - - allAdmins - - specificIdentities - systemNotificationEmails: - type: array - items: - type: string - format: email - loginUrl: - type: string - redirectPatterns: - type: array - items: - type: string - styleHash: - type: string - approvalConfig: - type: object - properties: - daysTillEscalation: - type: integer - daysBetweenReminders: - type: integer - maxReminders: - type: integer - fallbackApprover: - type: string - required: - - daysTillEscalation - - daysBetweenReminders - - maxReminders - - fallbackApprover - ssoPartnerSource: - type: string - headers: - ETag: - description: Entity tag. - schema: - type: string - Last-Modified: - description: Last modified date. - schema: - type: string - format: date-time - Link: - description: Links to alternate or related resources. - schema: - type: string - patch: - tags: - - org - summary: Updates one or more org attributes. - description: Updates one or more attributes for your org. - operationId: updateOrgSettings - requestBody: - description: Org settings to update. - required: true - content: - application/json: - schema: - type: object - properties: - countryCodes: - type: array - items: - type: string - enableExternalPasswordChange: - type: boolean - enableAutomaticPasswordReplay: - type: boolean - enableAutomationGeneration: - type: boolean - kbaReqAnswers: - type: integer - format: int32 - kbaReqForAuthn: - type: integer - format: int32 - lockoutAttemptThreshold: - type: integer - format: int32 - lockoutTimeMinutes: - type: integer - format: int32 - loginUrl: - type: string - netmasks: - type: array - items: - type: string - notifyAuthenticationSettingChange: - type: boolean - passwordReplayState: - type: string - enum: - - enabled - - passive - - disabled - preferredIdentityInviteTemplate: - type: string - redirectPatterns: - type: array - items: - type: string - ssoPartnerSource: - type: string - systemNotificationEmails: - type: array - items: - type: string - format: email - trackAnalytics: - type: boolean - usageCertRequired: - type: boolean - usageCertText: - type: string - usernameEmptyText: - type: string - usernameLabel: - type: string - whiteList: - type: boolean - approvalConfig: - type: object - properties: - daysTillEscalation: - type: integer - daysBetweenReminders: - type: integer - maxReminders: - type: integer - fallbackApprover: - type: string - required: - - daysTillEscalation - - daysBetweenReminders - - maxReminders - - fallbackApprover - - responses: - '200': - description: OK. - content: - application/json: - schema: - type: object - properties: - id: - type: string - name: - type: string - description: - type: string - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - scriptName: - type: string - ssoDomain: - type: string - status: - type: string - enum: - - inactive - - active - - demo - - test - maxRegisteredIdentities: - type: integer - identityCount: - type: integer - kbaReqForAuthn: - type: integer - kbaReqAnswers: - type: integer - lockoutAttemptThreshold: - type: integer - lockoutTimeMinutes: - type: integer - usageCertRequired: - type: boolean - adminStrongAuthRequired: - type: boolean - enableExternalPasswordChange: - type: boolean - enablePasswordReplay: - type: boolean - enableAutomaticPasswordReplay: - type: boolean - netmasks: - type: array - items: - type: string - countryCodes: - type: array - items: - type: string - whiteList: - type: boolean - emailTestMode: - type: boolean - emailTestAddress: - type: string - format: email - usernameEmptyText: - type: string - usernameLabel: - type: string - enableAutomationGeneration: - type: boolean - passwordReplayState: - type: string - enum: - - enabled - - passive - - disabled - systemNotificationConfig: - type: object - properties: - notifications: - type: array - items: - type: object - properties: - type: - type: string - byEmail: - type: boolean - thresholds: - type: object - properties: - healthy: - type: string - unhealthy: - type: string - recipientType: - type: string - enum: - - allAdmins - - specificIdentities - systemNotificationEmails: - type: array - items: - type: string - format: email - loginUrl: - type: string - redirectPatterns: - type: array - items: - type: string - styleHash: - type: string - approvalConfig: - type: object - properties: - daysTillEscalation: - type: integer - daysBetweenReminders: - type: integer - maxReminders: - type: integer - fallbackApprover: - type: string - required: - - daysTillEscalation - - daysBetweenReminders - - maxReminders - - fallbackApprover - ssoPartnerSource: - type: string - headers: - ETag: - description: Entity tag. - schema: - type: string - Last-Modified: - description: Last modified date. - schema: - type: string - format: date-time - Link: - description: Links to alternate or related resources. - schema: - type: string - '/workgroups': - get: - operationId: listWorkgroups - tags: - - Governance Groups - summary: List Work Groups - description: This API returns a list of work groups - security: - - UserContextAuth: [] - parameters: - - in: query - name: limit - description: >- - Max number of results to return - 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. - required: false - example: 0 - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - - in: query - name: filters - schema: - type: string - description: >- - Filter results using the following syntax. - - [{property:name, value: "Tyler", operation: EQ}] - required: false - responses: - '200': - description: List of work group objects - content: - application/json: - schema: - type: array - items: - type: object - properties: - connectionCount: - type: integer - format: int32 - example: 2 - created: - type: integer - format: int64 - example: 1641498673000 - description: - type: string - example: Phil Governance Group - id: - type: string - example: b0c131fa-5133-4efb-9bb2-e22529f44cad - memberCount: - type: integer - format: int32 - example: 2 - modified: - type: integer - format: int64 - example: 1641498673000 - name: - type: string - example: Phil Governance Group - owner: - type: object - properties: - displayName: - type: string - example: Philip Ellis - emailAddress: - type: string - example: philip.ellis@sailpoint.com - id: - type: string - example: 2c9180897d2cb80b017d39ccb26c1804 - name: - type: string - example: philip.ellis - - post: - operationId: createWorkgroup - tags: - - Governance Groups - summary: Create Work Group - description: This API allows you to create a work group - security: - - UserContextAuth: [] - requestBody: - description: Work group to create. - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - example: Test group 3 - description: - type: string - example: This is a test - owner: - type: object - properties: - id: - type: string - example: 2c9180867624cbd7017642d8c8c81f67 - responses: - '200': - description: List of work group objects - content: - application/json: - schema: - type: array - items: - type: object - properties: - connectionCount: - type: integer - format: int32 - example: 2 - created: - type: integer - format: int64 - example: 1641498673000 - description: - type: string - example: Phil Governance Group - id: - type: string - example: b0c131fa-5133-4efb-9bb2-e22529f44cad - memberCount: - type: integer - format: int32 - example: 2 - modified: - type: integer - format: int64 - example: 1641498673000 - name: - type: string - example: Phil Governance Group - owner: - type: object - properties: - displayName: - type: string - example: Philip Ellis - emailAddress: - type: string - example: philip.ellis@sailpoint.com - id: - type: string - example: 2c9180897d2cb80b017d39ccb26c1804 - name: - type: string - example: philip.ellis - '/workgroups/{workgroupId}': - get: - operationId: getWorkgroup - tags: - - Governance Groups - summary: Get Work Group By Id - description: This API returns the details for a single workgroup based on the ID - security: - - UserContextAuth: [] - parameters: - - in: path - name: workgroupId - schema: - type: string - required: true - description: The workgroup ID - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: Workgroup object - content: - application/json: - schema: - type: object - properties: - connectionCount: - type: integer - format: int32 - example: 2 - created: - type: integer - format: int64 - example: 1641498673000 - description: - type: string - example: Phil Governance Group - id: - type: string - example: b0c131fa-5133-4efb-9bb2-e22529f44cad - memberCount: - type: integer - format: int32 - example: 2 - modified: - type: integer - format: int64 - example: 1641498673000 - name: - type: string - example: Phil Governance Group - owner: - type: object - properties: - displayName: - type: string - example: Philip Ellis - emailAddress: - type: string - example: philip.ellis@sailpoint.com - id: - type: string - example: 2c9180897d2cb80b017d39ccb26c1804 - name: - type: string - example: philip.ellis - patch: - operationId: updateWorkgroup - tags: - - Governance Groups - summary: Update Work Group By Id - description: This API updates and returns the details for a single workgroup based on the ID - security: - - UserContextAuth: [] - parameters: - - in: path - name: workgroupId - schema: - type: string - required: true - description: The workgroup ID - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - description: Work group to modify. - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - example: Test group 3 - description: - type: string - example: This is a test - owner: - type: object - properties: - id: - type: string - example: 2c9180867624cbd7017642d8c8c81f67 - responses: - '200': - description: Workgroup object - content: - application/json: - schema: - type: object - properties: - connectionCount: - type: integer - format: int32 - example: 2 - created: - type: integer - format: int64 - example: 1641498673000 - description: - type: string - example: Phil Governance Group - id: - type: string - example: b0c131fa-5133-4efb-9bb2-e22529f44cad - memberCount: - type: integer - format: int32 - example: 2 - modified: - type: integer - format: int64 - example: 1641498673000 - name: - type: string - example: Phil Governance Group - owner: - type: object - properties: - displayName: - type: string - example: Philip Ellis - emailAddress: - type: string - example: philip.ellis@sailpoint.com - id: - type: string - example: 2c9180897d2cb80b017d39ccb26c1804 - name: - type: string - example: philip.ellis - - delete: - operationId: deleteWorkgroup - tags: - - Governance Groups - summary: Delete Work Group By Id - description: This API deletes a single workgroup based on the ID - security: - - UserContextAuth: [] - parameters: - - in: path - name: workgroupId - schema: - type: string - required: true - description: The workgroup ID - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '204': - description: Empty response on successful deletion - content: - application/json: {} - '/workgroups/{workgroupId}/members': - get: - operationId: listWorkgroupMembers - tags: - - Governance Groups - summary: List Work Group Members - description: This API returns the members of a work group - security: - - UserContextAuth: [] - parameters: - - in: path - name: workgroupId - schema: - type: string - required: true - description: The workgroup ID - example: ef38f94347e94562b5bb8424a56397d8 - - in: query - name: limit - description: >- - Max number of results to return - 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. - required: false - example: 0 - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - - in: query - name: filters - schema: - type: string - description: >- - Filter results using the following syntax. - - [{property:name, value: "Tyler", operation: EQ}] - responses: - '200': - description: List of work group member objects - content: - application/json: - schema: - type: array - items: - type: object - properties: - alias: - type: string - example: Jerry.Bennett - email: - type: string - example: Jerry.Bennett@sailpointdemo.com - externalId: - type: string - example: 2c9180837dfe6949017e208e26027b23 - id: - type: integer - format: int32 - example: 3497959 - name: - type: string - example: Jerry.Bennett - post: - operationId: modifyWorkgroupMembers - tags: - - Governance Groups - summary: Modify Work Group Members - description: This API allows you to modify the members of a work group - security: - - UserContextAuth: [] - parameters: - - in: path - name: workgroupId - schema: - type: string - required: true - description: The workgroup ID - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - description: Add/Remove workgroup member ids. - required: true - content: - application/json: - schema: - type: object - properties: - add: - type: array - items: - type: string - example: 2c9180867624cbd7017642d8c8c81f67 - remove: - type: array - items: - type: string - example: 2c9180867624cbd7017642d8c8c81f67 - responses: - '204': - description: Empty response on successful deletion - content: - application/json: {} - '/workgroups/{workgroupId}/connections': - get: - operationId: listWorkgroupConnections - tags: - - Governance Groups - summary: List Work Group Connections - description: This API returns the connections of a work group - security: - - UserContextAuth: [] - parameters: - - in: path - name: workgroupId - schema: - type: string - required: true - description: The workgroup ID - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: List of work group connection objects - content: - application/json: - schema: - type: array - items: - type: object - properties: - connectionType: - type: string - example: AccessRequestReviewer - description: - type: string - format: nullable - name: - type: string - example: Test Approval Scheme - objectId: - type: string - example: 8c24b31fe23947b28e42691a4a6faaee - objectType: - type: string - example: AccessProfile - workgroupId: - type: string - example: b0c131fa-5133-4efb-9bb2-e22529f44cad - '/workgroups/bulk-delete': - post: - operationId: bulkDeleteWorkGroups - tags: - - Governance Groups - summary: Bulk delete work groups - description: This API allows you to bulk-delete work groups - security: - - UserContextAuth: [] - requestBody: - description: Work group ids to delete - required: true - content: - application/json: - schema: - type: object - properties: - ids: - type: array - items: - type: string - example: 868edef1-222b-40e4-8787-b56cfd78b100 - responses: - '200': - description: List of work group objects - content: - application/json: - schema: - type: object - properties: - deleted: - type: array - items: - type: string - example: 4518f275-e7de-40b8-9951-b67d6273421c - inUse: - type: array - items: - type: string - example: 12538dlg-60d0-44b4-9273-d1ba578ef384 - notFound: - type: array - items: - type: string - example: 12538ecf-60d0-44b4-9273-d1ba578ef384 diff --git a/static/api-specs/idn/sailpoint-api.v3.yaml b/static/api-specs/idn/sailpoint-api.v3.yaml index 36e916f54..d8e01510d 100644 --- a/static/api-specs/idn/sailpoint-api.v3.yaml +++ b/static/api-specs/idn/sailpoint-api.v3.yaml @@ -103,6 +103,11 @@ tags: They can use the My Requests tab under Request Center to track and/or cancel the requests. Refer to [Requesting Access](https://documentation.sailpoint.com/saas/user-help/requests/requesting_access.html) for more information about access requests. + - name: Account Usages + description: | + Use this API to implement account usage insight functionality. + With this functionality in place, administrators can gather information and insights about how their tenants' source accounts are being used. + This allows organizations to get the information they need to start optimizing and securing source account usage. - name: Accounts description: | Use this API to implement and customize account functionality. @@ -169,6 +174,11 @@ tags: Refer to [Account Activity](https://documentation.sailpoint.com/saas/help/search/index.html#account-activity) for more information about account activities. - name: Auth User description: Authentication service user retrieval and user capabilities update + - name: Branding + description: | + Use this API to implement and customize branding functionality. + With this functionality in place, administrators can get list of existing branding items, create new branding and configure them for use throughout IdentityNow. + It allows to customise color of navigation bar, action buttons, logo and emailFromAddress. - name: Certification Campaigns description: | Use this API to implement certification campaign functionality. @@ -308,6 +318,22 @@ tags: Once the campaign filter is created, it can be linked while creating the campaign. The generated campaign will have the items to review as per the campaign filter. For example, An inclusion campaign filter is created with a source of Source 1, an operation of Equals, and an entitlement of Entitlement 1. When this filter is selected, only users who have Entitlement 1 are included in the campaign, and only Entitlement 1 is shown in the certification. + - name: Connectors + description: | + Use this API to implement connector functionality. + With this functionality in place, administrators can view available connectors. + + Connectors are the bridges IdentityNow uses to communicate with and aggregate data from sources. + For example, if it is necessary to set up a connection between IdentityNow and the Active Directory source, a connector can bridge the two and enable IdentityNow to synchronize data between the systems. + This ensures account entitlements and states are correct throughout the organization. + + In IdentityNow, administrators can use the Connections drop-down menu and select Sources to view the available source connectors. + + Refer to [IdentityNow Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about the connectors available in IdentityNow. + + Refer to [SaaS Connectivity](https://developer.sailpoint.com/idn/docs/saas-connectivity) for more information about the SaaS custom connectors that do not need VAs (virtual appliances) to communicate with their sources. + + Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about using connectors in IdentityNow. - name: Global Tenant Security Settings description: | Use this API to implement and customize global tenant security settings. @@ -553,6 +579,8 @@ tags: - name: Reports Data Extraction description: | Use this API to implement reports lifecycle managing and monitoring. + With this functionality in place, users can run reports, view their results, and cancel reports in progress. + This can be potentially helpful for auditing purposes. - name: Requestable Objects description: | Use this API to implement requestable object functionality. @@ -608,7 +636,7 @@ tags: In IdentityNow, users can save searches under a name, and then they can access that saved search and run it again when they want. - Refer to [Managing Saved Searches](https://documentation.sailpoint.com/saas/help/search/saved-searches.html) for more information about saving searches and using them. + Refer to [Managing Saved Searches](https://documentation.sailpoint.com/saas/help/search/saved-searches.html) for more information about saving searches and using them. - name: Scheduled Search description: | Use this API to implement scheduled search functionality. @@ -661,7 +689,7 @@ tags: However, data from the operational databases (ex. identities, roles, events, etc) has to be ingested into Elasticsearch. This ingestion process introduces a latency from when the operational data is created to when it is available in search. Depending on the system load, this can take a few seconds to a few minutes. - Please keep this latency in mind when you use search. + Please keep this latency in mind when you use search. - name: Segments description: | Use this API to implement and customize access request segment functionality. @@ -680,7 +708,7 @@ tags: When administrators use the API to create and manage segments, they use a JSON expression in the `visibilityCriteria` object to define the segment's identities and access items. - Refer to [Managing Access Request Segments](https://documentation.sailpoint.com/saas/help/requests/segments.html) for more information about segments in IdentityNow. + Refer to [Managing Access Request Segments](https://documentation.sailpoint.com/saas/help/requests/segments.html) for more information about segments in IdentityNow. - name: Service Desk Integration description: | Use this API to build an integration between IdentityNow and a service desk ITSM (IT service management) solution. @@ -734,9 +762,32 @@ tags: Refer to [Managing Policies](https://documentation.sailpoint.com/saas/help/sod/manage-policies.html) for more information about SOD policies. - Refer to [Subscribe to a SOD Policy](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html#subscribe-to-an-sod-policy) for more information about SOD policy subscriptions. + Refer to [Subscribe to a SOD Policy](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html#subscribe-to-an-sod-policy) for more information about SOD policy subscriptions. - name: SOD Violations - description: Operations for Predicting SOD (Separation of Duties) violations + description: | + Use this API to check for current "separation of duties" (SOD) policy violations as well as potential future SOD policy violations. + With SOD violation functionality in place, administrators can get information about current SOD policy violations and predict whether an access change will trigger new violations, which helps to prevent them from occurring at all. + + "Separation of duties" refers to the concept that people shouldn't have conflicting sets of access - all their access should be configured in a way that protects your organization's assets and data. + For example, people who record monetary transactions shouldn't be able to issue payment for those transactions. + Any changes to major system configurations should be approved by someone other than the person requesting the change. + + Organizations can use "separation of duties" (SOD) policies to enforce and track their internal security rules throughout their tenants. + These SOD policies limit each user's involvement in important processes and protects the organization from individuals gaining excessive access. + + Once a SOD policy is in place, if an identity has conflicting access items, a SOD violation will trigger. + These violations are included in SOD violation reports that other users will see in emails at regular intervals if they're subscribed to the SOD policy. + The other users can then better help to enforce these SOD policies. + + Administrators can use the SOD violations APIs to check a set of identities for any current SOD violations, and they can use them to check whether adding an access item would potentially trigger a SOD violation. + This second option is a good way to prevent SOD violations from triggering at all. + + Refer to [Handling Policy Violations](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html) for more information about SOD policy violations. + - name: Source Usages + description: | + Use this API to implement source usage insight functionality. + With this functionality in place, administrators can gather information and insights about how their tenants' sources are being used. + This allows organizations to get the information they need to start optimizing and securing source usage. - name: Sources description: | Use this API to implement and customize source functionality. @@ -795,8 +846,62 @@ tags: Refer to [Deleting Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html#deleting-sources) for more information about deleting sources. Well organized, mapped out connections between sources and IdentityNow are essential to achieving comprehensive identity access governance across all the source systems organizations need. - Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about all the different things admins can do with sources once they are connected. + Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about all the different things admins can do with sources once they are connected. - name: Tagged Objects + description: | + Use this API to implement object tagging functionality. + With object tagging functionality in place, any user in an organization can use tags as a way to group objects together and find them more quickly when the user searches IdentityNow. + + In IdentityNow, users can search their tenants for information and add tags objects they find. + Tagging an object provides users with a way of grouping objects together and makes it easier to find these objects in the future. + + For example, if a user is searching for an entitlement that grants a risky level of access to Active Directory, it's possible that the user may have to search through hundreds of entitlements to find the correct one. + Once the user finds that entitlement, the user can add a tag to the entitlement, "AD_RISKY" to make it easier to find the entitlement again. + The user can add the same tag to multiple objects the user wants to group together for an easy future search, and the user can also do so in bulk. + When the user wants to find that tagged entitlement again, the user can search for "tags:AD_RISKY" to find all objects with that tag. + + With the API, you can tag even more different object types than you can in IdentityNow (access profiles, entitlements, identities, and roles). + You can use the API to tag all these objects: + + - Access profiles + + - Applications + + - Certification campaigns + + - Entitlements + + - Identities + + - Roles + + - SOD (separation of duties) policies + + - Sources + + You can also use the API to directly find, create, and manage tagged objects without using search queries. + + There are limits to tags: + + - You can have up to 500 different tags in your tenant. + + - You can apply up to 30 tags to one object. + + - You can have up to 10,000 tag associations, pairings of 1 tag to 1 object, in your tenant. + + Because of these limits, it is recommended that you work with your governance experts and security teams to establish a list of tags that are most expressive of governance objects and access managed by IdentityNow. + + These are the types of information often expressed in tags: + + - Affected departments + + - Compliance and regulatory categories + + - Remediation urgency levels + + - Risk levels + + Refer to [Tagging Items in Search](https://documentation.sailpoint.com/saas/help/search/index.html?h=tags#tagging-items-in-search) for more information about tagging objects in IdentityNow. - name: Transforms description: | The purpose of this API is to expose functionality for the manipulation of Transform objects. @@ -821,16 +926,9 @@ tags: When they complete the work item, they can select 'Mark Complete' to add it to their list of completed work items. Refer to [Task Manager](https://documentation.sailpoint.com/saas/user-help/task_manager.html) for more information about work items, including the different types of work items users may need to complete. - - name: Source Usages + - name: Workflows description: | - Use this API to implement source usage insight functionality. - With this functionality in place, administrators can gather information and insights about how their tenants' sources are being used. - This allows organizations to get the information they need to start optimizing and securing source usage. - - name: Account Usages - description: | - Use this API to implement account usage insight functionality. - With this functionality in place, administrators can gather information and insights about how their tenants' source accounts are being used. - This allows organizations to get the information they need to start optimizing and securing source account usage. + Workflows allow administrators to create custom automation scripts directly within IdentityNow. These automation scripts respond to [event triggers](https://developer.sailpoint.com/idn/docs/event-triggers#how-to-get-started-with-event-triggers) and perform a series of actions to perform tasks that are either too cumbersome or not available in the IdentityNow UI. Workflows can be configured via a graphical user interface within IdentityNow, or by creating and uploading a JSON formatted script to the Workflow service. The Workflows API collection provides the necessary functionality to create, manage, and test your workflows via REST. paths: /access-profiles: $ref: './v3/paths/access-profiles.yaml' @@ -882,6 +980,10 @@ paths: $ref: "./v3/paths/auth-org-network-config.yaml" /auth-users/{id}: $ref: "./v3/paths/auth-user.yaml" + /brandings: + $ref: './v3/paths/brandings.yaml' + /brandings/{name}: + $ref: './v3/paths/branding.yaml' /campaigns: $ref: './v3/paths/campaigns.yaml' /campaigns/{id}: @@ -946,6 +1048,18 @@ paths: $ref: "./v3/paths/certification-task.yaml" /certification-tasks: $ref: "./v3/paths/certification-tasks.yaml" + /connectors/{scriptName}: + $ref: './v3/paths/connectors.yaml' + /connectors/{scriptName}/source-config: + $ref: './v3/paths/connectors-source-config.yaml' + /connectors/{scriptName}/translations/{locale}: + $ref: './v3/paths/connectors-translations.yaml' + /connectors/{scriptName}/source-template: + $ref: './v3/paths/connectors-source-template.yaml' + /connectors/{scriptName}/correlation-config: + $ref: './v3/paths/connectors-correlation-config.yaml' + /connectors: + $ref: './v3/paths/connectors-create-custom-connector.yaml' /identities/{identity-id}/set-lifecycle-state: $ref: "./v3/paths/identity-set-lifecycle-state.yaml" /identity-profiles/{identity-profile-id}/lifecycle-states: @@ -1166,6 +1280,34 @@ paths: $ref: "./v3/paths/work-items-bulk-reject-approval-item.yaml" /work-items/{id}/submit-account-selection: $ref: "./v3/paths/work-items-account-selection.yaml" + /workflows: + $ref: './v3/paths/workflows/workflows.yaml' + /workflows/{id}: + $ref: './v3/paths/workflows/workflow.yaml' + /workflows/{id}/test: + $ref: './v3/paths/workflows/workflow-test.yaml' + /workflows/{id}/executions: + $ref: './v3/paths/workflows/workflow-executions.yaml' + /workflow-executions/{id}: + $ref: './v3/paths/workflows/workflow-execution.yaml' + /workflow-executions/{id}/history: + $ref: './v3/paths/workflows/workflow-execution-history.yaml' + /workflow-executions/{id}/cancel: + $ref: './v3/paths/workflows/workflow-execution-cancel.yaml' + /workflow-library: + $ref: './v3/paths/workflows/workflow-library.yaml' + /workflow-library/actions: + $ref: './v3/paths/workflows/workflow-library-actions.yaml' + /workflow-library/triggers: + $ref: './v3/paths/workflows/workflow-library-triggers.yaml' + /workflow-library/operators: + $ref: './v3/paths/workflows/workflow-library-operators.yaml' + /workflows/{id}/external/oauth-clients: + $ref: './v3/paths/workflows/workflow-external-oauth-client.yaml' + /workflows/execute/external/{id}: + $ref: './v3/paths/workflows/workflow-external-execute.yaml' + /workflows/execute/external/{id}/test: + $ref: './v3/paths/workflows/workflow-external-execute-test.yaml' /source-usages/{sourceId}/status: $ref: "./v3/paths/source-usage-status.yaml" /source-usages/{sourceId}/summaries: @@ -1197,7 +1339,7 @@ components: "sp:scopes:default": "default scope" "sp:scopes:all": "access to all scopes" authorizationCode: - authorizationUrl: https://tenant.identitynow.com/oauth/authorize + authorizationUrl: https://tenant.login.sailpoint.com/oauth/authorize tokenUrl: https://tenant.api.identitynow.com/oauth/token scopes: "sp:scopes:default": "default scope" @@ -1321,3 +1463,7 @@ components: $ref: './v3/schemas/SourceUsage.yaml' SourceUsageStatus: $ref: './v3/schemas/SourceUsageStatus.yaml' + BrandingItem: + $ref: './v3/schemas/BrandingItem.yaml' + BrandingItemCreate: + $ref: './v3/schemas/BrandingItemCreate.yaml' diff --git a/static/api-specs/idn/v3/parameters/searchlimit.yaml b/static/api-specs/idn/v3/parameters/searchlimit.yaml new file mode 100644 index 000000000..9e3f46b71 --- /dev/null +++ b/static/api-specs/idn/v3/parameters/searchlimit.yaml @@ -0,0 +1,15 @@ +in: query +name: limit +description: >- + Max number of results to return. + + See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) + for more information. +required: false +example: 10000 +schema: + type: integer + format: int32 + minimum: 0 + maximum: 10000 + default: 10000 \ No newline at end of file diff --git a/static/api-specs/idn/v3/paths/access-requests.yaml b/static/api-specs/idn/v3/paths/access-requests.yaml index d0279b254..ceaa137b8 100644 --- a/static/api-specs/idn/v3/paths/access-requests.yaml +++ b/static/api-specs/idn/v3/paths/access-requests.yaml @@ -27,6 +27,7 @@ post: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. + * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the access will be removed on that date and time only for roles and access profiles. Entitlements are currently unsupported for `removeDate`. * Roles, access profiles, and entitlements can be requested for revocation. diff --git a/static/api-specs/idn/v3/paths/account.yaml b/static/api-specs/idn/v3/paths/account.yaml index e34adc80e..0fc59bef2 100644 --- a/static/api-specs/idn/v3/paths/account.yaml +++ b/static/api-specs/idn/v3/paths/account.yaml @@ -4,7 +4,7 @@ get: - Accounts summary: Account Details description: >- - This API returns the details for a single account based on the ID. + Use this API to return the details for a single account by its ID. A token with ORG_ADMIN authority is required to call this API. security: @@ -15,11 +15,11 @@ get: schema: type: string required: true - description: The account ID + description: Account ID. example: ef38f94347e94562b5bb8424a56397d8 responses: "200": - description: An account object + description: Account object. content: application/json: schema: @@ -42,20 +42,16 @@ patch: - Accounts summary: Update Account description: >- - Use this API to modify the following fields: + Use this API to update the account with a PATCH request. + + This endpoint can only modify these fields: * `identityId` - * `manuallyCorrelated` - - >**NOTE: All other fields cannot be modified.** - - The request must provide a JSONPatch payload. - A token with ORG_ADMIN authority is required to call this API. security: - UserContextAuth: [idn:accounts:manage] @@ -65,7 +61,7 @@ patch: schema: type: string required: true - description: The account ID + description: Account ID. example: ef38f94347e94562b5bb8424a56397d8 requestBody: required: true @@ -104,12 +100,13 @@ put: - Accounts summary: Update Account description: >- - This API submits an account update task and returns the task ID. + Use this API to update an account with a PUT request. + + This endpoint 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.** + >**NOTE: You can only use this PUT endpoint to update accounts from sources of the "DelimitedFile" type.** security: - UserContextAuth: [idn:accounts:manage] parameters: @@ -118,7 +115,7 @@ put: schema: type: string required: true - description: The account ID + description: Account ID. example: ef38f94347e94562b5bb8424a56397d8 requestBody: required: true @@ -128,7 +125,7 @@ put: $ref: "../schemas/AccountAttributes.yaml" responses: "202": - description: Async task details + description: Async task details. content: application/json: schema: @@ -151,12 +148,16 @@ delete: - 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. + Use this API to delete an account. + + This endpoint submits an account delete task and returns the task ID. + + This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account's returning with the next aggregation between the source and IdentityNow. + To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. A token with ORG_ADMIN authority is required to call this API. + + >**NOTE: You can only delete accounts from sources of the "DelimitedFile" type.** security: - UserContextAuth: [idn:accounts:manage] parameters: @@ -165,11 +166,11 @@ delete: schema: type: string required: true - description: The account ID + description: Account ID. example: ef38f94347e94562b5bb8424a56397d8 responses: "202": - description: Async task details + description: Async task details. content: application/json: schema: diff --git a/static/api-specs/idn/v3/paths/accounts.yaml b/static/api-specs/idn/v3/paths/accounts.yaml index 0391a4d10..9aa19b6c0 100644 --- a/static/api-specs/idn/v3/paths/accounts.yaml +++ b/static/api-specs/idn/v3/paths/accounts.yaml @@ -58,7 +58,7 @@ get: Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, identity.name** + Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, identity.name** responses: "200": description: List of account objects @@ -88,6 +88,8 @@ post: The `sourceId` where this account will be created must be included in the `attributes` object. + >**Note: This API only supports account creation for file based sources.** + A token with ORG_ADMIN authority is required to call this API. security: - UserContextAuth: [idn:accounts:manage] diff --git a/static/api-specs/idn/v3/paths/auth-user.yaml b/static/api-specs/idn/v3/paths/auth-user.yaml index 54f8bdc7c..4e5ceb661 100644 --- a/static/api-specs/idn/v3/paths/auth-user.yaml +++ b/static/api-specs/idn/v3/paths/auth-user.yaml @@ -4,9 +4,7 @@ get: - Auth User summary: Auth User Details description: >- - This API returns the specified user's authentication system details. - - Requires security scope of: 'sp:auth-user:read' + Return the specified user's authentication system details. parameters: - in: path name: id @@ -43,7 +41,13 @@ patch: tags: - Auth User summary: Auth User Update - description: Update an existing user in the authentication system with a PATCH request. + description: >- + Use a PATCH request to update an existing user in the authentication system. + + Use this endpoint to modify these fields: + * `capabilities` + + A '400.1.1 Illegal update attempt' detail code indicates that you attempted to PATCH a field that is not allowed. security: - UserContextAuth: [sp:auth-user:update] parameters: @@ -57,20 +61,8 @@ patch: example: ef38f94347e94562b5bb8424a56397d8 requestBody: required: true - description: | + description: >- A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - PATCH can only be applied to the following fields: - * "capabilities" - - A list of valid capabilities can be found using the GET ams/v3/authorization/authorization-capabilities/ endpoint. - Capabilities can only be patched if they are administrator assignable, as indicated by the 'adminAssignable' field from the output of list authorization-capabilities. - Capabilities that have a legacy group ('legacyGroup' field) need to be patched using the legacyGroup name (e.g. 'ORG_ADMIN'). - Capabilities that are adminAssignable but do not have a legacyGroup can be patched using the ams id (e.g. 'cam:new-role'). - - A 400.1.1 Illegal update attempt detail code indicates that you attempted to PATCH a field that is not allowed. - - Requires security scope of 'sp:auth-user:update' content: application/json-patch+json: schema: diff --git a/static/api-specs/idn/v3/paths/branding.yaml b/static/api-specs/idn/v3/paths/branding.yaml new file mode 100644 index 000000000..c4eb7b6f6 --- /dev/null +++ b/static/api-specs/idn/v3/paths/branding.yaml @@ -0,0 +1,116 @@ +get: + operationId: getBranding + tags: + - Branding + summary: Get a branding item + description: >- + This API endpoint retrieves information for an existing branding item by name. + + A token with API, ORG_ADMIN authority is required to call this API. + security: + - UserContextAuth: [ idn:branding:read ] + parameters: + - in: path + name: name + schema: + type: string + required: true + description: The name of the branding item to be retrieved + example: default + responses: + '200': + description: A branding item object + content: + application/json: + schema: + $ref: "../schemas/BrandingItem.yaml" + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +put: + operationId: setBrandingItem + tags: + - Branding + summary: Update a branding item + description: >- + This API endpoint updates information for an existing branding item. + + A token with API, ORG_ADMIN authority is required to call this API. + parameters: + - in: path + name: name + schema: + type: string + required: true + description: The name of the branding item to be retrieved + example: default + requestBody: + required: true + content: + multipart/form-data: + schema: + $ref: '../schemas/BrandingItemCreate.yaml' + security: + - UserContextAuth: [ idn:branding:write ] + responses: + '200': + description: Branding item updated + content: + application/json: + schema: + $ref: "../schemas/BrandingItem.yaml" + '400': + $ref: '../../v3/responses/400.yaml' + '401': + $ref: '../../v3/responses/401.yaml' + '403': + $ref: '../../v3/responses/403.yaml' + '404': + $ref: '../../v3/responses/404.yaml' + '429': + $ref: '../../v3/responses/429.yaml' + '500': + $ref: '../../v3/responses/500.yaml' +delete: + operationId: deleteBranding + tags: + - Branding + summary: Delete a branding item + description: >- + This API endpoint delete information for an existing branding item by name. + + A token with API, ORG_ADMIN authority is required to call this API. + security: + - UserContextAuth: [ idn:branding:write ] + parameters: + - in: path + name: name + schema: + type: string + required: true + description: The name of the branding item to be deleted + example: default + responses: + '204': + $ref: "../responses/204.yaml" + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v3/paths/brandings.yaml b/static/api-specs/idn/v3/paths/brandings.yaml new file mode 100644 index 000000000..8e061aa71 --- /dev/null +++ b/static/api-specs/idn/v3/paths/brandings.yaml @@ -0,0 +1,65 @@ +get: + operationId: getBrandingList + tags: + - Branding + summary: List of branding items + description: >- + This API endpoint returns a list of branding items. + + + A token with API, ORG_ADMIN authority is required to call this API. + security: + - UserContextAuth: [ idn:branding:read ] + responses: + '200': + description: A list of branding items. + content: + application/json: + schema: + type: array + items: + $ref: "../schemas/BrandingItem.yaml" + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +post: + operationId: createBrandingItem + tags: + - Branding + summary: Create a branding item + description: >- + This API endpoint creates a branding item. + + A token with API, ORG_ADMIN authority is required to call this API. + requestBody: + required: true + content: + multipart/form-data: + schema: + $ref: '../schemas/BrandingItemCreate.yaml' + security: + - UserContextAuth: [ idn:branding:write ] + responses: + '201': + description: Branding item created + content: + application/json: + schema: + $ref: "../schemas/BrandingItem.yaml" + '400': + $ref: '../../v3/responses/400.yaml' + '401': + $ref: '../../v3/responses/401.yaml' + '403': + $ref: '../../v3/responses/403.yaml' + '429': + $ref: '../../v3/responses/429.yaml' + '500': + $ref: '../../v3/responses/500.yaml' diff --git a/static/api-specs/idn/v3/paths/campaign-filters.yaml b/static/api-specs/idn/v3/paths/campaign-filters.yaml index eaa9eab20..2e02f6fbb 100644 --- a/static/api-specs/idn/v3/paths/campaign-filters.yaml +++ b/static/api-specs/idn/v3/paths/campaign-filters.yaml @@ -74,55 +74,66 @@ get: content: application/json: schema: - type: array - items: - $ref: '../schemas/CampaignFilterDetails.yaml' - example: [ - { - "id": "5b8a2ba86393dd174495c4436dd76b25", - "name": "IdentityAttribute Inclusion Campaign Filter", - "description": "IdentityAttribute Inclusion Campaign Filter", - "owner": "SailPoint Support", - "mode": "INCLUSION", - "criteriaList": [ - { - "type": "IDENTITY_ATTRIBUTE", - "property": "displayName", - "value": "#", - "operation": "CONTAINS", - "negateResult": false, - "shortCircuit": false, - "recordChildMatches": false, - "id": null, - "suppressMatchedItems": false, - "children": null - } - ], - "isSystemFilter": false - }, - { - "id": "e9f9a1397b842fd5a65842087040d3ac", - "name": "Exclusion Campaign Filter", - "description": "Campaign filter for Exclusion update", - "owner": "SailPoint Support", - "mode": "EXCLUSION", - "criteriaList": [ - { - "type": "IDENTITY_ATTRIBUTE", - "property": "displayName", - "value": "#@", - "operation": "CONTAINS", - "negateResult": false, - "shortCircuit": false, - "recordChildMatches": false, - "id": null, - "suppressMatchedItems": false, - "children": null - } - ], - "isSystemFilter": false - } - ] + type: object + properties: + items: + type: array + description: The list of campaign filters + items: + $ref: '../schemas/CampaignFilterDetails.yaml' + count: + type: integer + description: The number of filters returned + example: 2 + example: { + "items": [ + { + "id": "5b8a2ba86393dd174495c4436dd76b25", + "name": "IdentityAttribute Inclusion Campaign Filter", + "description": "IdentityAttribute Inclusion Campaign Filter", + "owner": "SailPoint Support", + "mode": "INCLUSION", + "criteriaList": [ + { + "type": "IDENTITY_ATTRIBUTE", + "property": "displayName", + "value": "#", + "operation": "CONTAINS", + "negateResult": false, + "shortCircuit": false, + "recordChildMatches": false, + "id": null, + "suppressMatchedItems": false, + "children": null + } + ], + "isSystemFilter": false + }, + { + "id": "e9f9a1397b842fd5a65842087040d3ac", + "name": "Exclusion Campaign Filter", + "description": "Campaign filter for Exclusion update", + "owner": "SailPoint Support", + "mode": "EXCLUSION", + "criteriaList": [ + { + "type": "IDENTITY_ATTRIBUTE", + "property": "displayName", + "value": "#@", + "operation": "CONTAINS", + "negateResult": false, + "shortCircuit": false, + "recordChildMatches": false, + "id": null, + "suppressMatchedItems": false, + "children": null + } + ], + "isSystemFilter": false + } + ], + "count": 2 + } '400': $ref: '../responses/400.yaml' '401': diff --git a/static/api-specs/idn/v3/paths/connectors-correlation-config.yaml b/static/api-specs/idn/v3/paths/connectors-correlation-config.yaml new file mode 100644 index 000000000..a4fc4ec61 --- /dev/null +++ b/static/api-specs/idn/v3/paths/connectors-correlation-config.yaml @@ -0,0 +1,91 @@ +get: + tags: + - Connectors + operationId: getConnectorCorrelationConfig + description: >- + Fetches a connector's correlation config using its script name. + + A token with ORG_ADMIN authority is required to call this API. + parameters: + - name: scriptName + in: path + description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + required: true + style: simple + explode: false + schema: + type: string + example: aScriptName + responses: + '200': + description: The connector's correlation config + content: + application/xml: + schema: + type: string + '400': + $ref: '../../v3/responses/400.yaml' + '401': + $ref: '../../v3/responses/401.yaml' + '403': + $ref: '../../v3/responses/403.yaml' + '404': + $ref: '../../v3/responses/404.yaml' + '429': + $ref: '../../v3/responses/429.yaml' + '500': + $ref: '../../v3/responses/500.yaml' + security: + - UserContextAuth: [ idn:connector-config:read ] +put: + tags: + - Connectors + operationId: putCorrelationConfig + description: >- + Update a connector's correlation config using its script name. + + A token with ORG_ADMIN authority is required to call this API. + parameters: + - name: scriptName + in: path + description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + required: true + style: simple + explode: false + schema: + type: string + example: aScriptName + requestBody: + required: true + content: + multipart/form-data: + schema: + type: object + required: + - file + properties: + file: + type: string + description: connector correlation config xml file + format: binary + responses: + '200': + description: The connector's update detail + content: + application/json: + schema: + $ref: '../schemas/UpdateDetail.yaml' + '400': + $ref: '../../v3/responses/400.yaml' + '401': + $ref: '../../v3/responses/401.yaml' + '403': + $ref: '../../v3/responses/403.yaml' + '404': + $ref: '../../v3/responses/404.yaml' + '429': + $ref: '../../v3/responses/429.yaml' + '500': + $ref: '../../v3/responses/500.yaml' + security: + - UserContextAuth: [ idn:connector-config:update ] \ No newline at end of file diff --git a/static/api-specs/idn/v3/paths/connectors-create-custom-connector.yaml b/static/api-specs/idn/v3/paths/connectors-create-custom-connector.yaml new file mode 100644 index 000000000..f9e143b58 --- /dev/null +++ b/static/api-specs/idn/v3/paths/connectors-create-custom-connector.yaml @@ -0,0 +1,37 @@ +post: + tags: + - Connectors + operationId: createCustomConnector + summary: Create custom connector + description: >- + Create custom connector. + + A token with ORG_ADMIN authority is required to call this API. + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/V3CreateConnectorDto.yaml' + responses: + '200': + description: A Connector Dto object + content: + application/json: + schema: + $ref: '../schemas/V3ConnectorDto.yaml' + '400': + $ref: '../../v3/responses/400.yaml' + '401': + $ref: '../../v3/responses/401.yaml' + '403': + $ref: '../../v3/responses/403.yaml' + '404': + $ref: '../../v3/responses/404.yaml' + '429': + $ref: '../../v3/responses/429.yaml' + '500': + $ref: '../../v3/responses/500.yaml' + security: + - UserContextAuth: [ idn:connector-config:create ] + diff --git a/static/api-specs/idn/v3/paths/connectors-source-config.yaml b/static/api-specs/idn/v3/paths/connectors-source-config.yaml new file mode 100644 index 000000000..d1ad5a098 --- /dev/null +++ b/static/api-specs/idn/v3/paths/connectors-source-config.yaml @@ -0,0 +1,91 @@ +get: + tags: + - Connectors + operationId: getConnectorSourceConfig + description: >- + Fetches a connector's source config using its script name. + + A token with ORG_ADMIN authority is required to call this API. + parameters: + - name: scriptName + in: path + description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + required: true + style: simple + explode: false + schema: + type: string + example: aScriptName + responses: + '200': + description: The connector's source template + content: + application/xml: + schema: + type: string + '400': + $ref: '../../v3/responses/400.yaml' + '401': + $ref: '../../v3/responses/401.yaml' + '403': + $ref: '../../v3/responses/403.yaml' + '404': + $ref: '../../v3/responses/404.yaml' + '429': + $ref: '../../v3/responses/429.yaml' + '500': + $ref: '../../v3/responses/500.yaml' + security: + - UserContextAuth: [ idn:connector-config:read ] +put: + tags: + - Connectors + operationId: putSourceConfig + description: >- + Update a connector's source config using its script name. + + A token with ORG_ADMIN authority is required to call this API. + parameters: + - name: scriptName + in: path + description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + required: true + style: simple + explode: false + schema: + type: string + example: aScriptName + requestBody: + required: true + content: + multipart/form-data: + schema: + type: object + required: + - file + properties: + file: + type: string + description: connector source config xml file + format: binary + responses: + '200': + description: The connector's update detail + content: + application/json: + schema: + $ref: '../schemas/UpdateDetail.yaml' + '400': + $ref: '../../v3/responses/400.yaml' + '401': + $ref: '../../v3/responses/401.yaml' + '403': + $ref: '../../v3/responses/403.yaml' + '404': + $ref: '../../v3/responses/404.yaml' + '429': + $ref: '../../v3/responses/429.yaml' + '500': + $ref: '../../v3/responses/500.yaml' + security: + - UserContextAuth: [ idn:connector-config:update ] \ No newline at end of file diff --git a/static/api-specs/idn/v3/paths/connectors-source-template.yaml b/static/api-specs/idn/v3/paths/connectors-source-template.yaml new file mode 100644 index 000000000..b20808a19 --- /dev/null +++ b/static/api-specs/idn/v3/paths/connectors-source-template.yaml @@ -0,0 +1,91 @@ +get: + tags: + - Connectors + operationId: getConnectorSourceTemplate + description: >- + Fetches a connector's source template using its script name. + + A token with ORG_ADMIN authority is required to call this API. + parameters: + - name: scriptName + in: path + description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + required: true + style: simple + explode: false + schema: + type: string + example: aScriptName + responses: + '200': + description: The connector's source template + content: + application/xml: + schema: + type: string + '400': + $ref: '../../v3/responses/400.yaml' + '401': + $ref: '../../v3/responses/401.yaml' + '403': + $ref: '../../v3/responses/403.yaml' + '404': + $ref: '../../v3/responses/404.yaml' + '429': + $ref: '../../v3/responses/429.yaml' + '500': + $ref: '../../v3/responses/500.yaml' + security: + - UserContextAuth: [ idn:connector-config:read ] +put: + tags: + - Connectors + operationId: putSourceTemplate + description: >- + Update a connector's source template using its script name. + + A token with ORG_ADMIN authority is required to call this API. + parameters: + - name: scriptName + in: path + description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + required: true + style: simple + explode: false + schema: + type: string + example: aScriptName + requestBody: + required: true + content: + multipart/form-data: + schema: + type: object + required: + - file + properties: + file: + type: string + description: connector source template xml file + format: binary + responses: + '200': + description: The connector's update detail + content: + application/json: + schema: + $ref: '../schemas/UpdateDetail.yaml' + '400': + $ref: '../../v3/responses/400.yaml' + '401': + $ref: '../../v3/responses/401.yaml' + '403': + $ref: '../../v3/responses/403.yaml' + '404': + $ref: '../../v3/responses/404.yaml' + '429': + $ref: '../../v3/responses/429.yaml' + '500': + $ref: '../../v3/responses/500.yaml' + security: + - UserContextAuth: [ idn:connector-config:update ] \ No newline at end of file diff --git a/static/api-specs/idn/v3/paths/connectors-translations.yaml b/static/api-specs/idn/v3/paths/connectors-translations.yaml new file mode 100644 index 000000000..80d3bcd21 --- /dev/null +++ b/static/api-specs/idn/v3/paths/connectors-translations.yaml @@ -0,0 +1,102 @@ +get: + tags: + - Connectors + operationId: getConnectorTranslations + description: >- + Fetches a connector's translations using its script name. + + A token with ORG_ADMIN authority is required to call this API. + parameters: + - name: scriptName + in: path + description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + required: true + style: simple + explode: false + schema: + type: string + example: aScriptName + - name: locale + in: path + required: true + schema: + type: string + enum: [de, no, fi, sv, ru, pt, ko, zh-TW, en, it, fr, zh-CN, hu, es, cs, ja, pl, da, nl] + example: de + description: >- + The locale to apply to the config. If no viable locale is given, it will default to "en" + responses: + '200': + description: The connector's translations + content: + text/plain: + schema: + type: string + '400': + $ref: '../../v3/responses/400.yaml' + '401': + $ref: '../../v3/responses/401.yaml' + '403': + $ref: '../../v3/responses/403.yaml' + '404': + $ref: '../../v3/responses/404.yaml' + '429': + $ref: '../../v3/responses/429.yaml' + '500': + $ref: '../../v3/responses/500.yaml' + security: + - UserContextAuth: [ idn:connector-config:read ] +put: + tags: + - Connectors + operationId: putTranslations + description: >- + Update a connector's translations using its script name. + + A token with ORG_ADMIN authority is required to call this API. + parameters: + - name: scriptName + in: path + description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + required: true + style: simple + explode: false + schema: + type: string + example: aScriptName + - name: locale + in: path + required: true + schema: + type: string + enum: [de, no, fi, sv, ru, pt, ko, zh-TW, en, it, fr, zh-CN, hu, es, cs, ja, pl, da, nl] + example: de + description: >- + The locale to apply to the config. If no viable locale is given, it will default to "en" + requestBody: + required: true + content: + multipart/form-data: + schema: + type: object + responses: + '200': + description: The connector's update detail + content: + application/json: + schema: + $ref: '../schemas/UpdateDetail.yaml' + '400': + $ref: '../../v3/responses/400.yaml' + '401': + $ref: '../../v3/responses/401.yaml' + '403': + $ref: '../../v3/responses/403.yaml' + '404': + $ref: '../../v3/responses/404.yaml' + '429': + $ref: '../../v3/responses/429.yaml' + '500': + $ref: '../../v3/responses/500.yaml' + security: + - UserContextAuth: [ idn:connector-config:update ] \ No newline at end of file diff --git a/static/api-specs/idn/v3/paths/connectors.yaml b/static/api-specs/idn/v3/paths/connectors.yaml new file mode 100644 index 000000000..d9cf61bb0 --- /dev/null +++ b/static/api-specs/idn/v3/paths/connectors.yaml @@ -0,0 +1,139 @@ +get: + tags: + - Connectors + operationId: getConnector + description: >- + Fetches a connector that using its script name. + + A token with ORG_ADMIN authority is required to call this API. + parameters: + - name: scriptName + in: path + description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + required: true + style: simple + explode: false + schema: + type: string + example: aScriptName + - in: query + name: locale + schema: + type: string + enum: [ de, no, fi, sv, ru, pt, ko, zh-TW, en, it, fr, zh-CN, hu, es, cs, ja, pl, da, nl ] + example: de + description: >- + The locale to apply to the config. If no viable locale is given, it will default to "en" + responses: + '200': + description: A Connector Dto object + content: + application/json: + schema: + $ref: '../schemas/ConnectorDetail.yaml' + '400': + $ref: '../../v3/responses/400.yaml' + '401': + $ref: '../../v3/responses/401.yaml' + '403': + $ref: '../../v3/responses/403.yaml' + '404': + $ref: '../../v3/responses/404.yaml' + '429': + $ref: '../../v3/responses/429.yaml' + '500': + $ref: '../../v3/responses/500.yaml' + security: + - UserContextAuth: [ idn:connector-config:read ] +delete: + tags: + - Connectors + operationId: deleteCustomConnector + description: >- + Delete a custom connector that using its script name. + + A token with ORG_ADMIN authority is required to call this API. + parameters: + - name: scriptName + in: path + description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + required: true + style: simple + explode: false + schema: + type: string + example: aScriptName + responses: + '204': + $ref: '../../v3/responses/204.yaml' + description: The custom connector was successfully deleted. + '400': + $ref: '../../v3/responses/400.yaml' + '401': + $ref: '../../v3/responses/401.yaml' + '403': + $ref: '../../v3/responses/403.yaml' + '404': + $ref: '../../v3/responses/404.yaml' + '429': + $ref: '../../v3/responses/429.yaml' + '500': + $ref: '../../v3/responses/500.yaml' + security: + - UserContextAuth: [ idn:connector-config:delete ] +patch: + tags: + - Connectors + operationId: updateConnector + description: >- + Patch a custom connector that using its script name. + + A token with ORG_ADMIN authority is required to call this API. + The following fields are patchable: + * connectorMetadata + * applicationXml + * correlationConfigXml + * sourceConfigXml + parameters: + - name: scriptName + in: path + description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + required: true + style: simple + explode: false + schema: + type: string + example: aScriptName + requestBody: + required: true + description: >- + A list of connector detail update operations according to + the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + content: + application/json-patch+json: + schema: + type: array + items: + $ref: "../schemas/JsonPatchOperation.yaml" + responses: + '200': + description: A updated Connector Dto object + content: + application/json: + schema: + $ref: '../schemas/ConnectorDetail.yaml' + '400': + $ref: '../../v3/responses/400.yaml' + '401': + $ref: '../../v3/responses/401.yaml' + '403': + $ref: '../../v3/responses/403.yaml' + '404': + $ref: '../../v3/responses/404.yaml' + '429': + $ref: '../../v3/responses/429.yaml' + '500': + $ref: '../../v3/responses/500.yaml' + security: + - UserContextAuth: [ idn:connector-config:update ] + diff --git a/static/api-specs/idn/v3/paths/password-dictionary.yaml b/static/api-specs/idn/v3/paths/password-dictionary.yaml index 76db1739e..0c2717abe 100644 --- a/static/api-specs/idn/v3/paths/password-dictionary.yaml +++ b/static/api-specs/idn/v3/paths/password-dictionary.yaml @@ -7,54 +7,54 @@ get: This gets password dictionary for the organization. A token with ORG_ADMIN authority is required to call this API. + + The password dictionary file can contain lines that are: + + 1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing + + 2. empty lines + + 3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines + + 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; + maximum length of the line is 128 Unicode codepoints + + + Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). + Password dict file must contain UTF-8 characters only. + + # Sample password text file + + + ``` + + + # Password dictionary small test file + + + locale=en_US + + + # Password dictionary prohibited words + + + qwerty + + abcd + + aaaaa + + password + + qazxsws + + + ``` security: - UserContextAuth: [idn:password-dictionary-management:read] responses: '200': - description: >- - - The password dictionary file can contain lines that are: - - 1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing - - 2. empty lines - - 3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines - - 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; - maximum length of the line is 128 Unicode codepoints - - - Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). - Password dict file must contain UTF-8 characters only. - - # Sample password text file - - - ``` - - - # Password dictionary small test file - - - locale=en_US - - - # Password dictionary prohibited words - - - qwerty - - abcd - - aaaaa - - password - - qazxsws - - - ``` + description: A password dictionary response content: text/plain: schema: @@ -72,7 +72,7 @@ get: '500': $ref: '../responses/500.yaml' put: - operationId: updatePasswordDictionary + operationId: putPasswordDictionary tags: - Password Dictionary summary: Update Password Dictionary @@ -80,54 +80,54 @@ put: This updates password dictionary for the organization. A token with ORG_ADMIN authority is required to call this API. + + The password dictionary file can contain lines that are: + + 1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing + + 2. empty lines + + 3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines + + 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; + maximum length of the line is 128 Unicode codepoints + + + Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). + Password dict file must contain UTF-8 characters only. + + # Sample password text file + + + ``` + + + # Password dictionary small test file + + + locale=en_US + + + # Password dictionary prohibited words + + + qwerty + + abcd + + aaaaa + + password + + qazxsws + + + ``` security: - UserContextAuth: [idn:password-dictionary:manage] requestBody: required: true - description: >- - - The password dictionary file can contain lines that are: - - 1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing - - 2. empty lines - - 3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines - - 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; - maximum length of the line is 128 Unicode codepoints - - - Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). - Password dict file must contain UTF-8 characters only. - - # Sample password text file - - - ``` - - - # Password dictionary small test file - - - locale=en_US - - - # Password dictionary prohibited words - - - qwerty - - abcd - - aaaaa - - password - - qazxsws - - - ``` + description: The password dictionary file to be uploaded. content: multipart/form-data: schema: diff --git a/static/api-specs/idn/v3/paths/reports-get-file.yaml b/static/api-specs/idn/v3/paths/reports-get-file.yaml index 38acb8038..cc4204a80 100644 --- a/static/api-specs/idn/v3/paths/reports-get-file.yaml +++ b/static/api-specs/idn/v3/paths/reports-get-file.yaml @@ -45,9 +45,13 @@ get: Event will be created if there is any result present by requested taskResultId. responses: '200': - description: Details about running report task. + description: Report file in selected format. CSV by default. content: - application/octet-stream: + application/csv: + schema: + type: string + format: binary + application/pdf: schema: type: string format: binary diff --git a/static/api-specs/idn/v3/paths/saved-searches.yaml b/static/api-specs/idn/v3/paths/saved-searches.yaml index 6c10470fd..71d223a19 100644 --- a/static/api-specs/idn/v3/paths/saved-searches.yaml +++ b/static/api-specs/idn/v3/paths/saved-searches.yaml @@ -1,4 +1,6 @@ post: + security: + - UserContextAuth: [sp:saved-search:create] tags: - Saved Search description: | @@ -23,14 +25,22 @@ post: $ref: '../schemas/search/saved/SavedSearch.yaml' '400': $ref: '../responses/400.yaml' - '403': - $ref: '../responses/403.yaml' + "401": + $ref: "../responses/401.yaml" + "403": + $ref: "../responses/403.yaml" + "429": + $ref: "../responses/429.yaml" + "500": + $ref: "../responses/500.yaml" get: + security: + - UserContextAuth: [sp:saved-search:read] tags: - Saved Search description: | Returns a list of saved searches. - summary: Return a list of Saved Searches + summary: A list of Saved Searches operationId: listSavedSearches parameters: - $ref: '../parameters/offset.yaml' @@ -48,10 +58,7 @@ get: **owner.id**: *eq* - - - **publiic**: *eq* - example: public eq true + example: owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8" responses: '200': description: The list of requested saved searches. @@ -69,5 +76,11 @@ get: example: 5 '400': $ref: '../responses/400.yaml' - '403': - $ref: '../responses/403.yaml' + "401": + $ref: "../responses/401.yaml" + "403": + $ref: "../responses/403.yaml" + "429": + $ref: "../responses/429.yaml" + "500": + $ref: "../responses/500.yaml" diff --git a/static/api-specs/idn/v3/paths/scheduled-searches.yaml b/static/api-specs/idn/v3/paths/scheduled-searches.yaml index 87f7f168b..0b74c4aea 100644 --- a/static/api-specs/idn/v3/paths/scheduled-searches.yaml +++ b/static/api-specs/idn/v3/paths/scheduled-searches.yaml @@ -98,6 +98,43 @@ post: } ] } + Annual Search: + description: A search that executes each year on the defined months, days, and times. + value: + { + "savedSearchId": "9c620e13-cd33-4804-a13d-403bd7bcdbad", + "schedule": { + "type": "ANNUALLY", + "months": { + "type": "LIST", + "values": [ + "1" + ], + "interval": 3 + }, + "days": { + "type": "LIST", + "values": [ + "1", + "7", + "14", + "L" + ] + }, + "hours": { + "type": "LIST", + "values": [ + "9" + ] + } + }, + "recipients": [ + { + "type": "IDENTITY", + "id": "2c9180867624cbd7017642d8c8c81f67" + } + ] + } Calendar Search: description: A search that executes on specific calendar days value: diff --git a/static/api-specs/idn/v3/paths/search-aggregate.yaml b/static/api-specs/idn/v3/paths/search-aggregate.yaml index af7b0fd7d..8c3b372f8 100644 --- a/static/api-specs/idn/v3/paths/search-aggregate.yaml +++ b/static/api-specs/idn/v3/paths/search-aggregate.yaml @@ -7,6 +7,8 @@ post: To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. operationId: searchAggregate + security: + - UserContextAuth: [ sp:search:read ] summary: "Perform a Search Query Aggregation" parameters: - $ref: '../parameters/offset.yaml' diff --git a/static/api-specs/idn/v3/paths/search-count.yaml b/static/api-specs/idn/v3/paths/search-count.yaml index 0fbd8ac1c..ffc6311a4 100644 --- a/static/api-specs/idn/v3/paths/search-count.yaml +++ b/static/api-specs/idn/v3/paths/search-count.yaml @@ -4,6 +4,8 @@ post: description: >- Performs a search with a provided query and returns the count of results in the X-Total-Count header. operationId: searchCount + security: + - UserContextAuth: [ sp:search:read ] summary: "Count Documents Satisfying a Query" requestBody: content: diff --git a/static/api-specs/idn/v3/paths/search-get.yaml b/static/api-specs/idn/v3/paths/search-get.yaml index ccf77bbe8..d56a0ce6e 100644 --- a/static/api-specs/idn/v3/paths/search-get.yaml +++ b/static/api-specs/idn/v3/paths/search-get.yaml @@ -4,6 +4,8 @@ get: description: >- Fetches a single document from the specified index, using the specified document ID. operationId: searchGet + security: + - UserContextAuth: [ sp:search:read ] summary: "Get a Document by ID" parameters: - $ref: '../parameters/path/search/index.yaml' diff --git a/static/api-specs/idn/v3/paths/search-post.yaml b/static/api-specs/idn/v3/paths/search-post.yaml index 09c736c39..6eb80f0ce 100644 --- a/static/api-specs/idn/v3/paths/search-post.yaml +++ b/static/api-specs/idn/v3/paths/search-post.yaml @@ -15,7 +15,7 @@ post: summary: "Perform Search" parameters: - $ref: '../parameters/offset.yaml' - - $ref: '../parameters/limit.yaml' + - $ref: '../parameters/searchlimit.yaml' - $ref: '../parameters/count.yaml' requestBody: content: diff --git a/static/api-specs/idn/v3/paths/service-desk-integration.yaml b/static/api-specs/idn/v3/paths/service-desk-integration.yaml index 5afcc45ea..49189c702 100644 --- a/static/api-specs/idn/v3/paths/service-desk-integration.yaml +++ b/static/api-specs/idn/v3/paths/service-desk-integration.yaml @@ -136,28 +136,32 @@ patch: description: | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - PATCH can only be applied to the following fields: - * `beforeProvisioningRule` - * `description` - * `ownerRef` - - A 403 Forbidden Error indicates that you attempted to PATCH a field that is not allowed. + Only `replace` operations are accepted by this endpoint. + + A 403 Forbidden Error indicates that you attempted to PATCH a operation that is not allowed. content: application/json-patch+json: schema: - $ref: '../schemas/JsonPatch.yaml' - example: - [ - { - "op": "replace", - "path": "/ownerRef", - "value": { - "id": "2c9180867d05b227017d09921a205b4d", - "type": "IDENTITY", - "name": "Angelo2 tester" + type: object + description: A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902). Only `replace` operations are accepted by this endpoint. + properties: + operations: + description: Operations to be applied + type: array + items: + $ref: '../schemas/JsonPatchOperation.yaml' + example: >- + [ + { + "op": "replace", + "path": "/ownerRef", + "value": { + "id": "2c9180867d05b227017d09921a205b4d", + "type": "IDENTITY", + "name": "Angelo2 tester" + } } - } - ] + ] responses: "200": description: ServiceDeskIntegrationDto as updated diff --git a/static/api-specs/idn/v3/paths/sources.yaml b/static/api-specs/idn/v3/paths/sources.yaml index 001a52b78..64c1ee466 100644 --- a/static/api-specs/idn/v3/paths/sources.yaml +++ b/static/api-specs/idn/v3/paths/sources.yaml @@ -40,10 +40,10 @@ get: **features**: *ca, co* - **created**: *eq* + **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* - **modified**: *eq* + **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* diff --git a/static/api-specs/idn/v3/paths/tagged-objects-type.yaml b/static/api-specs/idn/v3/paths/tagged-objects-type.yaml index 747413f35..69177edd1 100644 --- a/static/api-specs/idn/v3/paths/tagged-objects-type.yaml +++ b/static/api-specs/idn/v3/paths/tagged-objects-type.yaml @@ -4,7 +4,7 @@ get: - UserContextAuth: [ idn:tag:read, idn:tag:manage ] tags: - Tagged Objects - summary: List Tagged Objects + summary: List Tagged Objects by Type description: >- This API returns a list of all tagged objects by type. @@ -16,9 +16,14 @@ get: schema: type: string enum: - - ROLE + - ACCESS_PROFILE + - APPLICATION + - CAMPAIGN + - ENTITLEMENT - IDENTITY + - ROLE - SOD_POLICY + - SOURCE required: true description: The type of tagged object to retrieve. example: ROLE diff --git a/static/api-specs/idn/v3/paths/workflows/workflow-execution-cancel.yaml b/static/api-specs/idn/v3/paths/workflows/workflow-execution-cancel.yaml new file mode 100644 index 000000000..62deffe0c --- /dev/null +++ b/static/api-specs/idn/v3/paths/workflows/workflow-execution-cancel.yaml @@ -0,0 +1,34 @@ +post: + operationId: cancelWorkflowExecution + tags: + - Workflows + summary: Cancel Workflow Execution by ID + description: >- + Use this API to cancel a running workflow execution. + security: + - UserContextAuth: [sp:workflow-execute:external] + parameters: + - name: id + in: path + description: The workflow execution ID + required: true + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + responses: + '204': + $ref: '../../../v3/responses/204.yaml' + '400': + $ref: '../../../v3/responses/400.yaml' + '401': + $ref: '../../../v3/responses/401.yaml' + '403': + $ref: '../../../v3/responses/403.yaml' + '404': + $ref: '../../../v3/responses/404.yaml' + '429': + $ref: '../../../v3/responses/429.yaml' + '500': + $ref: '../../../v3/responses/500.yaml' diff --git a/static/api-specs/idn/v3/paths/workflows/workflow-execution-history.yaml b/static/api-specs/idn/v3/paths/workflows/workflow-execution-history.yaml new file mode 100644 index 000000000..42897c9c2 --- /dev/null +++ b/static/api-specs/idn/v3/paths/workflows/workflow-execution-history.yaml @@ -0,0 +1,41 @@ +get: + operationId: getWorkflowExecutionHistory + tags: + - Workflows + summary: Get Workflow Execution History + description: >- + Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. + security: + - UserContextAuth: [sp:workflow:read] + parameters: + - name: id + in: path + description: Id of the workflow execution + required: true + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + responses: + '200': + description: >- + List of workflow execution events for the given workflow execution + content: + application/json: + schema: + type: array + items: + $ref: '../../schemas/workflows/WorkflowExecutionEvent.yaml' + '400': + $ref: '../../../v3/responses/400.yaml' + '401': + $ref: '../../../v3/responses/401.yaml' + '403': + $ref: '../../../v3/responses/403.yaml' + '404': + $ref: '../../../v3/responses/404.yaml' + '429': + $ref: '../../../v3/responses/429.yaml' + '500': + $ref: '../../../v3/responses/500.yaml' diff --git a/static/api-specs/idn/v3/paths/workflows/workflow-execution.yaml b/static/api-specs/idn/v3/paths/workflows/workflow-execution.yaml new file mode 100644 index 000000000..95f41fd99 --- /dev/null +++ b/static/api-specs/idn/v3/paths/workflows/workflow-execution.yaml @@ -0,0 +1,40 @@ +get: + operationId: getWorkflowExecution + tags: + - Workflows + summary: Get a Workflow Execution + description: >- + Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. + security: + - UserContextAuth: [sp:workflow:read] + parameters: + - name: id + in: path + description: Id of the workflow execution + required: true + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + responses: + '200': + description: >- + The workflow execution + content: + application/json: + schema: + items: + $ref: '../../schemas/workflows/WorkflowExecution.yaml' + '400': + $ref: '../../../v3/responses/400.yaml' + '401': + $ref: '../../../v3/responses/401.yaml' + '403': + $ref: '../../../v3/responses/403.yaml' + '404': + $ref: '../../../v3/responses/404.yaml' + '429': + $ref: '../../../v3/responses/429.yaml' + '500': + $ref: '../../../v3/responses/500.yaml' diff --git a/static/api-specs/idn/v3/paths/workflows/workflow-executions.yaml b/static/api-specs/idn/v3/paths/workflows/workflow-executions.yaml new file mode 100644 index 000000000..1a5faeb7d --- /dev/null +++ b/static/api-specs/idn/v3/paths/workflows/workflow-executions.yaml @@ -0,0 +1,76 @@ +get: + operationId: listWorkflowExecutions + tags: + - Workflows + summary: List Workflow Executions + description: >- + This lists the executions for a given workflow. Workflow executions are available for up to 90 days before being archived. + By default, you can get a maximum of 250 executions. + To get executions past the first 250 records, you can do the following: + + 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. + + 2. Get your workflow ID from the response. + + 3. You can then do either of the following: + + - Filter to find relevant workflow executions. + For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq "Failed"` + + - You can paginate through results with the `offset` parameter. + For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. + Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. + security: + - UserContextAuth: [sp:workflow:read] + parameters: + - name: id + in: path + description: Id of the workflow + required: true + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + - $ref: "../../../v3/parameters/limit.yaml" + - $ref: "../../../v3/parameters/offset.yaml" + - $ref: "../../../v3/parameters/count.yaml" + - in: query + name: filters + schema: + type: string + example: status eq "Failed" + 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: + + + **startTime**: *eq, lt, le, gt, ge* + + + **status**: *eq* + required: false + responses: + '200': + description: >- + List of workflow executions for the given workflow + content: + application/json: + schema: + type: array + items: + $ref: '../../schemas/workflows/WorkflowExecution.yaml' + '400': + $ref: '../../../v3/responses/400.yaml' + '401': + $ref: '../../../v3/responses/401.yaml' + '403': + $ref: '../../../v3/responses/403.yaml' + '404': + $ref: '../../../v3/responses/404.yaml' + '429': + $ref: '../../../v3/responses/429.yaml' + '500': + $ref: '../../../v3/responses/500.yaml' diff --git a/static/api-specs/idn/v3/paths/workflows/workflow-external-execute-test.yaml b/static/api-specs/idn/v3/paths/workflows/workflow-external-execute-test.yaml new file mode 100644 index 000000000..240ad0011 --- /dev/null +++ b/static/api-specs/idn/v3/paths/workflows/workflow-external-execute-test.yaml @@ -0,0 +1,56 @@ +post: + operationId: testExternalExecuteWorkflow + tags: + - Workflows + summary: Test Workflow via External Trigger + description: >- + Validate a workflow with an "External Trigger" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. + security: + - UserContextAuth: [sp:workflow-execute:external] + parameters: + - name: id + in: path + description: Id of the workflow + required: true + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + input: + type: object + description: The test input for the workflow + example: { + "test": "hello world" + } + responses: + '200': + description: Responds with the test input + content: + application/json: + schema: + type: object + properties: + payload: + type: object + description: The input that was received + example: { + "test": "hello world" + } + '400': + $ref: '../../../v3/responses/400.yaml' + '401': + $ref: '../../../v3/responses/401.yaml' + '403': + $ref: '../../../v3/responses/403.yaml' + '429': + $ref: '../../../v3/responses/429.yaml' + '500': + $ref: '../../../v3/responses/500.yaml' diff --git a/static/api-specs/idn/v3/paths/workflows/workflow-external-execute.yaml b/static/api-specs/idn/v3/paths/workflows/workflow-external-execute.yaml new file mode 100644 index 000000000..26381b799 --- /dev/null +++ b/static/api-specs/idn/v3/paths/workflows/workflow-external-execute.yaml @@ -0,0 +1,60 @@ +post: + operationId: createExternalExecuteWorkflow + tags: + - Workflows + summary: Execute Workflow via External Trigger + description: >- + This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the "External Trigger" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. + security: + - UserContextAuth: [sp:workflow-execute:external] + parameters: + - name: id + in: path + description: Id of the workflow + required: true + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + input: + type: object + description: The input for the workflow + example: { + "customAttribute1": "value1", + "customAttribute2": "value2" + } + responses: + '200': + description: The Workflow object + content: + application/json: + schema: + type: object + properties: + workflowExecutionId: + type: string + description: The workflow execution id + example: 0e11cefa-96e7-4b67-90d0-065bc1da5753 + message: + type: string + description: An error message if any errors occurred + example: Workflow was not executed externally. Check enabled flag on workflow definition + + '400': + $ref: '../../../v3/responses/400.yaml' + '401': + $ref: '../../../v3/responses/401.yaml' + '403': + $ref: '../../../v3/responses/403.yaml' + '429': + $ref: '../../../v3/responses/429.yaml' + '500': + $ref: '../../../v3/responses/500.yaml' diff --git a/static/api-specs/idn/v3/paths/workflows/workflow-external-oauth-client.yaml b/static/api-specs/idn/v3/paths/workflows/workflow-external-oauth-client.yaml new file mode 100644 index 000000000..06eca1b83 --- /dev/null +++ b/static/api-specs/idn/v3/paths/workflows/workflow-external-oauth-client.yaml @@ -0,0 +1,36 @@ +post: + operationId: createWorkflowExternalTrigger + tags: + - Workflows + summary: Generate External Trigger OAuth Client + description: >- + Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. + security: + - UserContextAuth: [sp:workflow:manage] + parameters: + - name: id + in: path + description: Id of the workflow + required: true + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + responses: + '200': + description: The OAuth Client object + content: + application/json: + schema: + $ref: '../../schemas/workflows/WorkflowOAuthClient.yaml' + '400': + $ref: '../../../v3/responses/400.yaml' + '401': + $ref: '../../../v3/responses/401.yaml' + '403': + $ref: '../../../v3/responses/403.yaml' + '429': + $ref: '../../../v3/responses/429.yaml' + '500': + $ref: '../../../v3/responses/500.yaml' diff --git a/static/api-specs/idn/v3/paths/workflows/workflow-library-actions.yaml b/static/api-specs/idn/v3/paths/workflows/workflow-library-actions.yaml new file mode 100644 index 000000000..5616308d6 --- /dev/null +++ b/static/api-specs/idn/v3/paths/workflows/workflow-library-actions.yaml @@ -0,0 +1,49 @@ +get: + operationId: listWorkflowLibraryActions + tags: + - Workflows + summary: List Workflow Library Actions + description: >- + This lists the workflow actions available to you. + externalDocs: + description: Additional documentation for each action + url: https://documentation.sailpoint.com/saas/help/workflows/workflow-steps.html#actions + parameters: + - $ref: '../../../v3/parameters/limit.yaml' + - $ref: '../../../v3/parameters/offset.yaml' + - in: query + name: filters + required: false + schema: + type: string + description: >- + Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) + + + Filtering is supported for the following fields and operators: + + + **id**: *eq* + example: id eq "sp:create-campaign" + security: + - UserContextAuth: [sp:workflow:read] + responses: + '200': + description: >- + List of workflow actions + content: + application/json: + schema: + type: array + items: + $ref: '../../schemas/workflows/WorkflowLibraryAction.yaml' + '400': + $ref: '../../../v3/responses/400.yaml' + '401': + $ref: '../../../v3/responses/401.yaml' + '403': + $ref: '../../../v3/responses/403.yaml' + '429': + $ref: '../../../v3/responses/429.yaml' + '500': + $ref: '../../../v3/responses/500.yaml' diff --git a/static/api-specs/idn/v3/paths/workflows/workflow-library-operators.yaml b/static/api-specs/idn/v3/paths/workflows/workflow-library-operators.yaml new file mode 100644 index 000000000..58ca30806 --- /dev/null +++ b/static/api-specs/idn/v3/paths/workflows/workflow-library-operators.yaml @@ -0,0 +1,29 @@ +get: + operationId: listWorkflowLibraryOperators + tags: + - Workflows + summary: List Workflow Library Operators + description: >- + This lists the workflow operators available to you + security: + - UserContextAuth: [sp:workflow:read] + responses: + '200': + description: >- + List of workflow operators + content: + application/json: + schema: + type: array + items: + $ref: '../../schemas/workflows/WorkflowLibraryOperator.yaml' + '400': + $ref: '../../../v3/responses/400.yaml' + '401': + $ref: '../../../v3/responses/401.yaml' + '403': + $ref: '../../../v3/responses/403.yaml' + '429': + $ref: '../../../v3/responses/429.yaml' + '500': + $ref: '../../../v3/responses/500.yaml' diff --git a/static/api-specs/idn/v3/paths/workflows/workflow-library-triggers.yaml b/static/api-specs/idn/v3/paths/workflows/workflow-library-triggers.yaml new file mode 100644 index 000000000..402e97071 --- /dev/null +++ b/static/api-specs/idn/v3/paths/workflows/workflow-library-triggers.yaml @@ -0,0 +1,49 @@ +get: + operationId: listWorkflowLibraryTriggers + tags: + - Workflows + summary: List Workflow Library Triggers + description: >- + This lists the workflow triggers available to you + externalDocs: + description: Additional documentation for each trigger + url: https://documentation.sailpoint.com/saas/help/workflows/workflow-steps.html#triggers + parameters: + - $ref: '../../../v3/parameters/limit.yaml' + - $ref: '../../../v3/parameters/offset.yaml' + - in: query + name: filters + required: false + schema: + type: string + description: >- + Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) + + + Filtering is supported for the following fields and operators: + + + **id**: *eq* + example: id eq "idn:identity-attributes-changed" + security: + - UserContextAuth: [sp:workflow:read] + responses: + '200': + description: >- + List of workflow triggers + content: + application/json: + schema: + type: array + items: + $ref: '../../schemas/workflows/WorkflowLibraryTrigger.yaml' + '400': + $ref: '../../../v3/responses/400.yaml' + '401': + $ref: '../../../v3/responses/401.yaml' + '403': + $ref: '../../../v3/responses/403.yaml' + '429': + $ref: '../../../v3/responses/429.yaml' + '500': + $ref: '../../../v3/responses/500.yaml' diff --git a/static/api-specs/idn/v3/paths/workflows/workflow-library.yaml b/static/api-specs/idn/v3/paths/workflows/workflow-library.yaml new file mode 100644 index 000000000..47dd4afb1 --- /dev/null +++ b/static/api-specs/idn/v3/paths/workflows/workflow-library.yaml @@ -0,0 +1,38 @@ +get: + operationId: listCompleteWorkflowLibrary + tags: + - Workflows + summary: List Complete Workflow Library + description: >- + This lists all triggers, actions, and operators in the library + externalDocs: + description: Additional documentation for workflows + url: https://documentation.sailpoint.com/saas/help/workflows/workflow-steps.html + parameters: + - $ref: '../../../v3/parameters/limit.yaml' + - $ref: '../../../v3/parameters/offset.yaml' + security: + - UserContextAuth: [sp:workflow:read] + responses: + '200': + description: >- + List of workflow steps + content: + application/json: + schema: + type: array + items: + anyOf: + - $ref: '../../schemas/workflows/WorkflowLibraryAction.yaml' + - $ref: '../../schemas/workflows/WorkflowLibraryTrigger.yaml' + - $ref: '../../schemas/workflows/WorkflowLibraryOperator.yaml' + '400': + $ref: '../../../v3/responses/400.yaml' + '401': + $ref: '../../../v3/responses/401.yaml' + '403': + $ref: '../../../v3/responses/403.yaml' + '429': + $ref: '../../../v3/responses/429.yaml' + '500': + $ref: '../../../v3/responses/500.yaml' diff --git a/static/api-specs/idn/v3/paths/workflows/workflow-test.yaml b/static/api-specs/idn/v3/paths/workflows/workflow-test.yaml new file mode 100644 index 000000000..d5948d6cb --- /dev/null +++ b/static/api-specs/idn/v3/paths/workflows/workflow-test.yaml @@ -0,0 +1,96 @@ +post: + operationId: testWorkflow + tags: + - Workflows + summary: Test Workflow By Id + description: >- + Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/idn/docs/event-triggers/available) for an example input for the trigger that initiates this workflow. + + This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. + + **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** + security: + - UserContextAuth: [sp:workflow-execute:external] + parameters: + - name: id + in: path + description: Id of the workflow + required: true + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - input + properties: + input: + type: object + description: The test input for the workflow. + examples: + Identity Attributes Changed: + description: Identity Attributes Changed Trigger Input + value: + { + "input": { + "identity": { + "id": "ee769173319b41d19ccec6cea52f237b", + "name": "john.doe", + "type": "IDENTITY" + }, + "changes": [ + { + "attribute": "department", + "oldValue": "sales", + "newValue": "marketing" + }, + { + "attribute": "manager", + "oldValue": { + "id": "ee769173319b41d19ccec6c235423237b", + "name": "nice.guy", + "type": "IDENTITY" + }, + "newValue": { + "id": "ee769173319b41d19ccec6c235423236c", + "name": "mean.guy", + "type": "IDENTITY" + } + }, + { + "attribute": "email", + "oldValue": "john.doe@hotmail.com", + "newValue": "john.doe@gmail.com" + } + ] + } + } + + responses: + '200': + description: The Workflow object + content: + application/json: + schema: + type: object + properties: + workflowExecutionId: + type: string + description: The workflow execution id + example: "0e11cefa-96e7-4b67-90d0-065bc1da5753" + '400': + $ref: '../../../v3/responses/400.yaml' + '401': + $ref: '../../../v3/responses/401.yaml' + '403': + $ref: '../../../v3/responses/403.yaml' + '429': + $ref: '../../../v3/responses/429.yaml' + '500': + $ref: '../../../v3/responses/500.yaml' diff --git a/static/api-specs/idn/v3/paths/workflows/workflow.yaml b/static/api-specs/idn/v3/paths/workflows/workflow.yaml new file mode 100644 index 000000000..7adb82a7b --- /dev/null +++ b/static/api-specs/idn/v3/paths/workflows/workflow.yaml @@ -0,0 +1,346 @@ +get: + operationId: getWorkflow + tags: + - Workflows + summary: Get Workflow By Id + description: >- + Get a single workflow by id. + security: + - UserContextAuth: [sp:workflow:read] + parameters: + - name: id + in: path + description: Id of the workflow + required: true + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + responses: + '200': + description: >- + The workflow object + content: + application/json: + schema: + $ref: '../../schemas/workflows/Workflow.yaml' + '400': + $ref: '../../../v3/responses/400.yaml' + '401': + $ref: '../../../v3/responses/401.yaml' + '403': + $ref: '../../../v3/responses/403.yaml' + '429': + $ref: '../../../v3/responses/429.yaml' + '500': + $ref: '../../../v3/responses/500.yaml' +put: + operationId: putWorkflow + tags: + - Workflows + summary: Update Workflow + description: >- + Perform a full update of a workflow. The updated workflow object is returned in the response. + security: + - UserContextAuth: [sp:workflow:manage] + parameters: + - name: id + in: path + description: Id of the Workflow + required: true + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + requestBody: + required: true + content: + application/json: + schema: + $ref: '../../schemas/workflows/WorkflowBody.yaml' + responses: + '200': + description: The Workflow object + content: + application/json: + schema: + $ref: '../../schemas/workflows/Workflow.yaml' + '400': + $ref: '../../../v3/responses/400.yaml' + '401': + $ref: '../../../v3/responses/401.yaml' + '403': + $ref: '../../../v3/responses/403.yaml' + '429': + $ref: '../../../v3/responses/429.yaml' + '500': + $ref: '../../../v3/responses/500.yaml' +patch: + operationId: patchWorkflow + tags: + - Workflows + summary: Patch Workflow + description: >- + Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + security: + - UserContextAuth: [sp:workflow:manage] + parameters: + - name: id + in: path + description: Id of the Workflow + required: true + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + requestBody: + required: true + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '../../schemas/JsonPatchOperation.yaml' + examples: + Update all patchable fields: + description: Demonstrate how to update each patchable field in one PATCH request. + value: + [ + { + "op": "replace", + "path": "/name", + "value": "Send Email" + }, + { + "op": "replace", + "path": "/owner", + "value": { + "type": "IDENTITY", + "id": "2c91808568c529c60168cca6f90c1313", + "name": "William Wilson" + + } + }, + { + "op": "replace", + "path": "/description", + "value": "Send an email to the identity who's attributes changed." + }, + { + "op": "replace", + "path": "/enabled", + "value": false + }, + { + "op": "replace", + "path": "/definition", + "value": { + "start": "Send Email Test", + "steps": { + "Send Email": { + "actionId": "sp:send-email", + "attributes": { + "body": "This is a test", + "from": "sailpoint@sailpoint.com", + "recipientId.$": "$.identity.id", + "subject": "test" + }, + "nextStep": "success", + "selectResult": null, + "type": "action" + }, + "success": { + "type": "success" + } + } + } + }, + { + "op": "replace", + "path": "/trigger", + "value": { + "type": "EVENT", + "attributes": { + "id": "idn:identity-attributes-changed" + } + } + } + ] + responses: + '200': + description: The Workflow object + content: + application/json: + schema: + $ref: '../../schemas/workflows/Workflow.yaml' + '400': + $ref: '../../../v3/responses/400.yaml' + '401': + $ref: '../../../v3/responses/401.yaml' + '403': + $ref: '../../../v3/responses/403.yaml' + '429': + $ref: '../../../v3/responses/429.yaml' + '500': + $ref: '../../../v3/responses/500.yaml' +delete: + operationId: deleteWorkflow + tags: + - Workflows + summary: Delete Workflow By Id + description: >- + Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. + security: + - UserContextAuth: [sp:workflow:manage] + parameters: + - name: id + in: path + description: Id of the Workflow + required: true + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + responses: + '204': + $ref: '../../../v3/responses/204.yaml' + '400': + $ref: '../../../v3/responses/400.yaml' + '401': + $ref: '../../../v3/responses/401.yaml' + '403': + $ref: '../../../v3/responses/403.yaml' + '429': + $ref: '../../../v3/responses/429.yaml' + '500': + $ref: '../../../v3/responses/500.yaml' +post: + operationId: createWorkflow + tags: + - Workflows + summary: Create Workflow + description: >- + Create a new workflow with the desired trigger and steps specified in the request body. + security: + - UserContextAuth: [sp:workflow:manage] + requestBody: + required: true + content: + application/json: + schema: + allOf: + - required: + - name + - owner + - $ref: '../../schemas/workflows/WorkflowBody.yaml' + examples: + Event Trigger: + description: Workflow initiated by an event trigger + value: + name: Send Email + owner: + type: IDENTITY + id: 2c91808568c529c60168cca6f90c1313 + name: William Wilson + description: Send an email to the identity who's attributes changed. + definition: + start: Send Email Test + steps: + Send Email: + actionId: sp:send-email + attributes: + body: This is a test + from: sailpoint@sailpoint.com + recipientId.$: "$.identity.id" + subject: test + nextStep: success + selectResult: + type: action + success: + type: success + enabled: false + trigger: + type: EVENT + attributes: + id: idn:identity-attributes-changed + filter: "$.changes[?(@.attribute == 'manager')]" + Scheduled Trigger: + description: Workflow initiated by a scheduled trigger + value: + name: Send Email + owner: + type: IDENTITY + id: 2c91808568c529c60168cca6f90c1313 + name: William Wilson + description: Send an email to the identity who's attributes changed. + definition: + start: Send Email Test + steps: + Send Email: + actionId: sp:send-email + attributes: + body: This is a test + from: sailpoint@sailpoint.com + recipientId.$: "$.identity.id" + subject: test + nextStep: success + selectResult: + type: action + success: + type: success + enabled: false + trigger: + type: SCHEDULED + attributes: + cronString: 0 * */3 */5 * + External Trigger: + description: Workflow initiated by an external trigger + value: + name: Send Email + owner: + type: IDENTITY + id: 2c91808568c529c60168cca6f90c1313 + name: William Wilson + description: Send an email to the identity whose attributes changed. + definition: + start: Send Email Test + steps: + Send Email: + actionId: sp:send-email + attributes: + body: This is a test + from: sailpoint@sailpoint.com + recipientId.$: "$.identity.id" + subject: test + nextStep: success + selectResult: + type: action + success: + type: success + enabled: false + trigger: + type: EXTERNAL + attributes: + name: search-and-notify + description: Run a search and notify the results + responses: + '200': + description: The Workflow object + content: + application/json: + schema: + $ref: '../../schemas/workflows/Workflow.yaml' + '400': + $ref: '../../../v3/responses/400.yaml' + '401': + $ref: '../../../v3/responses/401.yaml' + '403': + $ref: '../../../v3/responses/403.yaml' + '429': + $ref: '../../../v3/responses/429.yaml' + '500': + $ref: '../../../v3/responses/500.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v3/paths/workflows/workflows.yaml b/static/api-specs/idn/v3/paths/workflows/workflows.yaml new file mode 100644 index 000000000..5a96c2b79 --- /dev/null +++ b/static/api-specs/idn/v3/paths/workflows/workflows.yaml @@ -0,0 +1,29 @@ +get: + operationId: listWorkflows + tags: + - Workflows + summary: List Workflows + description: >- + List all workflows in the tenant. + security: + - UserContextAuth: [sp:workflow:read] + responses: + '200': + description: >- + List of workflows + content: + application/json: + schema: + type: array + items: + $ref: '../../schemas/workflows/Workflow.yaml' + '400': + $ref: '../../../v3/responses/400.yaml' + '401': + $ref: '../../../v3/responses/401.yaml' + '403': + $ref: '../../../v3/responses/403.yaml' + '429': + $ref: '../../../v3/responses/429.yaml' + '500': + $ref: '../../../v3/responses/500.yaml' diff --git a/static/api-specs/idn/v3/responses/412.yaml b/static/api-specs/idn/v3/responses/412.yaml new file mode 100644 index 000000000..e45f4354e --- /dev/null +++ b/static/api-specs/idn/v3/responses/412.yaml @@ -0,0 +1,9 @@ +description: Precondition Failed - Returned in response if API/Feature not enabled for an organization. +content: + application/json: + schema: + type: object + properties: + message: + description: A message describing the error + example: " API/Feature not enabled for your organization." diff --git a/static/api-specs/idn/v3/schemas/AccessRequest.yaml b/static/api-specs/idn/v3/schemas/AccessRequest.yaml index dfec889c6..078f47ffd 100644 --- a/static/api-specs/idn/v3/schemas/AccessRequest.yaml +++ b/static/api-specs/idn/v3/schemas/AccessRequest.yaml @@ -12,6 +12,8 @@ properties: type: array items: $ref: 'AccessRequestItem.yaml' + minItems: 1 + maxItems: 25 clientMetadata: type: object additionalProperties: diff --git a/static/api-specs/idn/v3/schemas/AccessRequestItem.yaml b/static/api-specs/idn/v3/schemas/AccessRequestItem.yaml index 7b4935f01..bfd79b0de 100644 --- a/static/api-specs/idn/v3/schemas/AccessRequestItem.yaml +++ b/static/api-specs/idn/v3/schemas/AccessRequestItem.yaml @@ -32,10 +32,10 @@ properties: removeDate: type: string description: | - The date the role or access profile is no longer assigned to the specified identity. + The date the role or access profile is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. - * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. + * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. * Currently it is not supported for entitlements. format: 'date-time' example: '2020-07-11T21:23:15.000Z' diff --git a/static/api-specs/idn/v3/schemas/AccessRequestPhases.yaml b/static/api-specs/idn/v3/schemas/AccessRequestPhases.yaml index bfa1d5ddc..c3121fe1b 100644 --- a/static/api-specs/idn/v3/schemas/AccessRequestPhases.yaml +++ b/static/api-specs/idn/v3/schemas/AccessRequestPhases.yaml @@ -10,6 +10,7 @@ properties: description: The time that this phase finished. format: 'date-time' example: '2020-07-12T00:00:00Z' + nullable: true name: type: string description: The name of this phase. @@ -21,6 +22,7 @@ properties: - EXECUTING - COMPLETED - CANCELLED + - NOT_EXECUTED description: The state of this phase. example: COMPLETED result: @@ -28,12 +30,15 @@ properties: enum: - SUCCESSFUL - FAILED + - null description: The state of this phase. example: SUCCESSFUL + nullable: true phaseReference: type: string description: >- A reference to another object on the RequestedItemStatus that contains more details about the phase. Note that for the Provisioning phase, this will be empty if there are no manual work items. example: 'approvalDetails' + nullable: true description: Provides additional details about this access request phase. \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/AccessRequestType.yaml b/static/api-specs/idn/v3/schemas/AccessRequestType.yaml index 74b99ff59..b10d86527 100644 --- a/static/api-specs/idn/v3/schemas/AccessRequestType.yaml +++ b/static/api-specs/idn/v3/schemas/AccessRequestType.yaml @@ -2,7 +2,9 @@ type: string enum: - GRANT_ACCESS - REVOKE_ACCESS + - null description: >- Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field. example: GRANT_ACCESS +nullable: true diff --git a/static/api-specs/idn/v3/schemas/Account.yaml b/static/api-specs/idn/v3/schemas/Account.yaml index 8be744980..effb69b02 100644 --- a/static/api-specs/idn/v3/schemas/Account.yaml +++ b/static/api-specs/idn/v3/schemas/Account.yaml @@ -92,3 +92,8 @@ allOf: id: "4c5c8534e99445de98eef6c75e25eb01" type: "IDENTITY" name: "SailPoint Support" + features: + type: string + description: A string list containing the owning source's features + example: 'ENABLE' + nullable: true diff --git a/static/api-specs/idn/v3/schemas/AccountActivity.yaml b/static/api-specs/idn/v3/schemas/AccountActivity.yaml index d434c18ec..b02efba4a 100644 --- a/static/api-specs/idn/v3/schemas/AccountActivity.yaml +++ b/static/api-specs/idn/v3/schemas/AccountActivity.yaml @@ -26,7 +26,9 @@ properties: nullable: true example: "2018-10-19T13:49:37.385Z" completionStatus: - $ref: "./CompletionStatus.yaml" + allOf: + - $ref: "./CompletionStatus.yaml" + - nullable: true type: nullable: true type: string @@ -72,6 +74,7 @@ properties: type: string example: ["Some warning, another warning"] items: + nullable: true type: array description: Individual actions performed as part of this account activity items: diff --git a/static/api-specs/idn/v3/schemas/AccountActivityItem.yaml b/static/api-specs/idn/v3/schemas/AccountActivityItem.yaml index cdd88f437..2bc0d45dc 100644 --- a/static/api-specs/idn/v3/schemas/AccountActivityItem.yaml +++ b/static/api-specs/idn/v3/schemas/AccountActivityItem.yaml @@ -14,8 +14,9 @@ properties: description: Date and time item was requested example: "2017-07-11T18:45:37.098Z" approvalStatus: - nullable: true - $ref: "./WorkItemState.yaml" + allOf: + - $ref: "./WorkItemState.yaml" + - nullable: true provisioningStatus: $ref: "./ProvisioningState.yaml" requesterComment: @@ -25,8 +26,9 @@ properties: reviewerComment: $ref: "./Comment.yaml" operation: - nullable: true - $ref: "./AccountActivityItemOperation.yaml" + allOf: + - $ref: "./AccountActivityItemOperation.yaml" + - nullable: true attribute: type: string description: Attribute to which account activity applies diff --git a/static/api-specs/idn/v3/schemas/AccountActivityItemOperation.yaml b/static/api-specs/idn/v3/schemas/AccountActivityItemOperation.yaml index d63b2b616..febb2ca14 100644 --- a/static/api-specs/idn/v3/schemas/AccountActivityItemOperation.yaml +++ b/static/api-specs/idn/v3/schemas/AccountActivityItemOperation.yaml @@ -9,5 +9,7 @@ enum: - UNLOCK - LOCK - REMOVE + - SET + - null description: Represents an operation in an account activity item example: ADD diff --git a/static/api-specs/idn/v3/schemas/ApprovalItemDetails.yaml b/static/api-specs/idn/v3/schemas/ApprovalItemDetails.yaml index cd39f56cd..7d9cc17e5 100644 --- a/static/api-specs/idn/v3/schemas/ApprovalItemDetails.yaml +++ b/static/api-specs/idn/v3/schemas/ApprovalItemDetails.yaml @@ -8,6 +8,7 @@ properties: type: string description: The account referenced by the approval item example: john.smith + nullable: true application: type: string description: The name of the application/source @@ -16,6 +17,7 @@ properties: type: string description: The attribute's name example: emailAddress + nullable: true operation: type: string description: The attribute's operation @@ -24,5 +26,8 @@ properties: type: string description: The attribute's value example: a@b.com + nullable: true state: - $ref: './WorkItemState.yaml' + allOf: + - $ref: './WorkItemState.yaml' + - nullable: true diff --git a/static/api-specs/idn/v3/schemas/ApprovalReminderAndEscalationConfig.yaml b/static/api-specs/idn/v3/schemas/ApprovalReminderAndEscalationConfig.yaml index b493b5931..314e285fb 100644 --- a/static/api-specs/idn/v3/schemas/ApprovalReminderAndEscalationConfig.yaml +++ b/static/api-specs/idn/v3/schemas/ApprovalReminderAndEscalationConfig.yaml @@ -5,16 +5,19 @@ properties: description: Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation. format: int32 example: 0 + nullable: true daysBetweenReminders: type: integer description: Number of days to wait between reminder notifications. format: int32 example: 0 + nullable: true maxReminders: type: integer description: Maximum number of reminder notification to send to the reviewer before approval escalation. format: int32 minimum: 1 example: 1 + nullable: true fallbackApproverRef: $ref: './IdentityReferenceWithNameAndEmail.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/ApprovalStatusDto.yaml b/static/api-specs/idn/v3/schemas/ApprovalStatusDto.yaml index 2340b5399..c12450a25 100644 --- a/static/api-specs/idn/v3/schemas/ApprovalStatusDto.yaml +++ b/static/api-specs/idn/v3/schemas/ApprovalStatusDto.yaml @@ -2,6 +2,7 @@ type: object properties: forwarded: type: boolean + default: false description: True if the request for this item was forwarded from one owner to another. example: false @@ -25,12 +26,15 @@ properties: description: Display name of original approval owner. example: Michael Michaels currentOwner: - $ref: './AccessItemReviewedBy.yaml' + allOf: + - $ref: './AccessItemReviewedBy.yaml' + - nullable: true modified: type: string format: date-time description: Time at which item was modified. example: "2019-08-23T18:52:57.398Z" + nullable: true status: $ref: "./ManualWorkItemState.yaml" scheme: @@ -41,10 +45,12 @@ properties: $ref: "./ErrorMessageDto.yaml" description: >- If the request failed, includes any error messages that were generated. + nullable: true comment: type: string description: Comment, if any, provided by the approver. example: I approve this request + nullable: true removeDate: type: string description: @@ -52,3 +58,4 @@ properties: identity. format: "date-time" example: "2020-07-11T00:00:00Z" + nullable: true diff --git a/static/api-specs/idn/v3/schemas/AuthUser.yaml b/static/api-specs/idn/v3/schemas/AuthUser.yaml index b27654654..ba4d9ee26 100644 --- a/static/api-specs/idn/v3/schemas/AuthUser.yaml +++ b/static/api-specs/idn/v3/schemas/AuthUser.yaml @@ -10,15 +10,15 @@ properties: example: 2c91808458ae7a4f0158b1bbf8af0628 uid: type: string - description: Identity unique identitifier. + description: Identity's unique identitifier. example: "will.smith" profile: type: string - description: ID of the auth profile associated with this auth user. + description: ID of the auth profile associated with the auth user. example: 2c91808458ae7a4f0158b1bbf8af0756 identificationNumber: type: string - description: Auth user employee number. + description: Auth user's employee number. example: "19-5588452" email: type: string @@ -54,7 +54,7 @@ properties: example: will.smith lastPasswordChangeDate: type: string - description: the date of last password change + description: Date of last password change. example: "2021-03-08T22:37:33.901Z" lastLoginTimestamp: description: Timestamp of the last login (long type value). @@ -67,8 +67,27 @@ properties: format: int64 example: 1656327185832 capabilities: - description: Array of capabilities for this auth user. + description: Array of the auth user's capabilities. type: array items: type: string + enum: + - CERT_ADMIN + - CLOUD_GOV_ADMIN + - CLOUD_GOV_USER + - HELPDESK + - ORG_ADMIN + - REPORT_ADMIN + - ROLE_ADMIN + - ROLE_SUBADMIN + - SAAS_MANAGEMENT_ADMIN + - SAAS_MANAGEMENT_READER + - SOURCE_ADMIN + - SOURCE_SUBADMIN + - das:ui-administrator + - das:ui-compliance_manager + - das:ui-auditor + - das:ui-data-scope + - sp:aic-dashboard-read + - sp:aic-dashboard-write example: "ORG_ADMIN" diff --git a/static/api-specs/idn/v3/schemas/BrandingItem.yaml b/static/api-specs/idn/v3/schemas/BrandingItem.yaml new file mode 100644 index 000000000..dc91265ff --- /dev/null +++ b/static/api-specs/idn/v3/schemas/BrandingItem.yaml @@ -0,0 +1,41 @@ +type: object +properties: + name: + type: string + description: name of branding item + example: "default" + productName: + type: string + description: product name + example: "product name" + nullable: true + actionButtonColor: + type: string + description: hex value of color for action button + example: "0074D9" + nullable: true + activeLinkColor: + type: string + description: hex value of color for link + example: "011E69" + nullable: true + navigationColor: + type: string + description: hex value of color for navigation bar + example: "011E69" + nullable: true + emailFromAddress: + type: string + description: email from address + example: "no-reply@sailpoint.com" + nullable: true + standardLogoURL: + type: string + description: url to standard logo + example: "" + nullable: true + loginInformationalMessage: + type: string + description: login information message + example: "" + nullable: true diff --git a/static/api-specs/idn/v3/schemas/BrandingItemCreate.yaml b/static/api-specs/idn/v3/schemas/BrandingItemCreate.yaml new file mode 100644 index 000000000..49bd83b57 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/BrandingItemCreate.yaml @@ -0,0 +1,39 @@ +type: object +required: + - name + - productName +properties: + name: + type: string + description: name of branding item + example: "custom-branding-item" + productName: + type: string + description: product name + example: "product name" + nullable: true + actionButtonColor: + type: string + description: hex value of color for action button + example: "0074D9" + activeLinkColor: + type: string + description: hex value of color for link + example: "011E69" + navigationColor: + type: string + description: hex value of color for navigation bar + example: "011E69" + emailFromAddress: + type: string + description: email from address + example: "no-reply@sailpoint.com" + loginInformationalMessage: + type: string + description: login information message + example: "" + fileStandard: + type: string + format: binary + description: png file with logo + example: \x00\x00\x00\x02 diff --git a/static/api-specs/idn/v3/schemas/CampaignFilterDetails.yaml b/static/api-specs/idn/v3/schemas/CampaignFilterDetails.yaml index e9f0ccdf6..3e2bfe71d 100644 --- a/static/api-specs/idn/v3/schemas/CampaignFilterDetails.yaml +++ b/static/api-specs/idn/v3/schemas/CampaignFilterDetails.yaml @@ -17,6 +17,7 @@ properties: type: string description: The owner of this filter. This field is automatically populated at creation time with the current user. example: SailPoint Support + nullable: true mode: description: >- The mode/type of Filter, where it is of INCLUSION or EXCLUSION type. INCLUSION type will include the data in generated campaign @@ -34,15 +35,19 @@ properties: type: $ref: './CriteriaType.yaml' operation: - $ref: './Operation.yaml' + allOf: + - $ref: './Operation.yaml' + - nullable: true property: type: string description: The specified key from the Type of criteria. example: displayName + nullable: true value: type: string description: The value for the specified key from the Type of Criteria example: Allie + nullable: true required: - type - property diff --git a/static/api-specs/idn/v3/schemas/CampaignReportsConfig.yaml b/static/api-specs/idn/v3/schemas/CampaignReportsConfig.yaml index 7ccf8c4a5..a367aec62 100644 --- a/static/api-specs/idn/v3/schemas/CampaignReportsConfig.yaml +++ b/static/api-specs/idn/v3/schemas/CampaignReportsConfig.yaml @@ -3,6 +3,7 @@ title: Campaign Reports Configuration properties: identityAttributeColumns: type: array + nullable: true description: list of identity attribute columns items: type: string diff --git a/static/api-specs/idn/v3/schemas/CommentDto.yaml b/static/api-specs/idn/v3/schemas/CommentDto.yaml index 026c52dea..c85333058 100644 --- a/static/api-specs/idn/v3/schemas/CommentDto.yaml +++ b/static/api-specs/idn/v3/schemas/CommentDto.yaml @@ -5,25 +5,27 @@ properties: nullable: true description: Comment content. example: This is a comment. - author: - type: object - properties: - type: - type: string - description: DTO type of the commenting identity. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: ID of the commenting identity. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Display name of the commenting identity. - example: Adam Kennedy created: type: string format: 'date-time' description: Date and time comment was created. - example: '2017-07-11T18:45:37.098Z' \ No newline at end of file + example: '2017-07-11T18:45:37.098Z' + author: + type: object + readOnly: true + description: Author of the comment + properties: + type: + type: string + enum: + - IDENTITY + example: IDENTITY + description: The type of object + id: + type: string + description: The unique ID of the object + example: 2c9180847e25f377017e2ae8cae4650b + name: + type: string + description: The display name of the object + example: john.doe \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/CompletedApproval.yaml b/static/api-specs/idn/v3/schemas/CompletedApproval.yaml index 64343c7c8..da1468a5c 100644 --- a/static/api-specs/idn/v3/schemas/CompletedApproval.yaml +++ b/static/api-specs/idn/v3/schemas/CompletedApproval.yaml @@ -29,7 +29,12 @@ properties: requester: $ref: './AccessItemRequester.yaml' requestedFor: - $ref: './AccessItemRequestedFor.yaml' + type: array + description: Identities access was requested for. + items: + $ref: './AccessItemRequestedFor.yaml' + minItems: 1 + maxItems: 10 reviewedBy: $ref: './AccessItemReviewedBy.yaml' owner: @@ -38,13 +43,14 @@ properties: $ref: './RequestableObjectReference.yaml' description: The requested access item. requesterComment: - $ref: './CommentDto.yaml' - description: The requester's comment. + allOf: + - $ref: './CommentDto.yaml' + - description: The requester's comment. reviewerComment: allOf: - - $ref: './CommentDto.yaml' - description: The approval's reviewer's comment. - nullable: true + - $ref: './CommentDto.yaml' + - description: The approval's reviewer's comment. + nullable: true previousReviewersComments: type: array items: @@ -57,6 +63,7 @@ properties: description: The history of approval forward action. commentRequiredWhenRejected: type: boolean + default: false description: When true the rejector has to provide comments when rejecting example: true state: @@ -70,6 +77,7 @@ properties: nullable: true removeDateUpdateRequested: type: boolean + default: false description: If true, then the request was to change the remove date or sunset date. example: true currentRemoveDate: @@ -80,4 +88,37 @@ properties: nullable: true sodViolationContext: $ref: './SodViolationContextCheckCompleted.yaml' - description: The details of the SOD violations for the associated approval. \ No newline at end of file + description: The details of the SOD violations for the associated approval. + preApprovalTriggerResult: + nullable: true + type: object + description: If the access request submitted event trigger is configured and this access request was intercepted by it, then this is the result of the trigger's decision to either approve or deny the request. + properties: + comment: + type: string + description: The comment from the trigger + example: This request was autoapproved by our automated ETS subscriber + decision: + $ref: './CompletedApprovalState.yaml' + description: The approval decision of the trigger + reviewer: + type: string + description: The name of the approver + example: Automated AR Approval + date: + type: string + format: date-time + example: '2022-06-07T19:18:40.748Z' + description: The date and time the trigger decided on the request + clientMetadata: + type: object + additionalProperties: + type: string + description: >- + Arbitrary key-value pairs provided during the request. + example: + requestedAppName: test-app + requestedAppId: 2c91808f7892918f0178b78da4a305a1 + requestedAccounts: + type: string + nullable: true \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/CompletionStatus.yaml b/static/api-specs/idn/v3/schemas/CompletionStatus.yaml index 4452a5baf..724bdad9f 100644 --- a/static/api-specs/idn/v3/schemas/CompletionStatus.yaml +++ b/static/api-specs/idn/v3/schemas/CompletionStatus.yaml @@ -6,4 +6,5 @@ enum: - FAILURE - INCOMPLETE - PENDING + - null example: SUCCESS diff --git a/static/api-specs/idn/v3/schemas/ConnectorDetail.yaml b/static/api-specs/idn/v3/schemas/ConnectorDetail.yaml new file mode 100644 index 000000000..dc4515569 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/ConnectorDetail.yaml @@ -0,0 +1,84 @@ +type: object +properties: + name: + type: string + description: The connector name + example: "name" + type: + type: string + description: The connector type + example: "ServiceNow" + className: + type: string + description: The connector class name + example: "class name" + scriptName: + type: string + description: The connector script name + example: "servicenow" + applicationXml: + type: string + description: The connector application xml + example: "\n\n\n" + correlationConfigXml: + type: string + description: The connector correlation config xml + example: "\n\n\n\n\n\n\t\n\t\t\n\t\t\n\t\t\n\t\n\n" + sourceConfigXml: + type: string + description: The connector source config xml + example: "
    \n \n \n \n \n\n \n
    " + sourceConfig: + type: string + description: The connector source config + example: "
    \n \n \n \n \n\n \n
    " + sourceConfigFrom: + type: string + description: The connector source config origin + example: "sp-connect" + s3Location: + type: string + description: storage path key for this connector + example: "custom-connector/scriptname" + uploadedFiles: + type: array + description: The list of uploaded files supported by the connector. If there was any executable files uploaded to thee connector. Typically this be empty as the executable be uploaded at source creation. + nullable: true + items: + type: string + example: ["pod/org/connectorFiles/testconnector/test1.jar"] + fileUpload: + type: boolean + description: true if the source is file upload + example: true + default: false + directConnect: + type: boolean + description: true if the source is a direct connect source + example: true + default: false + translationProperties: + type: object + description: A map containing translation attributes by loacale key + additionalProperties: true + example: { + "de":"# Copyright (C) 2024 SailPoint Technologies, Inc. All rights reserved.\n# DO NOT EDIT. This file is generated by \"sailpointTranslate\" command.\nmenuLabel_ConnectionSettings=Verbindungseinstellungen\nmenuLabel_AggregationSettings=Aggregationseinstellungen\nsectionLabel_AuthenticationSettings=Verbindungseinstellungen\nsectionLabel_AggregationSettings=Aggregationseinstellungen\nsectionInfo_AuthenticationSettings=Konfigurieren Sie eine direkte Verbindung zwischen der Quelle Delinea Secret Server On-Premise und IdentityNow.

    Geben Sie bei Zeit\\u00fcberschreitung bei Verbindung die maximal erlaubte Zeitdauer (in Minuten) f\\u00fcr die Verbindung von IdentityNow mit der Quelle ein.

    Geben Sie die Host-URL der Delinea-SCIM-Serverquelle ein.

    Geben Sie den API-Token der Quelle zur Authentifizierung ein.\nsectionInfo_AggregationSettings=Geben Sie die Einstellungen f\\u00fcr Ihre Aggregation an.

    Geben Sie in das Feld Seitengr\\u00f6\\u00dfe die Anzahl an Kontoeintr\\u00e4gen ein, die auf einer einzelnen Seite aggregiert werden sollen, wenn gro\\u00dfe Datens\\u00e4tze durchlaufen werden.
    \\n
    Geben Sie im Kontofilter die Bedingungen f\\u00fcr den Kontofilter an. Beispiel: userName sw \"S\"

    Geben Sie im Gruppenfilter die Gruppenfilterbedingungen an. Beispiel: displayName sw \"S\".\nplaceHolder_accAggregation=userName sw \"S\"\nplaceHolder_grpAggregation=displayName sw \"S\"\nplaceHolder_host=https://{Delinea_SCIM_Server_host}/v2\ndocLinkLabel_AuthenticationSettings=Mehr \\u00fcber Verbindungseinstellungen\ndocLinkLabel_Filters=Mehr \\u00fcber Konto- und Gruppenfilter\nHostURL=Host-URL\nConnectionTimeout=Zeit\\u00fcberschreitung bei Verbindung\nAPI_TOKEN=API-Token\nJSONPathMapping=JSON-Path-Attribut-Mapping\nFilterConditionForAccounts=Kontofilter\nFilterConditionForGroups=Gruppenfilter\nPage_Size=Seitengr\\u00f6\\u00dfe\nSchemaAttribute=Schema-Attribut\nJSONpath=JSON-Pfad\nShortDesc=Das Integrationsmodul IdentityNow f\\u00fcr Delinea Secret Server On-Premise bietet die M\\u00f6glichkeit einer tiefen Governance f\\u00fcr Konten und Gruppen. Es unterst\\u00fctzt au\\u00dferdem das End-to-End-Lebenszyklus-Management.", + } + connectorMetadata: + type: object + description: A map containing metadata pertinent to the UI to be used + additionalProperties: true + example: { + "supportedUI": "EXTJS", + "platform": "ccg", + "shortDesc": "connector description" + } + status: + type: string + enum: + - DEPRECATED + - DEVELOPMENT + - DEMO + - RELEASED + description: The connector status + example: "RELEASED" \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/CriteriaType.yaml b/static/api-specs/idn/v3/schemas/CriteriaType.yaml index b42794df3..fdf1cee26 100644 --- a/static/api-specs/idn/v3/schemas/CriteriaType.yaml +++ b/static/api-specs/idn/v3/schemas/CriteriaType.yaml @@ -5,11 +5,10 @@ enum: - IDENTITY - IDENTITY_ATTRIBUTE - ENTITLEMENT - - INVALID_CERTIFIABLE_ENTITY - ACCESS_PROFILE - SOURCE - ACCOUNT - - INVALID_CERTIFIABLE_BUNDLE - AGGREGATED_ENTITLEMENT -description: Type of the criteria in the filter. + - INVALID_CERTIFIABLE_ENTITY +description: Type of the criteria in the filter. The `COMPOSITE` filter can contain multiple filters in an AND/OR relationship. example: IDENTITY_ATTRIBUTE diff --git a/static/api-specs/idn/v3/schemas/EntitlementRequestConfig.yaml b/static/api-specs/idn/v3/schemas/EntitlementRequestConfig.yaml index 0a0ee41a1..05c458f60 100644 --- a/static/api-specs/idn/v3/schemas/EntitlementRequestConfig.yaml +++ b/static/api-specs/idn/v3/schemas/EntitlementRequestConfig.yaml @@ -21,5 +21,6 @@ properties: Multiple schemes must be comma-separated. The valid schemes are "entitlementOwner", "sourceOwner", "manager" and "workgroup:{id}". Multiple workgroups (governance groups) can be used. default: sourceOwner + nullable: true example: "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/ErrorMessageDto.yaml b/static/api-specs/idn/v3/schemas/ErrorMessageDto.yaml index e1685ae8b..73cfac26f 100644 --- a/static/api-specs/idn/v3/schemas/ErrorMessageDto.yaml +++ b/static/api-specs/idn/v3/schemas/ErrorMessageDto.yaml @@ -4,6 +4,7 @@ properties: type: string description: The locale for the message text, a BCP 47 language tag. example: en-US + nullable: true localeOrigin: $ref: "../../v3/schemas/LocaleOrigin.yaml" text: diff --git a/static/api-specs/idn/v3/schemas/Expression.yaml b/static/api-specs/idn/v3/schemas/Expression.yaml index 1bee49777..334e7cce4 100644 --- a/static/api-specs/idn/v3/schemas/Expression.yaml +++ b/static/api-specs/idn/v3/schemas/Expression.yaml @@ -11,6 +11,7 @@ properties: type: string description: Name for the attribute example: "location" + nullable: true value: $ref: './Value.yaml' children: @@ -18,5 +19,25 @@ properties: nullable: true description: List of expressions items: - $ref: './Value.yaml' + type: object + properties: + operator: + type: string + description: Operator for the expression + enum: + - AND + - EQUALS + example: "EQUALS" + attribute: + type: string + description: Name for the attribute + example: "location" + nullable: true + value: + $ref: './Value.yaml' + children: + type: string + nullable: true + description: There cannot be anymore nested children. This will always be null. + example: null example: [] diff --git a/static/api-specs/idn/v3/schemas/FormDetails.yaml b/static/api-specs/idn/v3/schemas/FormDetails.yaml index 8f9f45394..e940b347b 100644 --- a/static/api-specs/idn/v3/schemas/FormDetails.yaml +++ b/static/api-specs/idn/v3/schemas/FormDetails.yaml @@ -4,10 +4,12 @@ properties: type: string description: ID of the form example: 2c9180835d2e5168015d32f890ca1581 + nullable: true name: type: string description: Name of the form example: AccountSelection Form + nullable: true title: type: string description: The form title @@ -21,4 +23,7 @@ properties: description: The name of the user that should be shown this form example: Jane.Doe sections: - $ref: './SectionDetails.yaml' + type: array + items: + $ref: './SectionDetails.yaml' + description: Sections of the form diff --git a/static/api-specs/idn/v3/schemas/GetPersonalAccessTokenResponse.yaml b/static/api-specs/idn/v3/schemas/GetPersonalAccessTokenResponse.yaml index 5c75203dc..78515cbf6 100644 --- a/static/api-specs/idn/v3/schemas/GetPersonalAccessTokenResponse.yaml +++ b/static/api-specs/idn/v3/schemas/GetPersonalAccessTokenResponse.yaml @@ -29,6 +29,11 @@ properties: format: 'date-time' description: The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed. example: '2017-07-11T18:45:37.098Z' + managed: + type: boolean + default: false + example: false + description: If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows. required: - id - name diff --git a/static/api-specs/idn/v3/schemas/LocaleOrigin.yaml b/static/api-specs/idn/v3/schemas/LocaleOrigin.yaml index 5bc895f0a..cd11e741b 100644 --- a/static/api-specs/idn/v3/schemas/LocaleOrigin.yaml +++ b/static/api-specs/idn/v3/schemas/LocaleOrigin.yaml @@ -2,8 +2,10 @@ type: string enum: - DEFAULT - REQUEST + - null description: >- An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. -example: DEFAULT \ No newline at end of file +example: DEFAULT +nullable: true \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/ManagerCorrelationMapping.yaml b/static/api-specs/idn/v3/schemas/ManagerCorrelationMapping.yaml index 6ebdf4a8a..3c6a7807d 100644 --- a/static/api-specs/idn/v3/schemas/ManagerCorrelationMapping.yaml +++ b/static/api-specs/idn/v3/schemas/ManagerCorrelationMapping.yaml @@ -1,12 +1,12 @@ type: object properties: - accountAttribute: + accountAttributeName: type: string description: >- Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. example: "manager" - identityAttribute: + identityAttributeName: type: string description: >- Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. diff --git a/static/api-specs/idn/v3/schemas/ManualWorkItemDetails.yaml b/static/api-specs/idn/v3/schemas/ManualWorkItemDetails.yaml index fdf5ee82f..5d88aa792 100644 --- a/static/api-specs/idn/v3/schemas/ManualWorkItemDetails.yaml +++ b/static/api-specs/idn/v3/schemas/ManualWorkItemDetails.yaml @@ -2,10 +2,12 @@ type : object properties: forwarded: type: boolean + default: false description: True if the request for this item was forwarded from one owner to another. example: true originalOwner: type: object + nullable: true description: Identity of original work item owner, if the work item has been forwarded. properties: type: @@ -25,7 +27,8 @@ properties: example: Michael Michaels currentOwner: type: object - description: Identity of current work item owner. + description: Identity of current work item owner. + nullable: true properties: type: type: string @@ -51,6 +54,7 @@ properties: $ref: './ManualWorkItemState.yaml' forwardHistory: type: array + nullable: true items: $ref: './ApprovalForwardHistory.yaml' description: >- diff --git a/static/api-specs/idn/v3/schemas/NetworkConfiguration.yaml b/static/api-specs/idn/v3/schemas/NetworkConfiguration.yaml index 843ee7c6a..2925d87e9 100644 --- a/static/api-specs/idn/v3/schemas/NetworkConfiguration.yaml +++ b/static/api-specs/idn/v3/schemas/NetworkConfiguration.yaml @@ -6,12 +6,14 @@ properties: items: type: string example: ["1.3.7.2", "255.255.255.252/30"] + nullable: true geolocation: type: array description: The collection of country codes. items: type: string example: ["CA", "FR", "HT"] + nullable: true whitelisted: type: boolean description: Denotes whether the provided lists are whitelisted or blacklisted for geo location. diff --git a/static/api-specs/idn/v3/schemas/Operation.yaml b/static/api-specs/idn/v3/schemas/Operation.yaml index 35a1659d2..d12a75cb0 100644 --- a/static/api-specs/idn/v3/schemas/Operation.yaml +++ b/static/api-specs/idn/v3/schemas/Operation.yaml @@ -7,5 +7,6 @@ enum: - ENDS_WITH - AND - OR + - null description: Operation on a specific criteria example: EQUALS diff --git a/static/api-specs/idn/v3/schemas/PasswordSyncGroup.yaml b/static/api-specs/idn/v3/schemas/PasswordSyncGroup.yaml index 3cb711b4d..8fdb28775 100644 --- a/static/api-specs/idn/v3/schemas/PasswordSyncGroup.yaml +++ b/static/api-specs/idn/v3/schemas/PasswordSyncGroup.yaml @@ -17,4 +17,16 @@ properties: description: List of password managed sources IDs items: type: string - example: ["2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500"] \ No newline at end of file + example: ["2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500"] + created: + type: string + description: The date and time this sync group was created + format: date-time + example: '2023-03-16T04:00:00Z' + nullable: true + modified: + type: string + description: The date and time this sync group was last modified + format: date-time + example: '2023-03-16T04:00:00Z' + nullable: true \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/PendingApproval.yaml b/static/api-specs/idn/v3/schemas/PendingApproval.yaml index 1dde49f47..fd3d04205 100644 --- a/static/api-specs/idn/v3/schemas/PendingApproval.yaml +++ b/static/api-specs/idn/v3/schemas/PendingApproval.yaml @@ -29,7 +29,12 @@ properties: requester: $ref: './AccessItemRequester.yaml' requestedFor: - $ref: './AccessItemRequestedFor.yaml' + type: array + description: Identities access was requested for. + items: + $ref: './AccessItemRequestedFor.yaml' + minItems: 1 + maxItems: 10 owner: type: object description: Access item owner's identity. @@ -66,6 +71,7 @@ properties: description: The history of approval forward action. commentRequiredWhenRejected: type: boolean + default: false description: When true the rejector has to provide comments when rejecting example: true actionInProcess: @@ -78,6 +84,7 @@ properties: example: '2020-07-11T00:00:00Z' removeDateUpdateRequested: type: boolean + default: false description: If true, then the request is to change the remove date or sunset date. example: true currentRemoveDate: diff --git a/static/api-specs/idn/v3/schemas/ProvisioningConfig.yaml b/static/api-specs/idn/v3/schemas/ProvisioningConfig.yaml index 167910a20..fb31b2030 100644 --- a/static/api-specs/idn/v3/schemas/ProvisioningConfig.yaml +++ b/static/api-specs/idn/v3/schemas/ProvisioningConfig.yaml @@ -5,6 +5,7 @@ properties: description: Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed. type: boolean readOnly: true + default: false example: true managedResourceRefs: description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. @@ -22,6 +23,7 @@ properties: planInitializerScript: description: This is a reference to a plan initializer script. type: object + nullable: true properties: source: description: This is a Rule that allows provisioning instruction changes. @@ -31,6 +33,7 @@ properties: noProvisioningRequests: description: Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. type: boolean + default: false example: true provisioningRequestExpiration: description: When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation. diff --git a/static/api-specs/idn/v3/schemas/PublicIdentity.yaml b/static/api-specs/idn/v3/schemas/PublicIdentity.yaml index d4bb2e2da..2d3431a6c 100644 --- a/static/api-specs/idn/v3/schemas/PublicIdentity.yaml +++ b/static/api-specs/idn/v3/schemas/PublicIdentity.yaml @@ -25,6 +25,19 @@ properties: type: string description: The lifecycle status for the identity example: 'Active' + identityState: + nullable: true + type: string + enum: + - ACTIVE + - INACTIVE_SHORT_TERM + - INACTIVE_LONG_TERM + - null + example: ACTIVE + description: | + The current state of the identity, which determines how Identity Security Cloud interacts with the identity. + An identity that is Active will be included identity picklists in Request Center, identity processing, and more. + Identities that are Inactive will be excluded from these features. manager: $ref: './IdentityReference.yaml' description: An identity reference to the manager of this identity diff --git a/static/api-specs/idn/v3/schemas/RequestableObject.yaml b/static/api-specs/idn/v3/schemas/RequestableObject.yaml index 808b3ff6c..b37be25e6 100644 --- a/static/api-specs/idn/v3/schemas/RequestableObject.yaml +++ b/static/api-specs/idn/v3/schemas/RequestableObject.yaml @@ -23,10 +23,13 @@ properties: type: string description: Description of the requestable object. example: Access to research information, lab results, and schematics. + nullable: true type: $ref: './RequestableObjectType.yaml' requestStatus: - $ref: './RequestableObjectRequestStatus.yaml' + allOf: + - $ref: './RequestableObjectRequestStatus.yaml' + - nullable: true identityRequestId: type: string description: If *requestStatus* is *PENDING*, indicates the id of the associated account activity. diff --git a/static/api-specs/idn/v3/schemas/RequestableObjectRequestStatus.yaml b/static/api-specs/idn/v3/schemas/RequestableObjectRequestStatus.yaml index 9e4d6dc60..3ed0ba339 100644 --- a/static/api-specs/idn/v3/schemas/RequestableObjectRequestStatus.yaml +++ b/static/api-specs/idn/v3/schemas/RequestableObjectRequestStatus.yaml @@ -3,6 +3,7 @@ enum: - AVAILABLE - PENDING - ASSIGNED + - null description: >- Status indicating the ability of an access request for the object to be made by or on behalf of the identity specified by *identity-id*. *AVAILABLE* indicates the object is available to request. *PENDING* indicates the object diff --git a/static/api-specs/idn/v3/schemas/RequestableObjectType.yaml b/static/api-specs/idn/v3/schemas/RequestableObjectType.yaml index f84547da7..da772054d 100644 --- a/static/api-specs/idn/v3/schemas/RequestableObjectType.yaml +++ b/static/api-specs/idn/v3/schemas/RequestableObjectType.yaml @@ -2,6 +2,7 @@ type: string enum: - ACCESS_PROFILE - ROLE + - ENTITLEMENT description: >- The currently supported requestable object types. example: ACCESS_PROFILE diff --git a/static/api-specs/idn/v3/schemas/RequestedItemStatus.yaml b/static/api-specs/idn/v3/schemas/RequestedItemStatus.yaml index f11a0f6c0..e70e628bf 100644 --- a/static/api-specs/idn/v3/schemas/RequestedItemStatus.yaml +++ b/static/api-specs/idn/v3/schemas/RequestedItemStatus.yaml @@ -4,17 +4,21 @@ properties: type: string description: Human-readable display name of the item being requested. example: "AccessProfile1" + nullable: true type: type: string enum: - ACCESS_PROFILE - ROLE - ENTITLEMENT + - null description: Type of requested object. example: ACCESS_PROFILE - cancelledRequestDetails: nullable: true - $ref: './CancelledRequestDetails.yaml' + cancelledRequestDetails: + allOf: + - $ref: './CancelledRequestDetails.yaml' + - nullable: true errorMessages: type: array nullable: true @@ -45,6 +49,7 @@ properties: format: date-time description: When the request was last modified. example: "2019-08-23T18:52:59.162Z" + nullable: true created: type: string format: date-time @@ -53,30 +58,41 @@ properties: requester: $ref: './AccessItemRequester.yaml' requestedFor: - $ref: './AccessItemRequestedFor.yaml' + type: array + description: Identities access was requested for. + items: + $ref: './AccessItemRequestedFor.yaml' + minItems: 1 + maxItems: 10 requesterComment: - $ref: './CommentDto.yaml' - nullable: true - description: The requester's comment. + allOf: + - $ref: './CommentDto.yaml' + - nullable: true + description: The requester's comment. sodViolationContext: - $ref: './SodViolationContextCheckCompleted.yaml' - nullable: true - description: The details of the SOD violations for the associated approval. + allOf: + - $ref: './SodViolationContextCheckCompleted.yaml' + - nullable: true + description: The details of the SOD violations for the associated approval. provisioningDetails: - nullable: true - $ref: './ProvisioningDetails.yaml' + allOf: + - $ref: './ProvisioningDetails.yaml' + - nullable: true preApprovalTriggerDetails: - nullable: true - $ref: './PreApprovalTriggerDetails.yaml' + allOf: + - $ref: './PreApprovalTriggerDetails.yaml' + - nullable: true accessRequestPhases: type: array items: $ref: './AccessRequestPhases.yaml' description: A list of Phases that the Access Request has gone through in order, to help determine the status of the request. + nullable: true description: type: string description: Description associated to the requested object. example: "This is the Engineering role that engineers are granted." + nullable: true removeDate: type: string format: date-time @@ -85,11 +101,11 @@ properties: example: "2019-10-23T00:00:00.000Z" cancelable: type: boolean + default: false description: True if the request can be canceled. example: true accessRequestId: type: string - format: string description: This is the account activity id. example: "2b838de9-db9b-abcf-e646-d4f274ad4238" clientMetadata: diff --git a/static/api-specs/idn/v3/schemas/Segment.yaml b/static/api-specs/idn/v3/schemas/Segment.yaml index 17e271bff..c6f5c261d 100644 --- a/static/api-specs/idn/v3/schemas/Segment.yaml +++ b/static/api-specs/idn/v3/schemas/Segment.yaml @@ -25,7 +25,9 @@ properties: owner: $ref: '../../v3/schemas/access/OwnerReferenceSegments.yaml' visibilityCriteria: - $ref: './VisibilityCriteria.yaml' + allOf: + - $ref: './VisibilityCriteria.yaml' + - nullable: true active: type: boolean description: This boolean indicates whether the segment is currently active. Inactive segments have no effect. diff --git a/static/api-specs/idn/v3/schemas/ServiceDeskIntegrationDto.yaml b/static/api-specs/idn/v3/schemas/ServiceDeskIntegrationDto.yaml index 907f62e5f..6226ae635 100644 --- a/static/api-specs/idn/v3/schemas/ServiceDeskIntegrationDto.yaml +++ b/static/api-specs/idn/v3/schemas/ServiceDeskIntegrationDto.yaml @@ -1,19 +1,37 @@ allOf: - - $ref: './BaseCommonDto.yaml' - type: object - description: Specification of a Service Desk integration + description: Service Desk integration's specification. required: + - name - description - type - attributes properties: + id: + type: string + description: Unique identifier for the Service Desk integration + example: 62945a496ef440189b1f03e3623411c8 + name: + description: Service Desk integration's name. The name must be unique. + type: string + example: Service Desk Integration Name + created: + type: string + format: date-time + description: The date and time the Service Desk integration was created + example: '2024-01-17T18:45:25.994Z' + modified: + type: string + format: date-time + description: The date and time the Service Desk integration was last modified + example: '2024-02-18T18:45:25.994Z' description: - description: Description of the Service Desk integration + description: Service Desk integration's description. type: string example: A very nice Service Desk integration type: description: | - Service Desk integration types + Service Desk integration types: - ServiceNowSDIM - ServiceNow @@ -21,31 +39,17 @@ allOf: default: ServiceNowSDIM example: ServiceNowSDIM ownerRef: - type: object - description: Source for Service Desk integration template. - properties: - type: - type: string - description: DTO type of source for service desk integration template. - enum: - - SOURCE - example: SOURCE - id: - type: string - description: ID of source for service desk integration template. - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Human-readable name of source for service desk integration template. - example: HR Active Directory + allOf: + - $ref: '../../v3/schemas/OwnerDto.yaml' clusterRef: allOf: - $ref: '../../v3/schemas/SourceClusterDto.yaml' cluster: - description: ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility). + description: Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility). type: string example: xyzzy999 deprecated: true + nullable: true managedSources: description: Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility). type: array @@ -59,7 +63,7 @@ allOf: description: The 'provisioningConfig' property specifies the configuration used to provision integrations. $ref: './ProvisioningConfig.yaml' attributes: - description: Attributes of the Service Desk integration. Validation constraints enforced by the implementation. + description: Service Desk integration's attributes. Validation constraints enforced by the implementation. type: object additionalProperties: true example: { diff --git a/static/api-specs/idn/v3/schemas/SodExemptCriteria.yaml b/static/api-specs/idn/v3/schemas/SodExemptCriteria.yaml index f342afd22..e6d152d25 100644 --- a/static/api-specs/idn/v3/schemas/SodExemptCriteria.yaml +++ b/static/api-specs/idn/v3/schemas/SodExemptCriteria.yaml @@ -3,6 +3,7 @@ type: object properties: existing: type: boolean + default: false example: true description: If the entitlement already belonged to the user or not. type: diff --git a/static/api-specs/idn/v3/schemas/SodViolationCheckResult.yaml b/static/api-specs/idn/v3/schemas/SodViolationCheckResult.yaml index 18ce24d14..e865c73a7 100644 --- a/static/api-specs/idn/v3/schemas/SodViolationCheckResult.yaml +++ b/static/api-specs/idn/v3/schemas/SodViolationCheckResult.yaml @@ -11,6 +11,7 @@ properties: text: "An error has occurred during the SOD violation check" clientMetadata: type: object + nullable: true additionalProperties: type: string description: >- @@ -21,10 +22,12 @@ properties: requestedAppId: 2c91808f7892918f0178b78da4a305a1 violationContexts: type: array + nullable: true items: $ref: './SodViolationContext.yaml' violatedPolicies: type: array + nullable: true description: A list of the SOD policies that were violated. items: $ref: './SodPolicyDto.yaml' diff --git a/static/api-specs/idn/v3/schemas/SodViolationContextCheckCompleted.yaml b/static/api-specs/idn/v3/schemas/SodViolationContextCheckCompleted.yaml index 869472c27..0e2223528 100644 --- a/static/api-specs/idn/v3/schemas/SodViolationContextCheckCompleted.yaml +++ b/static/api-specs/idn/v3/schemas/SodViolationContextCheckCompleted.yaml @@ -3,12 +3,17 @@ type: object properties: state: type: string - enum: [ SUCCESS, ERROR ] + enum: + - SUCCESS + - ERROR + - null description: The status of SOD violation check example: "SUCCESS" + nullable: true uuid: description: The id of the Violation check event type: string example: "f73d16e9-a038-46c5-b217-1246e15fdbdd" + nullable: true violationCheckResult: $ref: "./SodViolationCheckResult.yaml" \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/Source.yaml b/static/api-specs/idn/v3/schemas/Source.yaml index 11ec25fea..16f304b07 100644 --- a/static/api-specs/idn/v3/schemas/Source.yaml +++ b/static/api-specs/idn/v3/schemas/Source.yaml @@ -34,6 +34,7 @@ properties: cluster: description: Reference to the associated Cluster type: object + nullable: true required: - name - id @@ -56,6 +57,7 @@ properties: accountCorrelationConfig: description: Reference to an Account Correlation Config object type: object + nullable: true properties: type: description: The type of object being referenced @@ -76,6 +78,7 @@ properties: Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used. type: object + nullable: true properties: type: description: The type of object being referenced @@ -92,14 +95,17 @@ properties: description: Human-readable display name of the rule example: Example Rule managerCorrelationMapping: - $ref: '../../v3/schemas/ManagerCorrelationMapping.yaml' - description: >- - Filter Object used during manager correlation to match incoming manager values to an existing manager's - Account/Identity + allOf: + - $ref: '../../v3/schemas/ManagerCorrelationMapping.yaml' + - nullable: true + description: | + Filter Object used during manager correlation to match incoming manager values to an existing manager's + Account/Identity managerCorrelationRule: description: >- Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient. type: object + nullable: true properties: type: description: The type of object being referenced @@ -119,6 +125,7 @@ properties: description: >- Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. type: object + nullable: true properties: type: description: The type of object being referenced @@ -164,6 +171,7 @@ properties: name: "group" passwordPolicies: type: array + nullable: true items: type: object properties: @@ -246,6 +254,7 @@ properties: managementWorkgroup: description: Reference to Management Workgroup for this Source type: object + nullable: true properties: type: description: The type of object being referenced @@ -293,7 +302,17 @@ properties: type: string description: The connector implementation id example: "delimited-file" + created: + type: string + description: The date-time when the source was created + format: date-time + example: 2022-02-08T14:50:03.827Z + modified: + type: string + description: The date-time when the source was last modified + format: date-time + example: 2024-01-23T18:08:50.897Z required: - name - owner - - connector \ No newline at end of file + - connector diff --git a/static/api-specs/idn/v3/schemas/TaggedObjectDto.yaml b/static/api-specs/idn/v3/schemas/TaggedObjectDto.yaml index 4a4a06023..e36be7fc4 100644 --- a/static/api-specs/idn/v3/schemas/TaggedObjectDto.yaml +++ b/static/api-specs/idn/v3/schemas/TaggedObjectDto.yaml @@ -15,10 +15,10 @@ properties: description: DTO type id: type: string - description: ID of the object to which this reference applies + description: ID of the object this reference applies to example: 2c91808568c529c60168cca6f90c1313 name: type: string nullable: true - description: Human-readable display name of the object to which this reference applies + description: Human-readable display name of the object this reference applies to example: William Wilson \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/Transform.yaml b/static/api-specs/idn/v3/schemas/Transform.yaml index 2a35fb7f9..cde5ca06f 100644 --- a/static/api-specs/idn/v3/schemas/Transform.yaml +++ b/static/api-specs/idn/v3/schemas/Transform.yaml @@ -56,9 +56,9 @@ properties: description: Transform Operations url: https://developer.sailpoint.com/idn/docs/transforms/operations attributes: + nullable: true description: >- Meta-data about the transform. Values in this list are specific to the type of transform to be executed. - nullable: true oneOf: - $ref: './transforms/AccountAttribute.yaml' - $ref: './transforms/Base64Decode.yaml' diff --git a/static/api-specs/idn/v3/schemas/UpdateDetail.yaml b/static/api-specs/idn/v3/schemas/UpdateDetail.yaml new file mode 100644 index 000000000..e80d3333d --- /dev/null +++ b/static/api-specs/idn/v3/schemas/UpdateDetail.yaml @@ -0,0 +1,26 @@ +type: object +properties: + message: + type: string + description: The detailed message for an update. Typically the relevent error message when status is error. + example: "unsupported xsd version, please ensure latest xsd version http://www.sailpoint.com/xsd/sailpoint_form_2_0.xsd is used for source config" + scriptName: + type: string + description: The connector script name + example: "servicenow" + updatedFiles: + type: array + description: The list of updated files supported by the connector + nullable: true + items: + type: string + example: ["pod/org/connectorFiles/testconnector/test1.jar"] + status: + type: string + enum: + - ERROR + - UPDATED + - UNCHANGED + - SKIPPED + description: The connector update status + example: "ERROR" \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/V3ConnectorDto.yaml b/static/api-specs/idn/v3/schemas/V3ConnectorDto.yaml new file mode 100644 index 000000000..8e7d11624 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/V3ConnectorDto.yaml @@ -0,0 +1,49 @@ +title: custom connector response object +type: object +properties: + name: + type: string + description: The connector name + example: "name" + type: + type: string + description: The connector type + example: "ServiceNow" + scriptName: + type: string + description: The connector script name + example: "servicenow" + className: + type: string + description: The connector class name. + example: "sailpoint.connector.OpenConnectorAdapter" + features: + type: array + description: The list of features supported by the connector + nullable: true + items: + type: string + example: ["PROVISIONING", "SYNC_PROVISIONING", "SEARCH", "UNSTRUCTURED_TARGETS"] + directConnect: + type: boolean + description: true if the source is a direct connect source + example: true + default: false + connectorMetadata: + type: object + additionalProperties: true + description: A map containing metadata pertinent to the connector + example: { + "supportedUI": "ANGULAR", + "platform": "ccg", + "shortDesc": "connector description" + } + status: + type: string + enum: + - DEPRECATED + - DEVELOPMENT + - DEMO + - RELEASED + description: The connector status + example: "RELEASED" \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/V3CreateConnectorDto.yaml b/static/api-specs/idn/v3/schemas/V3CreateConnectorDto.yaml new file mode 100644 index 000000000..16f908c8c --- /dev/null +++ b/static/api-specs/idn/v3/schemas/V3CreateConnectorDto.yaml @@ -0,0 +1,31 @@ +title: custom connector create request +type: object +required: + - name + - className +properties: + name: + type: string + description: The connector name. Need to be unique per tenant. The name will able be used to derive a url friendly unique scriptname that will be in response. Script name can then be used for all update endpoints + example: "custom connector" + type: + type: string + description: The connector type. If not specified will be defaulted to 'custom '+name + example: "custom connector type" + className: + type: string + description: The connector class name. If you are implementing openconnector standard (what is recommended), then this need to be set to sailpoint.connector.OpenConnectorAdapter + example: "sailpoint.connector.OpenConnectorAdapter" + directConnect: + type: boolean + description: true if the source is a direct connect source + default: true + example: true + status: + type: string + enum: + - DEVELOPMENT + - DEMO + - RELEASED + description: The connector status + example: "RELEASED" diff --git a/static/api-specs/idn/v3/schemas/Value.yaml b/static/api-specs/idn/v3/schemas/Value.yaml index 514d0721c..61c2e651f 100644 --- a/static/api-specs/idn/v3/schemas/Value.yaml +++ b/static/api-specs/idn/v3/schemas/Value.yaml @@ -1,4 +1,5 @@ type: object +nullable: true properties: type: type: string diff --git a/static/api-specs/idn/v3/schemas/WorkItemState.yaml b/static/api-specs/idn/v3/schemas/WorkItemState.yaml index 4aee03751..b57edcece 100644 --- a/static/api-specs/idn/v3/schemas/WorkItemState.yaml +++ b/static/api-specs/idn/v3/schemas/WorkItemState.yaml @@ -6,5 +6,6 @@ enum: - EXPIRED - PENDING - CANCELED + - null example: FINISHED description: The state of a work item \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/WorkItemStateManualWorkItems.yaml b/static/api-specs/idn/v3/schemas/WorkItemStateManualWorkItems.yaml new file mode 100644 index 000000000..0c556a762 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/WorkItemStateManualWorkItems.yaml @@ -0,0 +1,10 @@ +type: string +enum: + - Finished + - Rejected + - Returned + - Expired + - Pending + - Canceled +example: Finished +description: The state of a work item \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/WorkItemTypeManualWorkItems.yaml b/static/api-specs/idn/v3/schemas/WorkItemTypeManualWorkItems.yaml new file mode 100644 index 000000000..ab9cf5088 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/WorkItemTypeManualWorkItems.yaml @@ -0,0 +1,18 @@ +type: string +enum: + - Generic + - Certification + - Remediation + - Delegation + - Approval + - ViolationReview + - Form + - PolicyVioloation + - Challenge + - ImpactAnalysis + - Signoff + - Event + - ManualAction + - Test +example: Generic +description: The type of the work item \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/WorkItems.yaml b/static/api-specs/idn/v3/schemas/WorkItems.yaml index 9102e4480..487c0f7a1 100644 --- a/static/api-specs/idn/v3/schemas/WorkItems.yaml +++ b/static/api-specs/idn/v3/schemas/WorkItems.yaml @@ -8,14 +8,17 @@ properties: type: string description: ID of the requester example: 2c9180835d2e5168015d32f890ca1581 + nullable: true requesterDisplayName: type: string description: The displayname of the requester example: John Smith + nullable: true ownerId: type: string description: The ID of the owner example: 2c9180835d2e5168015d32f890ca1581 + nullable: true ownerName: type: string description: The name of the owner @@ -30,34 +33,48 @@ properties: format: 'date-time' example: '2018-06-25T20:22:28.104Z' description: Time when the work item was last updated + nullable: true description: type: string description: The description of the work item example: Create account on source 'AD' state: - $ref: './WorkItemState.yaml' + $ref: './WorkItemStateManualWorkItems.yaml' type: - $ref: './WorkItemType.yaml' + $ref: './WorkItemTypeManualWorkItems.yaml' remediationItems: - $ref: './RemediationItemDetails.yaml' + type: array + nullable: true + items: + $ref: './RemediationItemDetails.yaml' + description: A list of remediation items approvalItems: - $ref: './ApprovalItemDetails.yaml' + type: array + nullable: true + items: + $ref: './ApprovalItemDetails.yaml' + description: A list of items that need to be approved name: type: string description: The work item name example: Account Create + nullable: true completed: type: string format: 'date-time' example: '2018-10-19T13:49:37.385Z' description: The time at which the work item completed + nullable: true numItems: type: integer format: int32 description: The number of items in the work item example: 19 + nullable: true form: - $ref: './FormDetails.yaml' + allOf: + - $ref: './FormDetails.yaml' + - nullable: true errors: type: array items: diff --git a/static/api-specs/idn/v3/schemas/access/AccessProfile.yaml b/static/api-specs/idn/v3/schemas/access/AccessProfile.yaml index 322ec501a..d18f0a6a0 100644 --- a/static/api-specs/idn/v3/schemas/access/AccessProfile.yaml +++ b/static/api-specs/idn/v3/schemas/access/AccessProfile.yaml @@ -1,4 +1,5 @@ type: object +description: Access Profile properties: id: type: string @@ -28,6 +29,7 @@ properties: readOnly: true enabled: type: boolean + default: true description: Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. example: true owner: @@ -43,6 +45,7 @@ properties: $ref: './EntitlementRef.yaml' requestable: type: boolean + default: true description: >- Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value diff --git a/static/api-specs/idn/v3/schemas/access/AccessProfileBulkUpdateRequest.yaml b/static/api-specs/idn/v3/schemas/access/AccessProfileBulkUpdateRequest.yaml new file mode 100644 index 000000000..70d369b86 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/access/AccessProfileBulkUpdateRequest.yaml @@ -0,0 +1,22 @@ +description: List of Access profiles to be updated. +type: array +items: + type: object + description: Access Profile's basic details. + properties: + id: + type: string + description: Access Profile ID. + example: 464ae7bf-791e-49fd-b746-06a2e4a8 + requestable: + type: boolean + description: Access Profile is requestable or not. + example: false +example: + [ + { + "id": "464ae7bf-791e-49fd-b746-06a2e4a8", + "requestable": false + } + ] +required: [id, requestable] \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/access/AccessProfileBulkUpdateResponse.yaml b/static/api-specs/idn/v3/schemas/access/AccessProfileBulkUpdateResponse.yaml new file mode 100644 index 000000000..bc56b617e --- /dev/null +++ b/static/api-specs/idn/v3/schemas/access/AccessProfileBulkUpdateResponse.yaml @@ -0,0 +1,13 @@ +description: Access Profile Bulk update response. +type: array +items: + $ref: "./AccessProfileUpdateItem.yaml" +example: + [ + { + "id": "464ae7bf-791e-49fd-b746-06a2e4a8", + "status": "201", + "requestable": false, + "description": "Access Profile updated successfully." + } + ] diff --git a/static/api-specs/idn/v3/schemas/access/AccessProfileUpdateItem.yaml b/static/api-specs/idn/v3/schemas/access/AccessProfileUpdateItem.yaml new file mode 100644 index 000000000..492f896ee --- /dev/null +++ b/static/api-specs/idn/v3/schemas/access/AccessProfileUpdateItem.yaml @@ -0,0 +1,36 @@ +type: object +properties: + id: + description: Identifier of Access Profile in bulk update request. + type: string + example: "2c7180a46faadee4016fb4e018c20642" + requestable: + description: Access Profile requestable or not. + type: boolean + example: false + status: + description: > + + The HTTP response status code returned for an individual Access Profile that is requested for update during a bulk update operation. + + + > 201 - Access profile is updated successfully. + + + > 404 - Access profile not found. + + type: string + example: "201" + description: + description: > + Human readable status description and containing additional + context information about success or failures etc. + type: string + example: > + + > Access profile is updated successfully. + + + > Referenced Access profile with Id "2c7180a46faadee4016fb4e018c20642" was not found. + +required: [id, requestable, status] \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/access/EntitlementRef.yaml b/static/api-specs/idn/v3/schemas/access/EntitlementRef.yaml index 1c51bebcc..de860c3df 100644 --- a/static/api-specs/idn/v3/schemas/access/EntitlementRef.yaml +++ b/static/api-specs/idn/v3/schemas/access/EntitlementRef.yaml @@ -13,5 +13,6 @@ properties: example: 2c91809773dee32014e13e122092014e name: type: string + nullable: true description: Entitlement's display name. example: "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local" diff --git a/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaLevel3.yaml b/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaLevel3.yaml index 4f8d461a8..97dd2b61d 100644 --- a/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaLevel3.yaml +++ b/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaLevel3.yaml @@ -17,5 +17,12 @@ properties: NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. example: "carlee.cert1c9f9b6fd@mailinator.com" + children: + type: string + description: >- + Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum + of three levels of criteria are supported, including leaf nodes. + example: null + nullable: true diff --git a/static/api-specs/idn/v3/schemas/access/Requestability.yaml b/static/api-specs/idn/v3/schemas/access/Requestability.yaml index a7624b513..48091512e 100644 --- a/static/api-specs/idn/v3/schemas/access/Requestability.yaml +++ b/static/api-specs/idn/v3/schemas/access/Requestability.yaml @@ -1,15 +1,21 @@ type: object +nullable : true properties: commentsRequired: type: boolean description: Whether the requester of the containing object must provide comments justifying the request example: true + nullable: true + default: false denialCommentsRequired: type: boolean description: Whether an approver must provide comments when denying the request example: true + nullable: true + default: false approvalSchemes: type: array + nullable : true description: List describing the steps in approving the request items: $ref: './AccessProfileApprovalScheme.yaml' diff --git a/static/api-specs/idn/v3/schemas/access/Revocability.yaml b/static/api-specs/idn/v3/schemas/access/Revocability.yaml index 71055d11e..505d191b1 100644 --- a/static/api-specs/idn/v3/schemas/access/Revocability.yaml +++ b/static/api-specs/idn/v3/schemas/access/Revocability.yaml @@ -1,19 +1,9 @@ type: object +nullable : true properties: - commentsRequired: - type: boolean - description: Whether the requester of the containing object must provide comments justifying the request - example: false - nullable: true - default: false - denialCommentsRequired: - type: boolean - description: Whether an approver must provide comments when denying the request - example: false - nullable: true - default: false approvalSchemes: type: array + nullable: true description: List describing the steps in approving the revocation request items: $ref: './AccessProfileApprovalScheme.yaml' diff --git a/static/api-specs/idn/v3/schemas/access/RevocabilityForRole.yaml b/static/api-specs/idn/v3/schemas/access/RevocabilityForRole.yaml new file mode 100644 index 000000000..ccf7591b3 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/access/RevocabilityForRole.yaml @@ -0,0 +1,20 @@ +type: object +properties: + commentsRequired: + type: boolean + description: Whether the requester of the containing object must provide comments justifying the request + example: false + nullable: true + default: false + denialCommentsRequired: + type: boolean + description: Whether an approver must provide comments when denying the request + example: false + nullable: true + default: false + approvalSchemes: + type: array + description: List describing the steps in approving the revocation request + items: + $ref: './ApprovalSchemeForRole.yaml' + diff --git a/static/api-specs/idn/v3/schemas/access/Role.yaml b/static/api-specs/idn/v3/schemas/access/Role.yaml index 2bfb59e49..d6fd7cf17 100644 --- a/static/api-specs/idn/v3/schemas/access/Role.yaml +++ b/static/api-specs/idn/v3/schemas/access/Role.yaml @@ -34,6 +34,10 @@ properties: items: $ref: './AccessProfileRef.yaml' nullable: true + entitlements: + type: array + items: + $ref: './EntitlementRef.yaml' membership: $ref: './RoleMembershipSelector.yaml' nullable: true @@ -62,7 +66,7 @@ properties: nullable: true description: Access request configuration for this object revocationRequestConfig: - $ref: './Revocability.yaml' + $ref: './RevocabilityForRole.yaml' nullable: true default: null description: >- diff --git a/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeSourceWithNECount.yaml b/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeSourceWithNECount.yaml index f135bb533..361097608 100644 --- a/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeSourceWithNECount.yaml +++ b/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeSourceWithNECount.yaml @@ -7,3 +7,4 @@ allOf: description: Number of non-employee records associated with this source. format: int32 example: 120 + nullable: true diff --git a/static/api-specs/idn/v3/schemas/reviews/ReviewableRole.yaml b/static/api-specs/idn/v3/schemas/reviews/ReviewableRole.yaml index bae2630ff..2619602ff 100644 --- a/static/api-specs/idn/v3/schemas/reviews/ReviewableRole.yaml +++ b/static/api-specs/idn/v3/schemas/reviews/ReviewableRole.yaml @@ -33,3 +33,8 @@ properties: description: The list of Access Profiles associated with this Role items: $ref: './ReviewableAccessProfile.yaml' + entitlements: + type: array + description: The list of entitlements associated with this Role + items: + $ref: './ReviewableEntitlement.yaml' diff --git a/static/api-specs/idn/v3/schemas/schedule/Schedule.yaml b/static/api-specs/idn/v3/schemas/schedule/Schedule.yaml index 1b19d3b28..2648657a4 100644 --- a/static/api-specs/idn/v3/schemas/schedule/Schedule.yaml +++ b/static/api-specs/idn/v3/schemas/schedule/Schedule.yaml @@ -3,6 +3,19 @@ description: The schedule information. properties: type: $ref: 'ScheduleType.yaml' + months: + allOf: + - $ref: Selector.yaml + - description: | + The months to execute the search. This only applies to schedules with a type of `ANNUALLY`. + example: + type: 'LIST' + values: + - "3" + - "6" + - "9" + - "12" + nullable: true days: allOf: - $ref: Selector.yaml @@ -11,7 +24,7 @@ properties: If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. - If `type` is `MONTHLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. + If `type` is `MONTHLY` or `ANNUALLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. example: type: 'LIST' values: @@ -33,10 +46,10 @@ properties: description: The schedule expiration date. Latest possible expiration date is '2038-01-19T03:14:07+0000' $ref: ../search/model/base/DateTime.yaml timeZoneId: - description: The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org's default timezone is used. + description: The canonical TZ identifier the schedule will run in (ex. America/New_York). If no timezone is specified, the org's default timezone is used. nullable: true type: string - example: 'GMT-06:00' + example: 'America/Chicago' required: - type - hours diff --git a/static/api-specs/idn/v3/schemas/schedule/ScheduleType.yaml b/static/api-specs/idn/v3/schemas/schedule/ScheduleType.yaml index c98800f65..17c754eba 100644 --- a/static/api-specs/idn/v3/schemas/schedule/ScheduleType.yaml +++ b/static/api-specs/idn/v3/schemas/schedule/ScheduleType.yaml @@ -8,4 +8,5 @@ enum: - WEEKLY - MONTHLY - CALENDAR +- ANNUALLY example: WEEKLY diff --git a/static/api-specs/idn/v3/schemas/search/documents/examples/accessProfile.yaml b/static/api-specs/idn/v3/schemas/search/documents/examples/accessProfile.yaml index 8d379c586..bd8892b77 100644 --- a/static/api-specs/idn/v3/schemas/search/documents/examples/accessProfile.yaml +++ b/static/api-specs/idn/v3/schemas/search/documents/examples/accessProfile.yaml @@ -2,7 +2,6 @@ summary: AccessProfile value: id: '2c9180825a6c1adc015a71c9023f0818' name: 'Cloud Eng' - _type: 'accessprofile' description: 'Cloud Eng' created: '2017-02-24T20:21:23.145Z' modified: '2019-05-24T20:36:04.312Z' diff --git a/static/api-specs/idn/v3/schemas/search/documents/examples/entitlement.yaml b/static/api-specs/idn/v3/schemas/search/documents/examples/entitlement.yaml index b99d86029..69a2654b6 100644 --- a/static/api-specs/idn/v3/schemas/search/documents/examples/entitlement.yaml +++ b/static/api-specs/idn/v3/schemas/search/documents/examples/entitlement.yaml @@ -2,7 +2,6 @@ summary: Entitlement value: id: '2c9180946ed0c43d016eec1a80892fbd' name: 'entitlement.aa415ae7' - _type: 'entitlement' description: 'null' attribute: 'groups' value: 'entitlement.aa415ae7' diff --git a/static/api-specs/idn/v3/schemas/search/documents/examples/event.yaml b/static/api-specs/idn/v3/schemas/search/documents/examples/event.yaml index 6b0cf7a89..9c06aae68 100644 --- a/static/api-specs/idn/v3/schemas/search/documents/examples/event.yaml +++ b/static/api-specs/idn/v3/schemas/search/documents/examples/event.yaml @@ -2,7 +2,6 @@ summary: Event value: id: 'e092842f-c904-4b59-aac8-2544abeeef4b' name: 'Update Task Schedule Passed' - _type: 'event' created: '2020-02-17T16:23:18.327Z' synced: '2020-02-17T16:23:18.388Z' action: 'TASK_SCHEDULE_UPDATE_PASSED' diff --git a/static/api-specs/idn/v3/schemas/search/documents/examples/identity.yaml b/static/api-specs/idn/v3/schemas/search/documents/examples/identity.yaml index ad0e6e5a3..b69269c10 100644 --- a/static/api-specs/idn/v3/schemas/search/documents/examples/identity.yaml +++ b/static/api-specs/idn/v3/schemas/search/documents/examples/identity.yaml @@ -2,7 +2,6 @@ summary: Identity value: id: '2c9180865c45e7e3015c46c434a80622' name: 'ad.admin' - _type: 'identity' firstName: 'AD' lastName: 'Admin' displayName: 'AD Admin' diff --git a/static/api-specs/idn/v3/schemas/search/documents/examples/role.yaml b/static/api-specs/idn/v3/schemas/search/documents/examples/role.yaml index 06c6ab0a1..448d667fb 100644 --- a/static/api-specs/idn/v3/schemas/search/documents/examples/role.yaml +++ b/static/api-specs/idn/v3/schemas/search/documents/examples/role.yaml @@ -2,7 +2,6 @@ summary: Role value: id: '2c91808c6faadea6016fb4f2bc69077b' name: 'IT Role' - _type: 'role' description: 'IT role' created: '2020-01-17T19:20:15.040Z' modified: null @@ -19,6 +18,18 @@ value: - id: '2c91809c6faade77016fb4f0b63407ae' name: 'Admin Access' accessProfileCount: 1 + segments: + - id: '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' + name: 'segment-xyz' + description: 'This segment represents xyz' + segmentCount: 1 + entitlements: + - id: '2c91809c6faade77016fb4f0b63407ae' + name: 'Admin Access' + description: 'Access to everything' + privileged: true + hasPermissions: true + entitlementCount: 1 tags: - 'TAG_1' - 'TAG_2' diff --git a/static/api-specs/idn/v3/schemas/search/model/access/BaseAccess.yaml b/static/api-specs/idn/v3/schemas/search/model/access/BaseAccess.yaml index 520f04a98..4e839c9ff 100644 --- a/static/api-specs/idn/v3/schemas/search/model/access/BaseAccess.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/access/BaseAccess.yaml @@ -4,24 +4,66 @@ allOf: properties: description: type: string - description: The description of the access item + description: Access item's description. example: "The admin role" created: - $ref: "../base/DateTime.yaml" + type: string + description: ISO-8601 date-time referring to the time when the object was created. + nullable: true + format: 'date-time' + example: '2018-06-25T20:22:28.104Z' modified: - $ref: "../base/DateTime.yaml" + type: string + description: ISO-8601 date-time referring to the time when the object was last modified. + nullable: true + format: 'date-time' + example: '2018-06-25T20:22:28.104Z' synced: - $ref: "../base/DateTime.yaml" + type: string + description: >- + ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. + + This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. + + There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. + nullable: true + format: 'date-time' + example: '2018-06-25T20:22:33.104Z' enabled: type: boolean + description: Indicates whether the access item is currently enabled. + default: false example: true requestable: type: boolean + description: Indicates whether the access item can be requested. + default: true example: true - description: Indicates if the access can be requested requestCommentsRequired: type: boolean - description: Indicates if comments are required when requesting access + description: Indicates whether comments are required for requests to access the item. + default: false example: false owner: - $ref: "../identity/Owner.yaml" + type: object + description: Owner's identity. + properties: + type: + type: string + description: Owner's DTO type. + enum: + - IDENTITY + example: IDENTITY + id: + type: string + description: Owner's identity ID. + example: 2c9180a46faadee4016fb4e018c20639 + name: + type: string + description: Owner's display name. + example: Support + email: + type: string + description: Owner's email. + example: cloud-support@sailpoint.com + diff --git a/static/api-specs/idn/v3/schemas/search/model/access/profile/AccessProfileDocument.yaml b/static/api-specs/idn/v3/schemas/search/model/access/profile/AccessProfileDocument.yaml index fcb94dd38..8ad1217fb 100644 --- a/static/api-specs/idn/v3/schemas/search/model/access/profile/AccessProfileDocument.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/access/profile/AccessProfileDocument.yaml @@ -1,18 +1,56 @@ description: >- - This is more of a complete representation of an access profile. + More complete representation of an access profile. allOf: -- $ref: '../../base/BaseDocument.yaml' - $ref: '../BaseAccess.yaml' - type: object + required: ["id", "name", "_type"] properties: + id: + type: string + description: Access profile's ID. + example: 2c9180825a6c1adc015a71c9023f0818 + name: + type: string + description: Access profile's name. + example: Cloud Eng + _type: + description: >- + Access profile's document type. + + This enum represents the currently supported document types. + + Additional values may be added in the future without notice. + type: string + enum: + - accessprofile + - accountactivity + - account + - aggregation + - entitlement + - event + - identity + - role + example: accessprofile source: - $ref: '../../base/Reference.yaml' + type: object + description: Access profile's source. + properties: + id: + type: string + description: Source's ID. + example: ff8081815757d4fb0157588f3d9d008f + name: + type: string + description: Source's name. + example: Employees entitlements: type: array + description: Entitlements the access profile has access to. items: $ref: '../../entitlement/BaseEntitlement.yaml' entitlementCount: type: integer + description: Number of entitlements. example: 5 tags: $ref: '../../base/Tags.yaml' diff --git a/static/api-specs/idn/v3/schemas/search/model/account/AccountSource.yaml b/static/api-specs/idn/v3/schemas/search/model/account/AccountSource.yaml index 9791cb3db..20ee7a072 100644 --- a/static/api-specs/idn/v3/schemas/search/model/account/AccountSource.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/account/AccountSource.yaml @@ -5,4 +5,4 @@ allOf: type: type: string example: Delimited File - description: the type of source returned + description: Type of source returned. diff --git a/static/api-specs/idn/v3/schemas/search/model/account/BaseAccount.yaml b/static/api-specs/idn/v3/schemas/search/model/account/BaseAccount.yaml index 19f4024b3..b35e903e6 100644 --- a/static/api-specs/idn/v3/schemas/search/model/account/BaseAccount.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/account/BaseAccount.yaml @@ -4,36 +4,44 @@ allOf: properties: accountId: type: string - description: The ID of the account - example: "john.doe" + description: Account ID. + example: John.Doe source: $ref: "AccountSource.yaml" disabled: type: boolean - description: Indicates if the account is disabled + description: Indicates whether the account is disabled. + default: false example: false locked: type: boolean - description: Indicates if the account is locked + description: Indicates whether the account is locked. + default: false example: false privileged: type: boolean + description: Indicates whether the account is privileged. + default: false example: false manuallyCorrelated: type: boolean - description: - Indicates if the account has been manually correlated to an identity + description: Indicates whether the account has been manually correlated to an identity. + default: false example: false passwordLastSet: $ref: "../base/DateTime.yaml" entitlementAttributes: type: object nullable: true - description: "a map or dictionary of key/value pairs" + description: Map or dictionary of key/value pairs. additionalProperties: true example: moderator: true admin: true trust_level: "4" created: - $ref: "../base/DateTime.yaml" + type: string + description: ISO-8601 date-time referring to the time when the object was created. + nullable: true + format: 'date-time' + example: '2018-06-25T20:22:28.104Z' diff --git a/static/api-specs/idn/v3/schemas/search/model/account/activity/AccountActivityDocument.yaml b/static/api-specs/idn/v3/schemas/search/model/account/activity/AccountActivityDocument.yaml index bbc772085..ae72acde3 100644 --- a/static/api-specs/idn/v3/schemas/search/model/account/activity/AccountActivityDocument.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/account/activity/AccountActivityDocument.yaml @@ -5,26 +5,35 @@ allOf: properties: action: type: string - description: The type of action that this activity performed + description: Type of action performed in the activity. externalDocs: description: Learn more about account activity action types url: https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data example: Identity Refresh. created: - $ref: "../../base/DateTime.yaml" + type: string + description: ISO-8601 date-time referring to the time when the object was created. + nullable: true + format: 'date-time' + example: '2018-06-25T20:22:28.104Z' modified: - $ref: "../../base/DateTime.yaml" + type: string + description: ISO-8601 date-time referring to the time when the object was last modified. + nullable: true + format: 'date-time' + example: '2018-06-25T20:22:28.104Z' stage: type: string - description: The current stage of the activity + description: Activity's current stage. example: Completed origin: type: string + description: Activity's origin. nullable: true example: null status: type: string - description: the current status of the activity + description: Activity's current status. example: Complete requester: $ref: "../AccountSource.yaml" @@ -32,35 +41,43 @@ allOf: $ref: "../AccountSource.yaml" trackingNumber: type: string + description: Account activity's tracking number. example: 61aad0c9e8134eca89e76a35e0cabe3f errors: type: array + description: Errors provided by the source while completing account actions. items: type: string nullable: true example: null warnings: type: array + description: Warnings provided by the source while completing account actions. items: type: string nullable: true example: null approvals: type: array + description: Approvals performed on an item during activity. items: $ref: "Approval.yaml" originalRequests: type: array + description: Original actions that triggered all individual source actions related to the account action. items: $ref: "OriginalRequest.yaml" expansionItems: type: array + description: Controls that translated the attribute requests into actual provisioning actions on the source. items: $ref: "ExpansionItem.yaml" accountRequests: type: array + description: Account data for each individual source action triggered by the original requests. items: $ref: "AccountRequest.yaml" sources: type: string + description: Sources involved in the account activity. example: "smartsheet-test, airtable-v4, IdentityNow" diff --git a/static/api-specs/idn/v3/schemas/search/model/account/activity/AttributeRequest.yaml b/static/api-specs/idn/v3/schemas/search/model/account/activity/AttributeRequest.yaml index 342a26af8..01d333fcd 100644 --- a/static/api-specs/idn/v3/schemas/search/model/account/activity/AttributeRequest.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/account/activity/AttributeRequest.yaml @@ -2,13 +2,13 @@ type: object properties: name: type: string - description: The attribute name + description: Attribute name. example: groups op: type: string - description: The operation to perform + description: Operation to perform on attribute. example: Add value: type: string - description: The value of the attribute + description: Value of attribute. example: "3203537556531076" diff --git a/static/api-specs/idn/v3/schemas/search/model/account/activity/OriginalRequest.yaml b/static/api-specs/idn/v3/schemas/search/model/account/activity/OriginalRequest.yaml index 141f0f717..6170f4086 100644 --- a/static/api-specs/idn/v3/schemas/search/model/account/activity/OriginalRequest.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/account/activity/OriginalRequest.yaml @@ -2,15 +2,17 @@ type: object properties: accountId: type: string - description: the account id + description: Account ID. example: CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com attributeRequests: type: array + description: Attribute changes requested for account. items: $ref: 'AttributeRequest.yaml' op: type: string - description: the operation that was used + description: Operation used. example: add source: + description: Account's source. $ref: '../AccountSource.yaml' diff --git a/static/api-specs/idn/v3/schemas/search/model/base/BaseAccessProfile.yaml b/static/api-specs/idn/v3/schemas/search/model/base/BaseAccessProfile.yaml new file mode 100644 index 000000000..dcfed2d4c --- /dev/null +++ b/static/api-specs/idn/v3/schemas/search/model/base/BaseAccessProfile.yaml @@ -0,0 +1,10 @@ +type: object +properties: + id: + type: string + example: 2c91809c6faade77016fb4f0b63407ae + description: Access profile's unique ID. + name: + type: string + example: Admin Access + description: Access profile's display name. diff --git a/static/api-specs/idn/v3/schemas/search/model/base/BaseSegment.yaml b/static/api-specs/idn/v3/schemas/search/model/base/BaseSegment.yaml new file mode 100644 index 000000000..a8eb3427f --- /dev/null +++ b/static/api-specs/idn/v3/schemas/search/model/base/BaseSegment.yaml @@ -0,0 +1,10 @@ +type: object +properties: + id: + type: string + example: b009b6e3-b56d-41d9-8735-cb532ea0b017 + description: Segment's unique ID. + name: + type: string + example: Test Segment + description: Segment's display name. diff --git a/static/api-specs/idn/v3/schemas/search/model/base/Tags.yaml b/static/api-specs/idn/v3/schemas/search/model/base/Tags.yaml index 34779dc09..7fdb0d6ad 100644 --- a/static/api-specs/idn/v3/schemas/search/model/base/Tags.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/base/Tags.yaml @@ -1,4 +1,5 @@ type: array +description: Tags that have been applied to the object. items: type: string example: diff --git a/static/api-specs/idn/v3/schemas/search/model/entitlement/BaseEntitlement.yaml b/static/api-specs/idn/v3/schemas/search/model/entitlement/BaseEntitlement.yaml index 3eda51512..95d99ee52 100644 --- a/static/api-specs/idn/v3/schemas/search/model/entitlement/BaseEntitlement.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/entitlement/BaseEntitlement.yaml @@ -1,16 +1,36 @@ -allOf: - - $ref: "../base/Reference.yaml" - - type: object - properties: - description: - type: string - description: A description of the entitlement - example: The admin privilege - attribute: - type: string - description: The name of the entitlement attribute - example: admin - value: - type: string - description: The value of the entitlement - example: "true" +type: object +properties: + hasPermissions: + type: boolean + description: Indicates whether the entitlement has permissions. + default: false + example: false + description: + type: string + description: Entitlement's description. + example: Cloud engineering + attribute: + type: string + description: Entitlement attribute's name. + example: memberOf + value: + type: string + description: Entitlement's value. + example: "CN=Cloud Engineering,DC=sailpoint,DC=COM" + schema: + type: string + description: Entitlement's schema. + example: group + privileged: + type: boolean + description: Indicates whether the entitlement is privileged. + default: false + example: false + id: + type: string + description: Entitlement's ID. + example: 2c918084575812550157589064f33b89 + name: + type: string + description: Entitlement's name. + example: "CN=Cloud Engineering,DC=sailpoint,DC=COM" diff --git a/static/api-specs/idn/v3/schemas/search/model/entitlement/EntitlementDocument.yaml b/static/api-specs/idn/v3/schemas/search/model/entitlement/EntitlementDocument.yaml index a3c67decd..53f478107 100644 --- a/static/api-specs/idn/v3/schemas/search/model/entitlement/EntitlementDocument.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/entitlement/EntitlementDocument.yaml @@ -1,24 +1,72 @@ description: Entitlement allOf: - $ref: "../base/BaseDocument.yaml" - - $ref: "BaseEntitlement.yaml" - type: object properties: modified: - $ref: "../base/DateTime.yaml" + type: string + description: ISO-8601 date-time referring to the time when the object was last modified. + nullable: true + format: 'date-time' + example: '2018-06-25T20:22:28.104Z' synced: - $ref: "../base/DateTime.yaml" + type: string + description: >- + ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. + + This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. + + There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. displayName: type: string - description: The display name of the entitlement + description: Entitlement's display name. example: Admin source: - $ref: "../base/Reference.yaml" + type: object + description: Entitlement's source. + properties: + id: + type: string + description: ID of entitlement's source. + example: 2c91808b6e9e6fb8016eec1a2b6f7b5f + name: + type: string + description: Display name of entitlement's source. + example: ODS-HR-Employees + segments: + type: array + description: Segments with the role. + items: + $ref: '../base/BaseSegment.yaml' + segmentCount: + type: integer + description: Number of segments with the role. + format: int32 + example: 1 + requestable: + type: boolean + description: Indicates whether the entitlement is requestable. + default: false + example: false + cloudGoverned: + type: boolean + description: Indicates whether the entitlement is cloud governed. + default: false + example: false + created: + type: string + description: ISO-8601 date-time referring to the time when the object was created. + nullable: true + format: 'date-time' + example: '2018-06-25T20:22:28.104Z' privileged: type: boolean + description: Indicates whether the entitlement is privileged. + default: false example: false identityCount: type: integer + description: Number of identities who have access to the entitlement. format: int32 example: 3 tags: diff --git a/static/api-specs/idn/v3/schemas/search/model/event/EventDocument.yaml b/static/api-specs/idn/v3/schemas/search/model/event/EventDocument.yaml index 153f74a28..d100e400e 100644 --- a/static/api-specs/idn/v3/schemas/search/model/event/EventDocument.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/event/EventDocument.yaml @@ -4,35 +4,54 @@ allOf: - type: object properties: created: - $ref: "../base/DateTime.yaml" + type: string + description: ISO-8601 date-time referring to the time when the object was created. + nullable: true + format: 'date-time' + example: '2018-06-25T20:22:28.104Z' synced: - $ref: "../base/DateTime.yaml" + type: string + description: >- + ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. + + This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. + + There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. action: type: string - description: The action that was performed + description: Name of the event as it's displayed in audit reports. example: update type: type: string - description: The type of event + description: Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. example: SYSTEM_CONFIG actor: - $ref: "NameType.yaml" + type: string + description: Name of the actor that generated the event. + example: System target: - $ref: "NameType.yaml" + type: string + description: Name of the target, or recipient, of the event. + example: Carol.Adams stack: type: string + description: The event's stack. example: tpe trackingNumber: type: string + description: ID of the group of events. example: 63f891e0735f4cc8bf1968144a1e7440 ipAddress: type: string + description: Target system's IP address. example: "52.52.97.85" details: type: string + description: ID of event's details. example: 73b65dfbed1842548c207432a18c84b0 attributes: type: object + description: Attributes involved in the event. additionalProperties: true example: pod: stg03-useast1 @@ -40,15 +59,19 @@ allOf: sourceName: SailPoint objects: type: array + description: Objects the event is happening to. items: type: string example: AUTHENTICATION operation: type: string + description: Operation, or action, performed during the event. example: REQUEST status: type: string + description: Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. example: PASSED technicalName: type: string + description: Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'. example: AUTHENTICATION_REQUEST_PASSED diff --git a/static/api-specs/idn/v3/schemas/search/model/identity/IdentityDocument.yaml b/static/api-specs/idn/v3/schemas/search/model/identity/IdentityDocument.yaml index 0fd2e0a25..0dc105d5a 100644 --- a/static/api-specs/idn/v3/schemas/search/model/identity/IdentityDocument.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/identity/IdentityDocument.yaml @@ -4,60 +4,112 @@ allOf: - $ref: '../base/DisplayReference.yaml' - type: object properties: - firstName: - type: string - description: The first name of the identity - example: Carol - lastName: - type: string - description: The last name of the identity - example: Adams displayName: type: string example: Carol.Adams - description: The display name of the identity + description: Identity's display name. + firstName: + type: string + description: Identity's first name. + example: Carol + lastName: + type: string + description: Identity's last name. + example: Adams email: type: string - description: The identity's primary email address + description: Identity's primary email address. example: Carol.Adams@sailpointdemo.com created: - $ref: '../base/DateTime.yaml' + type: string + description: ISO-8601 date-time referring to the time when the object was created. + nullable: true + format: 'date-time' + example: '2018-06-25T20:22:28.104Z' modified: - $ref: '../base/DateTime.yaml' - synced: - $ref: '../base/DateTime.yaml' + type: string + description: ISO-8601 date-time referring to the time when the object was last modified. + nullable: true + format: 'date-time' + example: '2018-06-25T20:22:28.104Z' phone: type: string - description: The phone number of the identity + description: Identity's phone number. example: "+1 440-527-3672" + synced: + type: string + description: >- + ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. + + This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. + + There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. inactive: type: boolean - description: Indicates if the identity is inactive + description: Indicates whether the identity is inactive. + default: false example: false protected: type: boolean + description: Indicates whether the identity is protected. + default: false example: false status: type: string - description: The identity's status in SailPoint + description: Identity's status in SailPoint. example: UNREGISTERED employeeNumber: type: string + description: Identity's employee number. example: 1a2a3d4e manager: - $ref: '../base/DisplayReference.yaml' + type: object + description: Identity's manager. nullable: true + properties: + id: + type: string + description: ID of identity's manager. + example: 2c9180867dfe694b017e208e27c05799 + name: + type: string + description: Name of identity's manager. + example: Amanda.Ross + displayName: + type: string + description: Display name of identity's manager. + example: Amanda.Ross isManager: type: boolean - description: Indicates if this identity is a manager of other identities + description: Indicates whether the identity is a manager of other identities. example: false identityProfile: - $ref: '../base/Reference.yaml' + type: object + description: Identity's identity profile. + properties: + id: + type: string + description: Identity profile's ID. + example: 3bc8ad26b8664945866b31339d1ff7d2 + name: + type: string + description: Identity profile's name. + example: HR Employees source: - $ref: '../base/Reference.yaml' + type: object + description: Identity's source. + properties: + id: + type: string + description: ID of identity's source. + example: 2c91808b6e9e6fb8016eec1a2b6f7b5f + name: + type: string + description: Display name of identity's source. + example: ODS-HR-Employees attributes: type: object - description: "a map or dictionary of key/value pairs" + description: Map or dictionary of key/value pairs. additionalProperties: true example: country: "US" @@ -65,54 +117,67 @@ allOf: cloudStatus: "UNREGISTERED" processingState: type: string + description: Identity's processing state. nullable: true example: null processingDetails: $ref: 'ProcessingDetails.yaml' + description: Identity's processing details. nullable: true accounts: type: array - description: List of accounts associated with the identity + description: List of accounts associated with the identity. items: $ref: '../account/BaseAccount.yaml' accountCount: type: integer - description: Number of accounts associated with the identity + description: Number of accounts associated with the identity. format: int32 example: 3 apps: type: array - description: The list of applications the identity has access to + description: List of applications the identity has access to. items: $ref: 'App.yaml' appCount: type: integer format: int32 - description: The number of applications the identity has access to + description: Number of applications the identity has access to. example: 2 access: type: array - description: The list of access items assigned to the identity + description: List of access items assigned to the identity. items: $ref: 'IdentityAccess.yaml' accessCount: type: integer format: int32 - description: The number of access items assigned to the identity + description: Number of access items assigned to the identity. example: 5 - accessProfileCount: - type: integer - description: The number of access profiles assigned to the identity - example: 1 entitlementCount: type: integer - description: The number of entitlements assigned to the identity + format: int32 + description: Number of entitlements assigned to the identity. example: 10 roleCount: type: integer - description: The number of roles assigned to the identity + format: int32 + description: Number of roles assigned to the identity. + example: 1 + accessProfileCount: + type: integer + format: int32 + description: Number of access profiles assigned to the identity. example: 1 owns: - $ref: 'Owns.yaml' + type: array + description: Access items the identity owns. + items: + $ref: 'Owns.yaml' + ownsCount: + type: integer + format: int32 + description: Number of access items the identity owns. + example: 5 tags: $ref: '../base/Tags.yaml' diff --git a/static/api-specs/idn/v3/schemas/search/model/role/RoleDocument.yaml b/static/api-specs/idn/v3/schemas/search/model/role/RoleDocument.yaml index 24e89e53d..99ee9dad1 100644 --- a/static/api-specs/idn/v3/schemas/search/model/role/RoleDocument.yaml +++ b/static/api-specs/idn/v3/schemas/search/model/role/RoleDocument.yaml @@ -6,9 +6,33 @@ allOf: properties: accessProfiles: type: array + description: Access profiles included with the role. items: - $ref: '../base/Reference.yaml' + $ref: '../base/BaseAccessProfile.yaml' accessProfileCount: type: integer + description: Number of access profiles included with the role. + format: int32 + example: 1 tags: $ref: '../base/Tags.yaml' + segments: + type: array + description: Segments with the role. + items: + $ref: '../base/BaseSegment.yaml' + segmentCount: + type: integer + description: Number of segments with the role. + format: int32 + example: 1 + entitlements: + type: array + description: Entitlements included with the role. + items: + $ref: '../entitlement/BaseEntitlement.yaml' + entitlementCount: + type: integer + description: Number of entitlements included with the role. + format: int32 + example: 3 \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/search/saved/SavedSearch.yaml b/static/api-specs/idn/v3/schemas/search/saved/SavedSearch.yaml index 1489753c7..b061afd6e 100644 --- a/static/api-specs/idn/v3/schemas/search/saved/SavedSearch.yaml +++ b/static/api-specs/idn/v3/schemas/search/saved/SavedSearch.yaml @@ -11,5 +11,14 @@ allOf: description: | The owner of the saved search. $ref: ../model/base/TypedReference.yaml + ownerId: + type: string + description: The ID of the identity that owns this saved search. + example: 2c91808568c529c60168cca6f90c1313 + public: + type: boolean + description: Whether this saved search is visible to anyone but the owner. This field will always be false as there is no way to set a saved search as public at this time. + default: false + example: false - $ref: 'SavedSearchName.yaml' - $ref: 'SavedSearchDetail.yaml' diff --git a/static/api-specs/idn/v3/schemas/search/saved/SavedSearchDetail.yaml b/static/api-specs/idn/v3/schemas/search/saved/SavedSearchDetail.yaml index 291972fa7..581bacc84 100644 --- a/static/api-specs/idn/v3/schemas/search/saved/SavedSearchDetail.yaml +++ b/static/api-specs/idn/v3/schemas/search/saved/SavedSearchDetail.yaml @@ -1,11 +1,5 @@ type: object properties: - public: - description: | - Indicates if the saved search is public. - type: boolean - default: false - example: false created: description: | The date the saved search was initially created. @@ -50,6 +44,18 @@ properties: items: type: string example: [ 'disabled' ] + orderBy: + description: | + Sort by index. This takes precedence over the `sort` property. + type: object + additionalProperties: + type: array + items: + type: string + nullable: true + example: + identity: ["lastName", "firstName"] + role: ["name"] sort: description: | The fields to be used to sort the search results. @@ -57,6 +63,7 @@ properties: items: type: string example: [ 'displayName' ] + nullable: true filters: nullable: true allOf: diff --git a/static/api-specs/idn/v3/schemas/search/scheduled/SearchSchedule.yaml b/static/api-specs/idn/v3/schemas/search/scheduled/SearchSchedule.yaml index ae1116e79..cdcf9a7f3 100644 --- a/static/api-specs/idn/v3/schemas/search/scheduled/SearchSchedule.yaml +++ b/static/api-specs/idn/v3/schemas/search/scheduled/SearchSchedule.yaml @@ -43,7 +43,7 @@ properties: example: false emailEmptyResults: description: | - Indicates if email generation should not be suppressed if search returns no results. + Indicates if email generation should occur when search returns no results. type: boolean default: false example: false diff --git a/static/api-specs/idn/v3/schemas/workflows/Workflow.yaml b/static/api-specs/idn/v3/schemas/workflows/Workflow.yaml new file mode 100644 index 000000000..f52a22a04 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/workflows/Workflow.yaml @@ -0,0 +1,41 @@ +allOf: +- type: object + properties: + id: + type: string + description: Workflow ID. This is a UUID generated upon creation. + example: d201c5e9-d37b-4aff-af14-66414f39d569 + executionCount: + type: integer + format: int32 + description: The number of times this workflow has been executed. + example: 2 + failureCount: + type: integer + format: int32 + description: The number of times this workflow has failed during execution. + example: 0 + created: + type: string + format: date-time + description: The date and time the workflow was created. + example: "2022-01-10T16:06:16.636381447Z" + creator: + type: object + description: Workflow creator's identity. + properties: + type: + type: string + description: Workflow creator's DTO type. + enum: + - IDENTITY + example: IDENTITY + id: + type: string + description: Workflow creator's identity ID. + example: 2c7180a46faadee4016fb4e018c20642 + name: + type: string + description: Workflow creator's display name. + example: Michael Michaels +- $ref: './WorkflowBody.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/workflows/WorkflowBody.yaml b/static/api-specs/idn/v3/schemas/workflows/WorkflowBody.yaml new file mode 100644 index 000000000..81205e635 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/workflows/WorkflowBody.yaml @@ -0,0 +1,36 @@ +type: object +properties: + name: + type: string + description: The name of the workflow + example: "Send Email" + owner: + description: The identity that owns the workflow. The owner's permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request. + properties: + type: + type: string + enum: + - "IDENTITY" + example: "IDENTITY" + description: The type of object that is referenced + id: + type: string + description: The unique ID of the object + example: "2c91808568c529c60168cca6f90c1313" + name: + type: string + description: The name of the object + example: "William Wilson" + description: + type: string + description: Description of what the workflow accomplishes + example: "Send an email to the identity who's attributes changed." + definition: + $ref: './WorkflowDefinition.yaml' + enabled: + type: boolean + description: Enable or disable the workflow. Workflows cannot be created in an enabled state. + default: false + example: false + trigger: + $ref: './WorkflowTrigger.yaml' diff --git a/static/api-specs/idn/v3/schemas/workflows/WorkflowDefinition.yaml b/static/api-specs/idn/v3/schemas/workflows/WorkflowDefinition.yaml new file mode 100644 index 000000000..322bc1e88 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/workflows/WorkflowDefinition.yaml @@ -0,0 +1,28 @@ +type: object +description: The map of steps that the workflow will execute. +properties: + start: + type: string + description: The name of the starting step. + example: "Send Email Test" + steps: + type: object + description: One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type. + additionalProperties: true + example: { + "Send Email": { + "actionId": "sp:send-email", + "attributes": { + "body": "This is a test", + "from": "sailpoint@sailpoint.com", + "recipientId.$": "$.identity.id", + "subject": "test" + }, + "nextStep": "success", + "selectResult": null, + "type": "ACTION" + }, + "success": { + "type": "success" + } + } \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/workflows/WorkflowExecution.yaml b/static/api-specs/idn/v3/schemas/workflows/WorkflowExecution.yaml new file mode 100644 index 000000000..bdcf21787 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/workflows/WorkflowExecution.yaml @@ -0,0 +1,33 @@ +type: object +properties: + id: + type: string + description: The workflow execution ID + example: b393f4e2-4785-4d7f-ab27-3a6b8ded4c81 + workflowId: + type: string + description: The workflow ID + example: d201c5d9-d37b-4a2f-af14-66414f39d568 + requestId: + type: string + description: This backend ID tracks a workflow request in the system. You can provide this ID in a customer support ticket for debugging purposes. + example: 41e12a74fa7b4a6a98ae47887b64acdb + startTime: + type: string + format: date-time + description: The date/time the workflow started + example: "2022-02-07T20:13:29.356648026Z" + closeTime: + type: string + format: date-time + description: The date/time the workflow ended + example: "2022-02-07T20:13:31.682410165Z" + status: + description: The workflow execution status + type: string + enum: + - "Completed" + - "Failed" + - "Canceled" + - "Running" + example: "Completed" diff --git a/static/api-specs/idn/v3/schemas/workflows/WorkflowExecutionEvent.yaml b/static/api-specs/idn/v3/schemas/workflows/WorkflowExecutionEvent.yaml new file mode 100644 index 000000000..371522633 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/workflows/WorkflowExecutionEvent.yaml @@ -0,0 +1,27 @@ +type: object +properties: + type: + description: The type of event + enum: + - WorkflowExecutionScheduled + - WorkflowExecutionStarted + - WorkflowExecutionCompleted + - WorkflowExecutionFailed + - WorkflowTaskScheduled + - WorkflowTaskStarted + - WorkflowTaskCompleted + - WorkflowTaskFailed + - ActivityTaskScheduled + - ActivityTaskStarted + - ActivityTaskCompleted + - ActivityTaskFailed + example: WorkflowTaskScheduled + timestamp: + type: string + format: date-time + description: The date-time when the event occurred + example: "2022-02-07T20:13:31.640618296Z" + attributes: + type: object + description: Additional attributes associated with the event + example: {} diff --git a/static/api-specs/idn/v3/schemas/workflows/WorkflowLibraryAction.yaml b/static/api-specs/idn/v3/schemas/workflows/WorkflowLibraryAction.yaml new file mode 100644 index 000000000..f60c85e8c --- /dev/null +++ b/static/api-specs/idn/v3/schemas/workflows/WorkflowLibraryAction.yaml @@ -0,0 +1,145 @@ +title: Workflow Action +type: object +properties: + id: + type: string + description: Action ID. This is a static namespaced ID for the action + example: "sp:create-campaign" + name: + type: string + description: Action Name + example: "Create Certification Campaign" + type: + type: string + description: Action type + example: "ACTION" + description: + type: string + description: Action Description + example: "Generates a certification campaign." + formFields: + type: array + description: One or more inputs that the action accepts + items: + $ref: './WorkflowLibraryFormFields.yaml' + isDynamicSchema: + type: boolean + description: Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. + example: false + default: false + outputSchema: + type: object + description: Defines the output schema, if any, that this action produces. + example: + { + "definitions": {}, + "properties": { + "autoRevokeAllowed": { + "$id": "#sp:create-campaign/autoRevokeAllowed", + "default": true, + "examples": [ + false + ], + "title": "autoRevokeAllowed", + "type": "boolean" + }, + "deadline": { + "$id": "#sp:create-campaign/deadline", + "default": "", + "examples": [ + "2020-12-25T06:00:00.468Z" + ], + "format": "date-time", + "pattern": "^.*$", + "title": "deadline", + "type": "string" + }, + "description": { + "$id": "#sp:create-campaign/description", + "default": "", + "examples": [ + "A review of everyone's access by their manager." + ], + "pattern": "^.*$", + "title": "description", + "type": "string" + }, + "emailNotificationEnabled": { + "$id": "#sp:create-campaign/emailNotificationEnabled", + "default": true, + "examples": [ + false + ], + "title": "emailNotificationEnabled", + "type": "boolean" + }, + "filter": { + "$id": "#sp:create-campaign/filter", + "properties": { + "id": { + "$id": "#sp:create-campaign/filter/id", + "default": "", + "examples": [ + "e0adaae69852e8fe8b8a3d48e5ce757c" + ], + "pattern": "^.*$", + "title": "id", + "type": "string" + }, + "type": { + "$id": "#sp:create-campaign/filter/type", + "default": "", + "examples": [ + "CAMPAIGN_FILTER" + ], + "pattern": "^.*$", + "title": "type", + "type": "string" + } + }, + "title": "filter", + "type": "object" + }, + "id": { + "$id": "#sp:create-campaign/id", + "default": "", + "examples": [ + "2c918086719eec070171a7e3355a360a" + ], + "pattern": "^.*$", + "title": "id", + "type": "string" + }, + "name": { + "$id": "#sp:create-campaign/name", + "default": "", + "examples": [ + "Manager Review" + ], + "pattern": "^.*$", + "title": "name", + "type": "string" + }, + "recommendationsEnabled": { + "$id": "#sp:create-campaign/recommendationsEnabled", + "default": true, + "examples": [ + false + ], + "title": "recommendationEnabled", + "type": "boolean" + }, + "type": { + "$id": "#sp:create-campaign/type", + "default": "", + "examples": [ + "MANAGER" + ], + "pattern": "^.*$", + "title": "type", + "type": "string" + } + }, + "title": "sp:create-campaign", + "type": "object" + } diff --git a/static/api-specs/idn/v3/schemas/workflows/WorkflowLibraryFormFields.yaml b/static/api-specs/idn/v3/schemas/workflows/WorkflowLibraryFormFields.yaml new file mode 100644 index 000000000..40cee6dfb --- /dev/null +++ b/static/api-specs/idn/v3/schemas/workflows/WorkflowLibraryFormFields.yaml @@ -0,0 +1,46 @@ +type: object +properties: + helpText: + type: string + description: Describes the form field in the UI + example: The name to give to this certification campaign. + label: + type: string + description: A human readable name for this form field in the UI + example: Campaign Name + name: + type: string + description: The name of the input attribute + example: name + required: + type: boolean + description: Denotes if this field is a required attribute + example: false + default: false + type: + description: The type of the form field + nullable: true + enum: + - text + - textarea + - boolean + - email + - url + - number + - json + - checkbox + - jsonpath + - select + - multiType + - duration + - toggle + - identityPicker + - governanceGroupPicker + - string + - object + - array + - secret + - keyValuePairs + - emailPicker + - advancedToggle + example: text diff --git a/static/api-specs/idn/v3/schemas/workflows/WorkflowLibraryOperator.yaml b/static/api-specs/idn/v3/schemas/workflows/WorkflowLibraryOperator.yaml new file mode 100644 index 000000000..b8538b686 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/workflows/WorkflowLibraryOperator.yaml @@ -0,0 +1,64 @@ +title: Workflow Operator +type: object +properties: + id: + type: string + description: Operator ID. + example: "sp:compare-boolean" + name: + type: string + description: Operator friendly name + example: Compare Boolean Values + type: + description: Operator type + type: string + example: "OPERATOR" + description: + type: string + description: Description of the operator + example: Compare two boolean values and decide what happens based on the result. + formFields: + type: array + description: One or more inputs that the operator accepts + items: + $ref: './WorkflowLibraryFormFields.yaml' + example: + [ + { + "description": "Enter the JSONPath to a value from the input to compare to Variable B.", + "helpText": "", + "label": "Variable A", + "name": "variableA.$", + "required": true, + "type": "text" + }, + { + "helpText": "Select an operation.", + "label": "Operation", + "name": "operator", + "options": [ + { + "label": "Equals", + "value": "BooleanEquals" + } + ], + "required": true, + "type": "select" + }, + { + "description": "Enter the JSONPath to a value from the input to compare to Variable A.", + "helpText": "", + "label": "Variable B", + "name": "variableB.$", + "required": false, + "type": "text" + }, + { + "description": "Enter True or False.", + "helpText": "", + "label": "Variable B", + "name": "variableB", + "required": false, + "type": "text" + } + ] \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/workflows/WorkflowLibraryTrigger.yaml b/static/api-specs/idn/v3/schemas/workflows/WorkflowLibraryTrigger.yaml new file mode 100644 index 000000000..2efb28b12 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/workflows/WorkflowLibraryTrigger.yaml @@ -0,0 +1,74 @@ +title: Workflow Trigger +type: object +properties: + id: + type: string + description: Trigger ID. This is a static namespaced ID for the trigger. + example: "idn:identity-attributes-changed" + type: + description: Trigger type + enum: + - EVENT + - SCHEDULED + - EXTERNAL + example: EVENT + name: + type: string + description: Trigger Name + example: Identity Attributes Changed + description: + type: string + description: Trigger Description + example: One or more identity attributes changed. + isDynamicSchema: + type: boolean + description: Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. + example: false + default: false + inputExample: + type: object + description: Example trigger payload if applicable + nullable: true + externalDocs: + description: List of triggers and their input schemas + url: https://developer.sailpoint.com/idn/docs/event-triggers/available + example: + { + "changes": [ + { + "attribute": "department", + "newValue": "marketing", + "oldValue": "sales" + }, + { + "attribute": "manager", + "newValue": { + "id": "ee769173319b41d19ccec6c235423236c", + "name": "mean.guy", + "type": "IDENTITY" + }, + "oldValue": { + "id": "ee769173319b41d19ccec6c235423237b", + "name": "nice.guy", + "type": "IDENTITY" + } + }, + { + "attribute": "email", + "newValue": "john.doe@gmail.com", + "oldValue": "john.doe@hotmail.com" + } + ], + "identity": { + "id": "ee769173319b41d19ccec6cea52f237b", + "name": "john.doe", + "type": "IDENTITY" + } + } + formFields: + type: array + nullable: true + description: One or more inputs that the trigger accepts + example: [] + items: + $ref: './WorkflowLibraryFormFields.yaml' diff --git a/static/api-specs/idn/v3/schemas/workflows/WorkflowOAuthClient.yaml b/static/api-specs/idn/v3/schemas/workflows/WorkflowOAuthClient.yaml new file mode 100644 index 000000000..b440a2dd9 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/workflows/WorkflowOAuthClient.yaml @@ -0,0 +1,14 @@ +type: object +properties: + id: + type: string + description: OAuth client ID for the trigger. This is a UUID generated upon creation. + example: 1a58c03a6bf64dc2876f6988c6e2c7b7 + secret: + type: string + description: OAuthClient secret. + example: 00cc24a7fe810fe06a7cb38bc168ae104d703c7abb296f9944dc68e69ddb578b + url: + type: string + description: URL for the external trigger to invoke + example: https://tenant.api.identitynow.com/beta/workflows/execute/external/c17bea3a-574d-453c-9e04-4365fbf5af0b diff --git a/static/api-specs/idn/v3/schemas/workflows/WorkflowTrigger.yaml b/static/api-specs/idn/v3/schemas/workflows/WorkflowTrigger.yaml new file mode 100644 index 000000000..b0aac6309 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/workflows/WorkflowTrigger.yaml @@ -0,0 +1,20 @@ +type: object +description: The trigger that starts the workflow +required: + - type + - attributes +properties: + type: + type: string + enum: + - EVENT + - EXTERNAL + - SCHEDULED + example: EVENT + description: The trigger type + attributes: + oneOf: + - $ref: './trigger-attributes/EventAttributes.yaml' + - $ref: './trigger-attributes/ExternalAttributes.yaml' + - $ref: './trigger-attributes/ScheduledAttributes.yaml' + description: Workflow Trigger Attributes. diff --git a/static/api-specs/idn/v3/schemas/workflows/trigger-attributes/EventAttributes.yaml b/static/api-specs/idn/v3/schemas/workflows/trigger-attributes/EventAttributes.yaml new file mode 100644 index 000000000..70c663712 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/workflows/trigger-attributes/EventAttributes.yaml @@ -0,0 +1,14 @@ +title: Event Trigger Attributes +type: object +description: Attributes related to an IdentityNow ETS event +required: +- id +properties: + id: + type: string + description: The unique ID of the trigger + example: "idn:identity-attributes-changed" + filter.$: + type: string + description: JSON path expression that will limit which events the trigger will fire on + example: "$.changes[?(@.attribute == 'manager')]" diff --git a/static/api-specs/idn/v3/schemas/workflows/trigger-attributes/ExternalAttributes.yaml b/static/api-specs/idn/v3/schemas/workflows/trigger-attributes/ExternalAttributes.yaml new file mode 100644 index 000000000..c66be6c7e --- /dev/null +++ b/static/api-specs/idn/v3/schemas/workflows/trigger-attributes/ExternalAttributes.yaml @@ -0,0 +1,14 @@ +title: External Trigger Attributes +type: object +description: Attributes related to an external trigger +required: +- name +properties: + name: + type: string + description: A unique name for the external trigger + example: "search-and-notify" + description: + type: string + description: Additonal context about the external trigger + example: Run a search and notify the results \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/workflows/trigger-attributes/ScheduledAttributes.yaml b/static/api-specs/idn/v3/schemas/workflows/trigger-attributes/ScheduledAttributes.yaml new file mode 100644 index 000000000..990de7f4f --- /dev/null +++ b/static/api-specs/idn/v3/schemas/workflows/trigger-attributes/ScheduledAttributes.yaml @@ -0,0 +1,13 @@ +title: Scheduled Trigger Attributes +type: object +description: Attributes related to a scheduled trigger +required: +- cronString +properties: + cronString: + type: string + description: A valid CRON expression + externalDocs: + description: CRON expression editor + url: https://crontab.guru/ + example: "0 * */3 */5 *" \ No newline at end of file diff --git a/static/api-specs/nerm/openapi.yaml b/static/api-specs/nerm/openapi.yaml index 02cdecff1..2e5b97342 100644 --- a/static/api-specs/nerm/openapi.yaml +++ b/static/api-specs/nerm/openapi.yaml @@ -72,6 +72,13 @@ paths: $ref: "./paths/profile_types.yaml" /profile_types/{id}: $ref: "./paths/profile_types_id.yaml" +# Synced attributes + /profile_types/{profile_type_id}/ne_attributes: + $ref: "./paths/profile_type_attributes.yaml" + /profile_types/{profile_type_id}/synced_attributes: + $ref: "./paths/synced_attributes.yaml" + /profile_types/{profile_type_id}/synced_attributes/{ne_attribute_id}: + $ref: "./paths/synced_attributes_id.yaml" # Profile Type Roles /profile_type_roles: $ref: "./paths/profile_type_roles.yaml" diff --git a/static/api-specs/nerm/parameters/path/attribute_id.yaml b/static/api-specs/nerm/parameters/path/attribute_id.yaml index bd5d28e89..1d1e72ed6 100644 --- a/static/api-specs/nerm/parameters/path/attribute_id.yaml +++ b/static/api-specs/nerm/parameters/path/attribute_id.yaml @@ -4,4 +4,5 @@ description: The id of the attachment attribute required: true schema: type: string - format: uuid \ No newline at end of file + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/path/ne_attribute_id.yaml b/static/api-specs/nerm/parameters/path/ne_attribute_id.yaml new file mode 100644 index 000000000..dc86258d4 --- /dev/null +++ b/static/api-specs/nerm/parameters/path/ne_attribute_id.yaml @@ -0,0 +1,8 @@ +name: ne_attribute_id +in: path +description: Ne attribute ID of the object +required: true +schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/path/profile_type_id.yaml b/static/api-specs/nerm/parameters/path/profile_type_id.yaml new file mode 100644 index 000000000..96345f738 --- /dev/null +++ b/static/api-specs/nerm/parameters/path/profile_type_id.yaml @@ -0,0 +1,8 @@ +name: profile_type_id +in: path +description: Profile type ID of the object +required: true +schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/page.yaml b/static/api-specs/nerm/parameters/query/page.yaml new file mode 100644 index 000000000..108d43219 --- /dev/null +++ b/static/api-specs/nerm/parameters/query/page.yaml @@ -0,0 +1,9 @@ +name: page +in: query +description: Pagination page number +required: false +schema: + type: integer + format: int32 + minimum: 1 + example: 5 \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/per_page.yaml b/static/api-specs/nerm/parameters/query/per_page.yaml new file mode 100644 index 000000000..195609ed5 --- /dev/null +++ b/static/api-specs/nerm/parameters/query/per_page.yaml @@ -0,0 +1,9 @@ +name: page +in: query +description: Pagination items per page +required: false +schema: + type: integer + format: int32 + minimum: 1 + example: 5 \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/search.yaml b/static/api-specs/nerm/parameters/query/search.yaml new file mode 100644 index 000000000..029390913 --- /dev/null +++ b/static/api-specs/nerm/parameters/query/search.yaml @@ -0,0 +1,7 @@ +name: search +in: query +description: Filter by string +required: false +schema: + type: string + example: search \ No newline at end of file diff --git a/static/api-specs/nerm/parameters/query/sort.yaml b/static/api-specs/nerm/parameters/query/sort.yaml new file mode 100644 index 000000000..97750af88 --- /dev/null +++ b/static/api-specs/nerm/parameters/query/sort.yaml @@ -0,0 +1,15 @@ +name: sort +in: query +description: How records should be sorted +required: false +schema: + type: object + example: { attr: "sync", order: "asc" } + properties: + attr: + type: string + example: sync + order: + type: string + enum: [asc, desc] + example: asc diff --git a/static/api-specs/nerm/parameters/query/synced_attribute_active_filter.yaml b/static/api-specs/nerm/parameters/query/synced_attribute_active_filter.yaml new file mode 100644 index 000000000..bd6bd1b84 --- /dev/null +++ b/static/api-specs/nerm/parameters/query/synced_attribute_active_filter.yaml @@ -0,0 +1,8 @@ +name: active_filter +in: query +description: Filter for profile type synced attributes +required: false +schema: + type: string + enum: [synced, unsynced, all] + example: all \ No newline at end of file diff --git a/static/api-specs/nerm/paths/profile_type_attributes.yaml b/static/api-specs/nerm/paths/profile_type_attributes.yaml new file mode 100644 index 000000000..20d115393 --- /dev/null +++ b/static/api-specs/nerm/paths/profile_type_attributes.yaml @@ -0,0 +1,20 @@ +get: + summary: profile_types/ne_attributes synced status + operationId: getProfileTypeAttributes + description: Get ne attributes and synced attribute relationship to profile type. + tags: + - synced attributes + parameters: + - $ref: "../parameters/path/profile_type_id.yaml" + - $ref: "../parameters/query/synced_attribute_active_filter.yaml" + - $ref: "../parameters/query/search.yaml" + - $ref: "../parameters/query/page.yaml" + - $ref: "../parameters/query/per_page.yaml" + - $ref: "../parameters/query/sort.yaml" + responses: + '200': + $ref: "../responses/ProfileTypeAttributes_Meta.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" diff --git a/static/api-specs/nerm/paths/synced_attributes.yaml b/static/api-specs/nerm/paths/synced_attributes.yaml new file mode 100644 index 000000000..df7269278 --- /dev/null +++ b/static/api-specs/nerm/paths/synced_attributes.yaml @@ -0,0 +1,15 @@ +post: + summary: Create a synced attribute + operationId: createSyncedAttribute + description: Create synced attribute + tags: + - synced attributes + requestBody: + $ref: "../requestBodies/POST/SyncedAttributes.yaml" + responses: + '201': + $ref: "../responses/SyncedAttribute.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/paths/synced_attributes_id.yaml b/static/api-specs/nerm/paths/synced_attributes_id.yaml new file mode 100644 index 000000000..4050f278c --- /dev/null +++ b/static/api-specs/nerm/paths/synced_attributes_id.yaml @@ -0,0 +1,16 @@ +delete: + summary: Delete synced attribute + operationId: deleteSyncedAttribute + description: Delete a synced attribute. + tags: + - synced attributes + parameters: + - $ref: "../parameters/path/profile_type_id.yaml" + - $ref: "../parameters/path/ne_attribute_id.yaml" + responses: + '200': + $ref: "../responses/Info.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/requestBodies/POST/SyncedAttributes.yaml b/static/api-specs/nerm/requestBodies/POST/SyncedAttributes.yaml new file mode 100644 index 000000000..c73573406 --- /dev/null +++ b/static/api-specs/nerm/requestBodies/POST/SyncedAttributes.yaml @@ -0,0 +1,6 @@ +required: true +content: + application/json: + schema: + type: object + $ref: "../../schemas/POST/SyncedAttribute.yaml" \ No newline at end of file diff --git a/static/api-specs/nerm/responses/ProfileTypeAttributes_Meta.yaml b/static/api-specs/nerm/responses/ProfileTypeAttributes_Meta.yaml new file mode 100644 index 000000000..999ecd3e7 --- /dev/null +++ b/static/api-specs/nerm/responses/ProfileTypeAttributes_Meta.yaml @@ -0,0 +1,9 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + form: + type: object + $ref: '../schemas/GET/ProfileTypeAttributes.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/responses/SyncedAttribute.yaml b/static/api-specs/nerm/responses/SyncedAttribute.yaml new file mode 100644 index 000000000..12f1b5411 --- /dev/null +++ b/static/api-specs/nerm/responses/SyncedAttribute.yaml @@ -0,0 +1,9 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + synced_attribute: + type: object + $ref: '../schemas/GET/SyncedAttribute.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/ProfileType.yaml b/static/api-specs/nerm/schemas/GET/ProfileType.yaml index 1aaf4fa83..a341f8009 100644 --- a/static/api-specs/nerm/schemas/GET/ProfileType.yaml +++ b/static/api-specs/nerm/schemas/GET/ProfileType.yaml @@ -37,6 +37,10 @@ properties: format: uuid description: The role ids that are permitted for this profile type. example: ['33f072dd-13b4-41e1-8ea0-16f2a59b57c8'] + isc_synced: + type: boolean + description: Is this profile type synced with ics + example: false profile_type_dup_attributes: type: array items: diff --git a/static/api-specs/nerm/schemas/GET/ProfileTypeAttribute.yaml b/static/api-specs/nerm/schemas/GET/ProfileTypeAttribute.yaml new file mode 100644 index 000000000..6a2719e64 --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/ProfileTypeAttribute.yaml @@ -0,0 +1,26 @@ +type: object +properties: + id: + description: ID of ne attribute + type: string + format: uuid + readOnly: true + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + uid: + description: Ne attribute's uid + type: string + minLength: 32 + maxLength: 32 + readOnly: true + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + label: + description: Ne attribute's label + type: string + required: true + readOnly: true + example: object + synced: + description: synced_attribute ID if there is one + type: uuid + required: false + example: 1246d8b3-ac29-4015-8154-dea4434a73fa \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/ProfileTypeAttributes.yaml b/static/api-specs/nerm/schemas/GET/ProfileTypeAttributes.yaml new file mode 100644 index 000000000..876a76276 --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/ProfileTypeAttributes.yaml @@ -0,0 +1,11 @@ +type: object +properties: + count: + type: integer + format: int32 + description: How many ne attribute records exist + example: 5 + records: + type: array + items: + $ref: './ProfileTypeAttribute.yaml' \ No newline at end of file diff --git a/static/api-specs/nerm/schemas/GET/SyncedAttribute.yaml b/static/api-specs/nerm/schemas/GET/SyncedAttribute.yaml new file mode 100644 index 000000000..27943261a --- /dev/null +++ b/static/api-specs/nerm/schemas/GET/SyncedAttribute.yaml @@ -0,0 +1,20 @@ +type: object +properties: + id: + type: string + format: uuid + readOnly: true + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + description: synced attribute's ID + profile_type_id: + type: string + format: uuid + readOnly: true + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + description: Profile type ID of synced attribute + ne_attribute_id: + type: string + format: uuid + readOnly: true + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + description: Ne attribute ID of synced attribute diff --git a/static/api-specs/nerm/schemas/PATCH/ProfileType.yaml b/static/api-specs/nerm/schemas/PATCH/ProfileType.yaml index 8be0ccf9e..b44c3e714 100644 --- a/static/api-specs/nerm/schemas/PATCH/ProfileType.yaml +++ b/static/api-specs/nerm/schemas/PATCH/ProfileType.yaml @@ -24,6 +24,11 @@ properties: format: uuid description: The role ids that are permitted for this profile type. example: ['33f072dd-13b4-41e1-8ea0-16f2a59b57c8'] + isc_synced: + type: boolean + default: false + description: Is this profile type synced with ics + example: false profile_type_dup_attributes: type: array items: diff --git a/static/api-specs/nerm/schemas/POST/ProfileType.yaml b/static/api-specs/nerm/schemas/POST/ProfileType.yaml index 30b15d426..0923f54df 100644 --- a/static/api-specs/nerm/schemas/POST/ProfileType.yaml +++ b/static/api-specs/nerm/schemas/POST/ProfileType.yaml @@ -26,6 +26,11 @@ properties: format: uuid description: The role ids that are permitted for this profile type. example: ['33f072dd-13b4-41e1-8ea0-16f2a59b57c8'] + isc_synced: + type: boolean + default: false + description: Is this profile type synced with ics + example: false profile_type_dup_attributes: type: array items: diff --git a/static/api-specs/nerm/schemas/POST/SyncedAttribute.yaml b/static/api-specs/nerm/schemas/POST/SyncedAttribute.yaml new file mode 100644 index 000000000..7cf86185f --- /dev/null +++ b/static/api-specs/nerm/schemas/POST/SyncedAttribute.yaml @@ -0,0 +1,7 @@ +type: object +properties: + ne_attribute_id: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + description: synced attribute's ID \ No newline at end of file diff --git a/static/icons/ExpertAmbassador.svg b/static/icons/ExpertAmbassador.svg index 9fb80c4d1..100f5fe6a 100644 --- a/static/icons/ExpertAmbassador.svg +++ b/static/icons/ExpertAmbassador.svg @@ -1,63 +1,4 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + \ No newline at end of file diff --git a/template.yaml b/template.yaml index 2e338a463..8d317edde 100644 --- a/template.yaml +++ b/template.yaml @@ -18,6 +18,29 @@ Resources: # https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction # This is an API gateway associated with the developerSailpointGetByIdFunction and developerSailpointPutItemFunctions + + MessageApiAuthRole: + Type: AWS::IAM::Role + Properties: + AssumeRolePolicyDocument: + Version: "2012-10-17" + Statement: + - Effect: "Allow" + Principal: + Service: + - "apigateway.amazonaws.com" + Action: + - sts:AssumeRole + Policies: + - PolicyName: "InvokeMessageAuthFunction" + PolicyDocument: + Version: "2012-10-17" + Statement: + - Effect: "Allow" + Action: + - lambda:InvokeAsync + - lambda:InvokeFunction + Resource: !GetAtt DeveloperSailpointAuthFunction.Arn DeveloperSailpointApiGatewayApiv2: Type: AWS::Serverless::HttpApi Properties: @@ -31,12 +54,40 @@ Resources: - "Content-Type" AllowOrigins: - "https://developer.sailpoint.com" + DefaultRouteSettings: + DetailedMetricsEnabled: true + Auth: + DefaultAuthorizer: LambdaAuthorizer + Authorizers: + LambdaAuthorizer: + FunctionPayloadType: REQUEST + FunctionArn: !GetAtt DeveloperSailpointAuthFunction.Arn + FunctionInvokeRole: !GetAtt MessageApiAuthRole.Arn + Identity: + Headers: + - Authorization + AuthorizerPayloadFormatVersion: 2.0 + EnableSimpleResponses: false + DeveloperSailpointAuthFunction: + Type: AWS::Serverless::Function + Properties: + Environment: + Variables: + AUTH_USERNAME: !Ref AuthUsername + AUTH_PASSWORD: !Ref AuthPassword + CodeUri: backend/src/auth/ + Handler: index.authHandler + Runtime: nodejs18.x + Architectures: + - x86_64 + MemorySize: 128 + Timeout: 100 # This is a Lambda function config associated with the source code: get-by-id.js developerSailpointGetByIdFunction: Type: AWS::Serverless::Function Properties: - CodeUri: backend/ - Handler: src/handlers/get-by-id.getByIdHandler + CodeUri: backend/src/handlers/ + Handler: get-by-id.getByIdHandler Runtime: nodejs18.x Architectures: - x86_64 @@ -61,6 +112,8 @@ Resources: Method: GET ApiId: Ref: DeveloperSailpointApiGatewayApiv2 + Auth: + Authorizer: NONE # Each Lambda function is defined by properties: # https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction # DynamoDB table to store item: {id: <ID>, name: <NAME>} @@ -152,6 +205,13 @@ Resources: OriginAccessControlOriginType: "s3" SigningBehavior: "always" SigningProtocol: "sigv4" +Parameters: + AuthUsername: + Type: String + Description: Username for basic auth + AuthPassword: + Type: String + Description: Password for basic auth Outputs: DeveloperSailpointAPIGatewayEndpoint: Description: "API Gateway endpoint URL for Prod stage"