mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 20:37:47 +00:00
Tyler Mairose
1
.gitignore
vendored
1
.gitignore
vendored
@@ -33,6 +33,7 @@ yarn.lock
|
||||
/docs/api/beta
|
||||
/docs/api/iiq
|
||||
/docs/api/nerm/*
|
||||
/docs/api/v2024/*
|
||||
!/docs/api/nerm/authentication.md
|
||||
!/docs/api/nerm/pagination-metadata-filtering.md
|
||||
!/docs/api/nerm/getting-started.md
|
||||
|
||||
116
createApiPageMD.ts
Normal file
116
createApiPageMD.ts
Normal file
@@ -0,0 +1,116 @@
|
||||
import { createAuthentication } from "docusaurus-plugin-openapi-docs/src/markdown/createAuthentication";
|
||||
import { createAuthorization } from "docusaurus-plugin-openapi-docs/src/markdown/createAuthorization";
|
||||
import { createCallbacks } from "docusaurus-plugin-openapi-docs/src/markdown/createCallbacks";
|
||||
import { createContactInfo } from "docusaurus-plugin-openapi-docs/src/markdown/createContactInfo";
|
||||
import { createDeprecationNotice } from "docusaurus-plugin-openapi-docs/src/markdown/createDeprecationNotice";
|
||||
import { createDescription } from "docusaurus-plugin-openapi-docs/src/markdown/createDescription";
|
||||
import { createDownload } from "docusaurus-plugin-openapi-docs/src/markdown/createDownload";
|
||||
import { createHeading } from "docusaurus-plugin-openapi-docs/src/markdown/createHeading";
|
||||
import { createLicense } from "docusaurus-plugin-openapi-docs/src/markdown/createLicense";
|
||||
import { createLogo } from "docusaurus-plugin-openapi-docs/src/markdown/createLogo";
|
||||
import { createMethodEndpoint } from "docusaurus-plugin-openapi-docs/src/markdown/createMethodEndpoint";
|
||||
import { createParamsDetails } from "docusaurus-plugin-openapi-docs/src/markdown/createParamsDetails";
|
||||
import { createRequestBodyDetails } from "docusaurus-plugin-openapi-docs/src/markdown/createRequestBodyDetails";
|
||||
import { createRequestHeader } from "docusaurus-plugin-openapi-docs/src/markdown/createRequestHeader";
|
||||
import { createNodes } from "docusaurus-plugin-openapi-docs/src/markdown/createSchema";
|
||||
import { createStatusCodes } from "docusaurus-plugin-openapi-docs/src/markdown/createStatusCodes";
|
||||
import { createTermsOfService } from "docusaurus-plugin-openapi-docs/src/markdown/createTermsOfService";
|
||||
import { createVendorExtensions } from "docusaurus-plugin-openapi-docs/src/markdown/createVendorExtensions";
|
||||
import { createVersionBadge } from "docusaurus-plugin-openapi-docs/src/markdown/createVersionBadge";
|
||||
import { create, greaterThan, lessThan, render } from "docusaurus-plugin-openapi-docs/src/markdown/utils";
|
||||
import {
|
||||
ContactObject,
|
||||
LicenseObject,
|
||||
MediaTypeObject,
|
||||
SecuritySchemeObject,
|
||||
} from "docusaurus-plugin-openapi-docs/src/openapi/types";
|
||||
import {
|
||||
ApiPageMetadata,
|
||||
InfoPageMetadata,
|
||||
SchemaPageMetadata,
|
||||
TagPageMetadata,
|
||||
} from "docusaurus-plugin-openapi-docs/src/types";
|
||||
|
||||
interface RequestBodyProps {
|
||||
title: string;
|
||||
body: {
|
||||
content?: {
|
||||
[key: string]: MediaTypeObject;
|
||||
};
|
||||
description?: string;
|
||||
required?: boolean;
|
||||
};
|
||||
}
|
||||
|
||||
export function createApiPageMD({
|
||||
title,
|
||||
api: {
|
||||
deprecated,
|
||||
"x-deprecated-description": deprecatedDescription,
|
||||
description,
|
||||
method,
|
||||
path,
|
||||
extensions,
|
||||
parameters,
|
||||
requestBody,
|
||||
responses,
|
||||
callbacks,
|
||||
},
|
||||
infoPath,
|
||||
frontMatter,
|
||||
}: ApiPageMetadata) {
|
||||
return render([
|
||||
`import ApiTabs from "@theme/ApiTabs";\n`,
|
||||
`import DiscriminatorTabs from "@theme/DiscriminatorTabs";\n`,
|
||||
`import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";\n`,
|
||||
`import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";\n`,
|
||||
`import MimeTabs from "@theme/MimeTabs";\n`,
|
||||
`import ParamsItem from "@theme/ParamsItem";\n`,
|
||||
`import ResponseSamples from "@theme/ResponseSamples";\n`,
|
||||
`import SchemaItem from "@theme/SchemaItem";\n`,
|
||||
`import SchemaTabs from "@theme/SchemaTabs";\n`,
|
||||
`import Markdown from "@theme/Markdown";\n`,
|
||||
`import Heading from "@theme/Heading";\n`,
|
||||
`import OperationTabs from "@theme/OperationTabs";\n`,
|
||||
`import TabItem from "@theme/TabItem";\n\n`,
|
||||
createHeading(title),
|
||||
createMethodEndpoint(method, path),
|
||||
infoPath && createAuthorization(infoPath),
|
||||
frontMatter.show_extensions
|
||||
? createVendorExtensions(extensions)
|
||||
: undefined,
|
||||
createDeprecation({ deprecated, description: deprecatedDescription }),
|
||||
createExperimentalNotice(parameters),
|
||||
createDescription(description),
|
||||
requestBody || parameters ? createRequestHeader("Request") : undefined,
|
||||
createParamsDetails({ parameters, type: "path" }),
|
||||
createParamsDetails({ parameters, type: "query" }),
|
||||
createParamsDetails({ parameters, type: "header" }),
|
||||
createParamsDetails({ parameters, type: "cookie" }),
|
||||
createRequestBodyDetails({
|
||||
title: "Body",
|
||||
body: requestBody,
|
||||
} as RequestBodyProps),
|
||||
createStatusCodes({ responses }),
|
||||
createCallbacks({ callbacks }),
|
||||
]);
|
||||
}
|
||||
|
||||
|
||||
function createDeprecation({ deprecated, description }: { deprecated?: boolean; description?: string }) {
|
||||
if (deprecated == true) {
|
||||
if (description !== undefined) {
|
||||
return `:::caution deprecated\n\n${description}\n\n:::`;
|
||||
} else {
|
||||
return `:::caution deprecated\n\nThis endpoint has been deprecated and may be replaced or removed in future versions of the API.\n\n:::`;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function createExperimentalNotice(parameters){
|
||||
if (parameters && parameters.some(element => element.in === 'header' && element.name === 'X-SailPoint-Experimental')) {
|
||||
return ":::warning experimental\n\nThis API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.\n\n:::\n\n";
|
||||
}
|
||||
// Return an empty string if the condition is not met
|
||||
return "";
|
||||
}
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
<!-- ---
|
||||
id: api-specifications
|
||||
title: API Specifications
|
||||
pagination_label: API Specifications
|
||||
@@ -28,4 +28,4 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
|
||||
|
||||
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).
|
||||
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). -->
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
<!-- ---
|
||||
id: identity-security-cloud
|
||||
title: Identity Security Cloud API Specifications
|
||||
pagination_label: Identity Security Cloud API Specifications
|
||||
@@ -26,4 +26,4 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
|
||||
|
||||
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).
|
||||
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). -->
|
||||
|
||||
11
navbar.js
11
navbar.js
@@ -15,7 +15,16 @@ module.exports = {
|
||||
{label: 'IdentityIQ', to: '/docs/iiq'},
|
||||
],
|
||||
},
|
||||
|
||||
{
|
||||
type: 'dropdown',
|
||||
label: 'API Specifications',
|
||||
position: 'left',
|
||||
items: [
|
||||
{label: 'Identity Security Cloud', to: '/docs/api/v2024'},
|
||||
{label: 'IdentityIQ', to: '/docs/api/iiq'},
|
||||
{label: 'NERM', to: '/docs/api/nerm/v1'},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'dropdown',
|
||||
label: 'Community',
|
||||
|
||||
53
package-lock.json
generated
53
package-lock.json
generated
@@ -21,7 +21,7 @@
|
||||
"autoprefixer": "^10.4.13",
|
||||
"classnames": "^2.3.2",
|
||||
"clsx": "^2.0.0",
|
||||
"docusaurus-plugin-openapi-docs": "^3.0.1",
|
||||
"docusaurus-plugin-openapi-docs": "^0.0.0-761",
|
||||
"docusaurus-theme-openapi-docs": "^3.0.1",
|
||||
"docusaurus2-dotenv": "^1.4.0",
|
||||
"esbuild-loader": "^2.20.0",
|
||||
@@ -7500,9 +7500,9 @@
|
||||
}
|
||||
},
|
||||
"node_modules/docusaurus-plugin-openapi-docs": {
|
||||
"version": "3.0.1",
|
||||
"resolved": "https://registry.npmjs.org/docusaurus-plugin-openapi-docs/-/docusaurus-plugin-openapi-docs-3.0.1.tgz",
|
||||
"integrity": "sha512-6SRqwey/TXMNu2G02mbWgxrifhpjGOjDr30N+58AR0Ytgc+HXMqlPAUIvTe+e7sOBfAtBbiNlmOWv5KSYIjf3w==",
|
||||
"version": "0.0.0-761",
|
||||
"resolved": "https://registry.npmjs.org/docusaurus-plugin-openapi-docs/-/docusaurus-plugin-openapi-docs-0.0.0-761.tgz",
|
||||
"integrity": "sha512-MstupMKsGzhcBvL+kuEzp/rYDVb65JPF/vi/Ydp4pzKFbMiyGJmgsD99pCn4CZAkszlplD6EckD5kXuy877wWg==",
|
||||
"dependencies": {
|
||||
"@apidevtools/json-schema-ref-parser": "^11.5.4",
|
||||
"@docusaurus/plugin-content-docs": "^3.0.1",
|
||||
@@ -7692,6 +7692,51 @@
|
||||
"node": ">=6"
|
||||
}
|
||||
},
|
||||
"node_modules/docusaurus-theme-openapi-docs/node_modules/docusaurus-plugin-openapi-docs": {
|
||||
"version": "3.0.1",
|
||||
"resolved": "https://registry.npmjs.org/docusaurus-plugin-openapi-docs/-/docusaurus-plugin-openapi-docs-3.0.1.tgz",
|
||||
"integrity": "sha512-6SRqwey/TXMNu2G02mbWgxrifhpjGOjDr30N+58AR0Ytgc+HXMqlPAUIvTe+e7sOBfAtBbiNlmOWv5KSYIjf3w==",
|
||||
"dependencies": {
|
||||
"@apidevtools/json-schema-ref-parser": "^11.5.4",
|
||||
"@docusaurus/plugin-content-docs": "^3.0.1",
|
||||
"@docusaurus/utils": "^3.0.1",
|
||||
"@docusaurus/utils-validation": "^3.0.1",
|
||||
"@redocly/openapi-core": "^1.10.5",
|
||||
"chalk": "^4.1.2",
|
||||
"clsx": "^1.1.1",
|
||||
"fs-extra": "^9.0.1",
|
||||
"json-pointer": "^0.6.2",
|
||||
"json-schema-merge-allof": "^0.8.1",
|
||||
"json5": "^2.2.3",
|
||||
"lodash": "^4.17.20",
|
||||
"mustache": "^4.2.0",
|
||||
"openapi-to-postmanv2": "^4.21.0",
|
||||
"postman-collection": "^4.4.0",
|
||||
"slugify": "^1.6.5",
|
||||
"swagger2openapi": "^7.0.8",
|
||||
"xml-formatter": "^2.6.1"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=14"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"react": "^16.8.4 || ^17.0.0 || ^18.0.0"
|
||||
}
|
||||
},
|
||||
"node_modules/docusaurus-theme-openapi-docs/node_modules/fs-extra": {
|
||||
"version": "9.1.0",
|
||||
"resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-9.1.0.tgz",
|
||||
"integrity": "sha512-hcg3ZmepS30/7BSFqRvoo3DOMQu7IjqxO5nCDt+zM9XWjb33Wg7ziNT+Qvqbuc3+gWpzO02JubVyk2G4Zvo1OQ==",
|
||||
"dependencies": {
|
||||
"at-least-node": "^1.0.0",
|
||||
"graceful-fs": "^4.2.0",
|
||||
"jsonfile": "^6.0.1",
|
||||
"universalify": "^2.0.0"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=10"
|
||||
}
|
||||
},
|
||||
"node_modules/docusaurus2-dotenv": {
|
||||
"version": "1.4.0",
|
||||
"resolved": "https://registry.npmjs.org/docusaurus2-dotenv/-/docusaurus2-dotenv-1.4.0.tgz",
|
||||
|
||||
@@ -16,8 +16,8 @@
|
||||
"clean-api-docs": "docusaurus clean-api-docs",
|
||||
"gen-api-docs:version": "docusaurus gen-api-docs:version",
|
||||
"clean-api-docs:version": "docusaurus clean-api-docs:version",
|
||||
"gen-api-docs-all": "docusaurus gen-api-docs idn_v3 --plugin-id idn-api && docusaurus gen-api-docs idn_beta --plugin-id idn-api && docusaurus gen-api-docs iiq --plugin-id iiq-api && docusaurus gen-api-docs nerm --plugin-id nerm-api",
|
||||
"clean-api-docs-all": "docusaurus clean-api-docs idn_v3 --plugin-id idn-api && docusaurus clean-api-docs idn_beta --plugin-id idn-api && docusaurus clean-api-docs iiq --plugin-id iiq-api && docusaurus clean-api-docs nerm --plugin-id nerm-api",
|
||||
"gen-api-docs-all": "docusaurus gen-api-docs:version isc_versioned:all --plugin-id isc-api && docusaurus gen-api-docs isc_versioned --plugin-id isc-api && docusaurus gen-api-docs iiq --plugin-id iiq-api && docusaurus gen-api-docs nerm --plugin-id nerm-api",
|
||||
"clean-api-docs-all": "docusaurus clean-api-docs isc_versioned --plugin-id isc-api && docusaurus clean-api-docs:version isc_versioned:all --plugin-id isc-api && docusaurus clean-api-docs iiq --plugin-id iiq-api && docusaurus clean-api-docs nerm --plugin-id nerm-api",
|
||||
"rebuild-docs": "npm run clean-api-docs-all && npm run gen-api-docs-all"
|
||||
},
|
||||
"dependencies": {
|
||||
@@ -34,7 +34,7 @@
|
||||
"autoprefixer": "^10.4.13",
|
||||
"classnames": "^2.3.2",
|
||||
"clsx": "^2.0.0",
|
||||
"docusaurus-plugin-openapi-docs": "^3.0.1",
|
||||
"docusaurus-plugin-openapi-docs": "^0.0.0-761",
|
||||
"docusaurus-theme-openapi-docs": "^3.0.1",
|
||||
"docusaurus2-dotenv": "^1.4.0",
|
||||
"esbuild-loader": "^2.20.0",
|
||||
|
||||
52
plugins.js
52
plugins.js
@@ -1,3 +1,5 @@
|
||||
const {createApiPageMD} = require('./createApiPageMD');
|
||||
|
||||
module.exports = [
|
||||
[
|
||||
'docusaurus2-dotenv',
|
||||
@@ -1619,6 +1621,52 @@ module.exports = [
|
||||
},
|
||||
},
|
||||
],
|
||||
[
|
||||
'docusaurus-plugin-openapi-docs',
|
||||
{
|
||||
id: 'isc-api',
|
||||
docsPluginId: 'isc',
|
||||
config: {
|
||||
isc_versioned: {
|
||||
specPath: 'static/api-specs/idn/sailpoint-api.v2024.yaml',
|
||||
outputDir: 'docs/api/v2024',
|
||||
sidebarOptions: {
|
||||
groupPathsBy: 'tag',
|
||||
categoryLinkSource: 'tag',
|
||||
},
|
||||
version: 'v2024',
|
||||
label: 'v2024',
|
||||
baseUrl: '/docs/api/v2024',
|
||||
template: 'api.mustache',
|
||||
markdownGenerators: {
|
||||
createApiPageMD,
|
||||
},
|
||||
versions: {
|
||||
// v2025: {
|
||||
// specPath: 'static/api-specs/idn/sailpoint-api.v2025.yaml',
|
||||
// outputDir: 'docs/api/v2025',
|
||||
// label: 'v2025',
|
||||
// baseUrl: '/docs/api/v2025',
|
||||
// },
|
||||
v3: {
|
||||
specPath: 'static/api-specs/idn/sailpoint-api.v3.yaml',
|
||||
outputDir: 'docs/api/v3',
|
||||
downloadUrl: 'https://raw.githubusercontent.com/sailpoint-oss/api-specs/main/dereferenced/deref-sailpoint-api.v3.yaml',
|
||||
label: 'v3',
|
||||
baseUrl: '/docs/api/v3',
|
||||
},
|
||||
beta: {
|
||||
specPath: 'static/api-specs/idn/sailpoint-api.beta.yaml',
|
||||
outputDir: 'docs/api/beta',
|
||||
downloadUrl: 'https://raw.githubusercontent.com/sailpoint-oss/api-specs/main/dereferenced/deref-sailpoint-api.beta.yaml',
|
||||
label: 'Beta',
|
||||
baseUrl: '/docs/api/beta',
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
[
|
||||
'docusaurus-plugin-openapi-docs',
|
||||
{
|
||||
@@ -1660,7 +1708,7 @@ module.exports = [
|
||||
},
|
||||
],
|
||||
[
|
||||
"@gracefullight/docusaurus-plugin-microsoft-clarity",
|
||||
{ projectId: "naher5vlxx" },
|
||||
'@gracefullight/docusaurus-plugin-microsoft-clarity',
|
||||
{projectId: 'naher5vlxx'},
|
||||
],
|
||||
];
|
||||
|
||||
370
sidebars.js
370
sidebars.js
@@ -1,3 +1,9 @@
|
||||
const versions = require('./docs/api/v2024/versions.json');
|
||||
const {
|
||||
versionSelector,
|
||||
versionCrumb,
|
||||
} = require('docusaurus-plugin-openapi-docs/lib/sidebars/utils');
|
||||
|
||||
const sidebars = {
|
||||
openApiSidebar: [
|
||||
{
|
||||
@@ -9,128 +15,6 @@ const sidebars = {
|
||||
id: 'docs',
|
||||
},
|
||||
items: [
|
||||
{
|
||||
type: 'category',
|
||||
label: 'API Specifications',
|
||||
collapsible: false,
|
||||
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/api-versioning-strategy',
|
||||
},
|
||||
{
|
||||
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.ts'),
|
||||
},
|
||||
{
|
||||
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.ts'),
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
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.ts'),
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Extensibility',
|
||||
@@ -219,20 +103,6 @@ const sidebars = {
|
||||
id: 'iiq',
|
||||
},
|
||||
items: [
|
||||
{
|
||||
type: 'category',
|
||||
label: 'API Specifications',
|
||||
collapsible: false,
|
||||
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.ts'),
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Plugin Developer Guide',
|
||||
@@ -255,5 +125,233 @@ const sidebars = {
|
||||
],
|
||||
},
|
||||
],
|
||||
iiqApiSideBar: [
|
||||
{
|
||||
type: 'category',
|
||||
label: 'API Specifications',
|
||||
collapsible: false,
|
||||
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.ts'),
|
||||
},
|
||||
],
|
||||
nermSideBar: [
|
||||
{
|
||||
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.ts'),
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
isc_2024_sidebar: [
|
||||
{
|
||||
type: 'html',
|
||||
defaultStyle: true,
|
||||
value: versionSelector(versions),
|
||||
className: 'version-button',
|
||||
},
|
||||
{
|
||||
type: 'html',
|
||||
defaultStyle: true,
|
||||
value: versionCrumb(`v2024`),
|
||||
},
|
||||
// {
|
||||
// type: "html",
|
||||
// defaultStyle: true,
|
||||
// value: ` <select id="featureToggle" onchange="toggleFeatures()">
|
||||
// <option value="all" selected>All</option>
|
||||
// <option value="public">Public</option>
|
||||
// <option value="experimental">Experimental</option>
|
||||
// </select>`,
|
||||
// },
|
||||
{
|
||||
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: 'V2024 APIs',
|
||||
link: {
|
||||
type: 'generated-index',
|
||||
title: 'v2024 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/v2024',
|
||||
},
|
||||
// @ts-ignore
|
||||
items: require('./docs/api/v2024/sidebar.ts'),
|
||||
},
|
||||
],
|
||||
isc_beta_sidebar: [
|
||||
{
|
||||
type: 'html',
|
||||
defaultStyle: true,
|
||||
value: versionSelector(versions),
|
||||
className: 'version-button',
|
||||
},
|
||||
{
|
||||
type: 'html',
|
||||
defaultStyle: true,
|
||||
value: versionCrumb(`beta`),
|
||||
},
|
||||
{
|
||||
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: '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. 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.ts'),
|
||||
},
|
||||
],
|
||||
isc_v3_sidebar: [
|
||||
{
|
||||
type: 'html',
|
||||
defaultStyle: true,
|
||||
value: versionSelector(versions),
|
||||
className: 'version-button',
|
||||
},
|
||||
{
|
||||
type: 'html',
|
||||
defaultStyle: true,
|
||||
value: versionCrumb(`v3`),
|
||||
},
|
||||
{
|
||||
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.ts'),
|
||||
},
|
||||
],
|
||||
};
|
||||
module.exports = sidebars;
|
||||
|
||||
@@ -6,6 +6,8 @@
|
||||
|
||||
/* You can override the default Infima variables here. */
|
||||
|
||||
@import url('https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0-beta3/css/all.min.css');
|
||||
|
||||
.ReactModal__Overlay {
|
||||
z-index: 9999;
|
||||
}
|
||||
@@ -285,6 +287,9 @@
|
||||
--dev-sailpoint-small-logo: url('../../static/img/SailPoint-Logo-RGB-Color.png');
|
||||
|
||||
--ifm-font-family-base: 'Poppins';
|
||||
|
||||
--dev-icon-experimental: #cc27b0;
|
||||
--dev-icon-deprecated: rgb(230, 167, 0);
|
||||
}
|
||||
|
||||
/* For readability concerns, you should choose a lighter palette in dark mode. */
|
||||
@@ -355,10 +360,15 @@
|
||||
font-weight: 400;
|
||||
}
|
||||
|
||||
.menu__link {
|
||||
padding-left: 13%;
|
||||
}
|
||||
|
||||
/* Sidebar Method labels */
|
||||
.api-method > .menu__link {
|
||||
align-items: center;
|
||||
justify-content: start;
|
||||
width: fit-content;
|
||||
}
|
||||
|
||||
.api-method > .menu__link::before {
|
||||
@@ -476,8 +486,6 @@ html[data-theme='dark'] .theme-admonition-note {
|
||||
background-color: #474748;
|
||||
}
|
||||
|
||||
ul {
|
||||
}
|
||||
|
||||
.button.button--secondary {
|
||||
color: white;
|
||||
@@ -550,4 +558,28 @@ div[id^='discourse-comments'] {
|
||||
|
||||
.openapi-security__summary-container {
|
||||
background: var(--ifm-pre-background);
|
||||
}
|
||||
|
||||
.menu__list-item--experimental > .menu__link::after {
|
||||
font-size: 20px;
|
||||
font-family: 'Font Awesome 6 Free';
|
||||
font-weight: 900;
|
||||
color: var(--dev-icon-experimental);
|
||||
text-rendering: auto;
|
||||
-webkit-font-smoothing: antialiased;
|
||||
content: '\f0c3';
|
||||
position: relative;
|
||||
right: 103%;
|
||||
}
|
||||
|
||||
.menu__list-item--deprecated > .menu__link::after {
|
||||
font-size: 20px;
|
||||
font-family: 'Font Awesome 6 Free';
|
||||
font-weight: 900;
|
||||
color: var(--dev-icon-deprecated);
|
||||
text-rendering: auto;
|
||||
-webkit-font-smoothing: antialiased;
|
||||
content: '\f071';
|
||||
position: relative;
|
||||
right: 103%;
|
||||
}
|
||||
2151
static/api-specs/idn/sailpoint-api.v2024.yaml
Normal file
2151
static/api-specs/idn/sailpoint-api.v2024.yaml
Normal file
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,62 @@
|
||||
get:
|
||||
summary: List Access Model Metadata Attributes
|
||||
description: Get a list of Access Model Metadata Attributes
|
||||
tags:
|
||||
- Access Model Metadata
|
||||
operationId: listAccessModelMetadataAttribute
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:access-model-metadata:read
|
||||
parameters:
|
||||
- in: query
|
||||
name: filters
|
||||
schema:
|
||||
type: string
|
||||
example: name eq "Privacy"
|
||||
description: 'Filter results using the standard syntax described in [V3 API Standard
|
||||
Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
||||
|
||||
|
||||
Filtering is supported for the following fields and operators:
|
||||
|
||||
|
||||
**name**: *eq*
|
||||
|
||||
|
||||
**type**: *eq*
|
||||
|
||||
|
||||
**status**: *eq*
|
||||
|
||||
|
||||
**objectTypes**: *eq*
|
||||
|
||||
|
||||
Supported composite operators: *and*'
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/gov-attributes/AttributeDTO.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
|
||||
@@ -0,0 +1,44 @@
|
||||
get:
|
||||
summary: List Access Model Metadata Values
|
||||
description: Get a list of Access Model Metadata Attribute Values
|
||||
tags:
|
||||
- Access Model Metadata
|
||||
operationId: listAccessModelMetadataAttributeValue
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:access-model-metadata:read
|
||||
parameters:
|
||||
- name: key
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Technical name of the Attribute.
|
||||
example: iscPrivacy
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/gov-attributes/AttributeValueDTO.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
|
||||
@@ -0,0 +1,49 @@
|
||||
get:
|
||||
summary: Get Access Model Metadata Value
|
||||
description: Get single Access Model Metadata Attribute Value
|
||||
tags:
|
||||
- Access Model Metadata
|
||||
operationId: getAccessModelMetadataAttributeValue
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:access-model-metadata:read
|
||||
parameters:
|
||||
- name: key
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Technical name of the Attribute.
|
||||
example: iscPrivacy
|
||||
- name: value
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Technical name of the Attribute value.
|
||||
example: public
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/gov-attributes/AttributeValueDTO.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
|
||||
42
static/api-specs/idn/v2024/paths/access-model-metadata.yaml
Normal file
42
static/api-specs/idn/v2024/paths/access-model-metadata.yaml
Normal file
@@ -0,0 +1,42 @@
|
||||
get:
|
||||
summary: Get Access Model Metadata Attribute
|
||||
description: Get single Access Model Metadata Attribute
|
||||
tags:
|
||||
- Access Model Metadata
|
||||
operationId: getAccessModelMetadataAttribute
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:access-model-metadata:read
|
||||
parameters:
|
||||
- name: key
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Technical name of the Attribute.
|
||||
example: iscPrivacy
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/gov-attributes/AttributeDTO.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
|
||||
@@ -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.\n\n> If any of the indicated Access Profiles is exists in\
|
||||
\ Organization,then those Access Profiles will be added in **updated**\n list\
|
||||
\ of the response.Requestable field of these Access Profiles marked as **true**\
|
||||
\ or **false**.\n\n> 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.\n\
|
||||
> 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
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
69
static/api-specs/idn/v2024/paths/access-request-close.yaml
Normal file
69
static/api-specs/idn/v2024/paths/access-request-close.yaml
Normal file
@@ -0,0 +1,69 @@
|
||||
post:
|
||||
operationId: closeAccessRequest
|
||||
tags:
|
||||
- Access Requests
|
||||
summary: Close Access Request
|
||||
description: 'This endpoint closes access requests that are stuck in a pending state.
|
||||
It can be used throughout a request''s lifecycle even after the approval state,
|
||||
unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/).
|
||||
A token with ORG_ADMIN authority is required.
|
||||
|
||||
|
||||
To find pending access requests with the UI, navigate to Search and use this query:
|
||||
status: Pending AND "Access Request". Use the Column Chooser to select ''Tracking
|
||||
Number'', and use the ''Download'' button to export a CSV containing the tracking
|
||||
numbers.
|
||||
|
||||
|
||||
To find pending access requests with the API, use the [List Account Activities
|
||||
endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/).
|
||||
|
||||
|
||||
Input the IDs from either source.
|
||||
|
||||
|
||||
To track the status of endpoint requests, navigate to Search and use this query:
|
||||
name:"Close Identity Requests". Search will include "Close Identity Requests Started"
|
||||
audits when requests are initiated and "Close Identity Requests Completed" audits
|
||||
when requests are completed. The completion audit will list the identity request
|
||||
IDs that finished in error.
|
||||
|
||||
|
||||
This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/provisioning-completed/)
|
||||
for each access request that is closed.
|
||||
|
||||
'
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../v3/schemas/CloseAccessRequest.yaml
|
||||
example:
|
||||
accessRequestIds:
|
||||
- 2c90ad2a70ace7d50170acf22ca90010
|
||||
executionStatus: Terminated
|
||||
completionStatus: Failure
|
||||
message: The IdentityNow Administrator manually closed this request.
|
||||
responses:
|
||||
'202':
|
||||
$ref: ../../v3/responses/202.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
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
@@ -0,0 +1,61 @@
|
||||
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: ../../beta/schemas/AccessItemRef.yaml
|
||||
example: ENTITLEMENT
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
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: ../../beta/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
|
||||
@@ -0,0 +1,60 @@
|
||||
get:
|
||||
operationId: getAccountAggregationStatus
|
||||
tags:
|
||||
- Account Aggregations
|
||||
summary: In-progress Account Aggregation status
|
||||
description: 'This API returns the status of an *in-progress* account aggregation,
|
||||
along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found
|
||||
since the previous aggregation, and the number of those accounts that have been
|
||||
processed so far.
|
||||
|
||||
|
||||
Accounts that have not changed since the previous aggregation are not included
|
||||
in **totalAccounts** and **processedAccounts** counts returned by this API. This
|
||||
is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates
|
||||
total accounts scanned regardless of whether they changed or not.
|
||||
|
||||
|
||||
Since this endpoint reports on the status of an *in-progress* account aggregation,
|
||||
totalAccounts and processedAccounts may change between calls to this endpoint.
|
||||
|
||||
|
||||
*Only available up to an hour after the aggregation completes. May respond with
|
||||
*404 Not Found* after that.*
|
||||
|
||||
|
||||
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN or DASHBOARD authority is
|
||||
required to call this API.'
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: The account aggregation id
|
||||
example: 2c91808477a6b0c60177a81146b8110b
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: An account aggregation status object
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/AccountAggregationStatus.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
|
||||
@@ -0,0 +1,109 @@
|
||||
post:
|
||||
operationId: addAccessRequestRecommendationsIgnoredItem
|
||||
tags:
|
||||
- IAI Access Request Recommendations
|
||||
summary: Notification of Ignored Access Request Recommendations
|
||||
description: This API ignores a recommended access request item. Once an item is
|
||||
ignored, it will be marked as ignored=true if it is still a recommended item.
|
||||
The consumer can decide to hide ignored recommendations.
|
||||
requestBody:
|
||||
description: The recommended access item to ignore for an identity.
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/AccessRequestRecommendationActionItemDto.yaml
|
||||
responses:
|
||||
'201':
|
||||
description: Recommendation successfully stored as ignored.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/AccessRequestRecommendationActionItemResponseDto.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
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
get:
|
||||
operationId: getAccessRequestRecommendationsIgnoredItems
|
||||
tags:
|
||||
- IAI Access Request Recommendations
|
||||
summary: List of Ignored Access Request Recommendations
|
||||
description: This API returns the list of ignored access request recommendations.
|
||||
parameters:
|
||||
- $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:
|
||||
|
||||
|
||||
**access.id**: *eq, in*
|
||||
|
||||
|
||||
**access.type**: *eq, in*
|
||||
|
||||
|
||||
**identityId**: *eq, in*'
|
||||
example: identityId eq "2c9180846b0a0583016b299f210c1314"
|
||||
- in: query
|
||||
name: sorters
|
||||
schema:
|
||||
type: string
|
||||
format: comma-separated
|
||||
description: 'Sort results using the standard syntax described in [V3 API Standard
|
||||
Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
||||
|
||||
|
||||
Sorting is supported for the following fields: **access.id, access.type, identityId,
|
||||
timestamp**'
|
||||
example: access.id
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: Returns list of ignored access request recommendations.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/AccessRequestRecommendationActionItemResponseDto.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
|
||||
@@ -0,0 +1,108 @@
|
||||
post:
|
||||
operationId: addAccessRequestRecommendationsRequestedItem
|
||||
tags:
|
||||
- IAI Access Request Recommendations
|
||||
summary: Notification of Requested Access Request Recommendations
|
||||
description: This API consumes a notification that a recommended access request
|
||||
item was requested. This API does not actually make the request, it is just a
|
||||
notification. This will help provide feedback in order to improve our recommendations.
|
||||
requestBody:
|
||||
description: The recommended access item that was requested for an identity.
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/AccessRequestRecommendationActionItemDto.yaml
|
||||
responses:
|
||||
'201':
|
||||
description: Notification successfully acknowledged.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/AccessRequestRecommendationActionItemResponseDto.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
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
get:
|
||||
operationId: getAccessRequestRecommendationsRequestedItems
|
||||
tags:
|
||||
- IAI Access Request Recommendations
|
||||
summary: List of Requested Access Request Recommendations
|
||||
description: This API returns a list of requested access request recommendations.
|
||||
parameters:
|
||||
- $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:
|
||||
|
||||
|
||||
**access.id**: *eq, in*
|
||||
|
||||
|
||||
**access.type**: *eq, in*
|
||||
|
||||
|
||||
**identityId**: *eq, in*'
|
||||
example: access.id eq "2c9180846b0a0583016b299f210c1314"
|
||||
- in: query
|
||||
name: sorters
|
||||
schema:
|
||||
type: string
|
||||
format: comma-separated
|
||||
description: 'Sort results using the standard syntax described in [V3 API Standard
|
||||
Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
||||
|
||||
|
||||
Sorting is supported for the following fields: **access.id, access.type, identityId,
|
||||
timestamp**'
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: Returns the list of requested access request recommendations.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/AccessRequestRecommendationActionItemResponseDto.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
|
||||
@@ -0,0 +1,46 @@
|
||||
post:
|
||||
operationId: addAccessRequestRecommendationsViewedItems
|
||||
tags:
|
||||
- IAI Access Request Recommendations
|
||||
summary: Notification of Viewed Access Request Recommendations in Bulk
|
||||
description: This API consumes a notification that a set of recommended access request
|
||||
item were viewed. Future recommendations with these items will be marked with
|
||||
viewed=true. This can be useful for the consumer to determine if there are any
|
||||
new/unviewed recommendations.
|
||||
requestBody:
|
||||
description: The recommended access items that were viewed for an identity.
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/AccessRequestRecommendationActionItemDto.yaml
|
||||
responses:
|
||||
'201':
|
||||
description: Recommendations successfully stored as viewed.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/AccessRequestRecommendationActionItemResponseDto.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
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
@@ -0,0 +1,109 @@
|
||||
post:
|
||||
operationId: addAccessRequestRecommendationsViewedItem
|
||||
tags:
|
||||
- IAI Access Request Recommendations
|
||||
summary: Notification of Viewed Access Request Recommendations
|
||||
description: This API consumes a notification that a recommended access request
|
||||
item was viewed. Future recommendations with this item will be marked with viewed=true.
|
||||
This can be useful for the consumer to determine if there are any new/unviewed
|
||||
recommendations.
|
||||
requestBody:
|
||||
description: The recommended access that was viewed for an identity.
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/AccessRequestRecommendationActionItemDto.yaml
|
||||
responses:
|
||||
'201':
|
||||
description: Recommendation successfully stored as viewed.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/AccessRequestRecommendationActionItemResponseDto.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
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
get:
|
||||
operationId: getAccessRequestRecommendationsViewedItems
|
||||
tags:
|
||||
- IAI Access Request Recommendations
|
||||
summary: List of Viewed Access Request Recommendations
|
||||
description: This API returns the list of viewed access request recommendations.
|
||||
parameters:
|
||||
- $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:
|
||||
|
||||
|
||||
**access.id**: *eq, in*
|
||||
|
||||
|
||||
**access.type**: *eq, in*
|
||||
|
||||
|
||||
**identityId**: *eq, in*'
|
||||
example: access.id eq "2c9180846b0a0583016b299f210c1314"
|
||||
- in: query
|
||||
name: sorters
|
||||
schema:
|
||||
type: string
|
||||
format: comma-separated
|
||||
description: 'Sort results using the standard syntax described in [V3 API Standard
|
||||
Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
||||
|
||||
|
||||
Sorting is supported for the following fields: **access.id, access.type, identityId,
|
||||
timestamp**'
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: Returns list of viewed access request recommendations.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/AccessRequestRecommendationActionItemResponseDto.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
|
||||
@@ -0,0 +1,96 @@
|
||||
get:
|
||||
operationId: getAccessRequestRecommendations
|
||||
tags:
|
||||
- IAI Access Request Recommendations
|
||||
summary: Identity Access Request Recommendations
|
||||
description: This API returns the access request recommendations for the specified
|
||||
identity. The default identity is *me* which indicates the current user.
|
||||
parameters:
|
||||
- in: query
|
||||
name: identity-id
|
||||
description: Get access request recommendations for an identityId. *me* indicates
|
||||
the current user.
|
||||
schema:
|
||||
type: string
|
||||
default: me
|
||||
required: false
|
||||
example: 2c91808570313110017040b06f344ec9
|
||||
- in: query
|
||||
name: limit
|
||||
description: Max number of results to return.
|
||||
required: false
|
||||
schema:
|
||||
type: integer
|
||||
minimum: 0
|
||||
maximum: 15
|
||||
default: 15
|
||||
- $ref: ../../v3/parameters/offset.yaml
|
||||
- $ref: ../../v3/parameters/count.yaml
|
||||
- in: query
|
||||
name: include-translation-messages
|
||||
description: If *true* it will populate a list of translation messages in the
|
||||
response.
|
||||
schema:
|
||||
type: boolean
|
||||
default: false
|
||||
required: false
|
||||
example: false
|
||||
- in: query
|
||||
name: filters
|
||||
schema:
|
||||
type: string
|
||||
description: 'Filter results using the standard syntax described in [V3 API Standard
|
||||
Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
||||
|
||||
|
||||
Filtering is supported for the following fields and operators:
|
||||
|
||||
|
||||
**access.name**: *co*
|
||||
|
||||
|
||||
**access.type**: *eq, in*
|
||||
|
||||
|
||||
**access.description**: *co, eq, in*'
|
||||
example: access.name co "admin"
|
||||
- in: query
|
||||
name: sorters
|
||||
schema:
|
||||
type: string
|
||||
format: comma-separated
|
||||
description: 'Sort results using the standard syntax described in [V3 API Standard
|
||||
Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
||||
|
||||
|
||||
Sorting is supported for the following fields: **access.name, access.type**
|
||||
|
||||
|
||||
By default the recommendations are sorted by highest confidence first.'
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: List of access request recommendations for the identityId
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/AccessRequestRecommendationItemDetail.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
|
||||
85
static/api-specs/idn/v2024/paths/approval.yaml
Normal file
85
static/api-specs/idn/v2024/paths/approval.yaml
Normal file
@@ -0,0 +1,85 @@
|
||||
get:
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- sp:approvals:read
|
||||
operationId: getApproval
|
||||
tags:
|
||||
- Approvals
|
||||
summary: Get an approval
|
||||
description: Retrieve a single approval for a given approval ID. This endpoint is
|
||||
for generic approvals, different than the access-request-approval endpoint and
|
||||
does not include access-request-approvals.
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: ID of the approval that is to be returned
|
||||
example: 38453251-6be2-5f8f-df93-5ce19e295837
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: Approval object
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/Approval.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:
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- sp:approvals:write
|
||||
operationId: patchApproval
|
||||
tags:
|
||||
- Approvals
|
||||
summary: Change an approval
|
||||
description: Change the values of a given approval
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/ApprovalDto.yaml
|
||||
responses:
|
||||
'200':
|
||||
description: Approval object
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/Approval.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
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
70
static/api-specs/idn/v2024/paths/approvals.yaml
Normal file
70
static/api-specs/idn/v2024/paths/approvals.yaml
Normal file
@@ -0,0 +1,70 @@
|
||||
get:
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- sp:approvals:read
|
||||
operationId: getApprovals
|
||||
tags:
|
||||
- Approvals
|
||||
summary: Get Approvals
|
||||
description: "Retrieve a list of approvals, which can be filtered by requester ID,\
|
||||
\ status, or reference type. \"Mine\" query parameter can be used and it will\
|
||||
\ return all approvals for the current approver. This endpoint is for generic\
|
||||
\ approvals, different than the access-request-approval endpoint and does not\
|
||||
\ include access-request-approvals. \nAbsence of all query parameters will will\
|
||||
\ default to mine=true."
|
||||
parameters:
|
||||
- in: query
|
||||
name: mine
|
||||
schema:
|
||||
type: boolean
|
||||
description: Returns the list of approvals for the current caller
|
||||
example: 'true'
|
||||
- in: query
|
||||
name: requesterId
|
||||
schema:
|
||||
type: string
|
||||
description: Returns the list of approvals for a given requester ID
|
||||
example: 17e633e7d57e481569df76323169deb6a
|
||||
- in: query
|
||||
name: filters
|
||||
schema:
|
||||
type: string
|
||||
description: 'Filter results using the standard syntax described in [V3 API Standard
|
||||
Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
||||
|
||||
|
||||
Filtering is supported for the following fields and operators:
|
||||
|
||||
|
||||
**status**: *eq*
|
||||
|
||||
|
||||
**referenceType**: *eq*'
|
||||
example: filters=status eq PENDING
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: List of Approvals
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/Approval.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
|
||||
104
static/api-specs/idn/v2024/paths/attr-sync-config-source.yaml
Normal file
104
static/api-specs/idn/v2024/paths/attr-sync-config-source.yaml
Normal file
@@ -0,0 +1,104 @@
|
||||
get:
|
||||
operationId: getSourceAttrSyncConfig
|
||||
tags:
|
||||
- Sources
|
||||
summary: Attribute Sync Config
|
||||
description: 'This API returns the existing attribute synchronization configuration
|
||||
for a source specified by the given ID. The response contains all attributes,
|
||||
regardless of whether they enabled or not.
|
||||
|
||||
A token with ORG_ADMIN or HELPDESK authority is required to call this API.'
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:attr-sync-source-config:read
|
||||
- idn:attr-sync-source-config:manage
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: The source id
|
||||
example: 2c9180835d191a86015d28455b4a2329
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: Attribute synchronization configuration for a source
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/AttrSyncSourceConfig.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
|
||||
put:
|
||||
operationId: putSourceAttrSyncConfig
|
||||
tags:
|
||||
- Sources
|
||||
summary: Update Attribute Sync Config
|
||||
description: "Replaces the attribute synchronization configuration for the source\
|
||||
\ specified by the given ID with the configuration provided in the request body.\
|
||||
\ Only the \"enabled\" field of the values in the \"attributes\" array is mutable.\
|
||||
\ Attempting to change other attributes or add new values to the \"attributes\"\
|
||||
\ array will result in an error.\n \nA token with ORG_ADMIN authority is required\
|
||||
\ to call this API."
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:attr-sync-source-config:manage
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: The source id
|
||||
example: 2c9180835d191a86015d28455b4a2329
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/AttrSyncSourceConfig.yaml
|
||||
responses:
|
||||
'200':
|
||||
description: Updated attribute synchronization configuration for a source
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/AttrSyncSourceConfig.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
|
||||
91
static/api-specs/idn/v2024/paths/auth-profile.yaml
Normal file
91
static/api-specs/idn/v2024/paths/auth-profile.yaml
Normal file
@@ -0,0 +1,91 @@
|
||||
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: ../../beta/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
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
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
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
requestBody:
|
||||
content:
|
||||
application/json-patch+json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/JsonPatchOperation.yaml
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: Responds with the Auth Profile as updated.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/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
|
||||
35
static/api-specs/idn/v2024/paths/auth-profiles.yaml
Normal file
35
static/api-specs/idn/v2024/paths/auth-profiles.yaml
Normal file
@@ -0,0 +1,35 @@
|
||||
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: ../../beta/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
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
@@ -0,0 +1,39 @@
|
||||
post:
|
||||
operationId: updateCommonAccessStatusInBulk
|
||||
summary: Bulk update common access status
|
||||
tags:
|
||||
- IAI Common Access
|
||||
description: This submits an update request to the common access application. At
|
||||
this time there are no parameters. Requires authorization scope of iai:access-modeling:update
|
||||
requestBody:
|
||||
description: Confirm or deny in bulk the common access ids that are (or aren't)
|
||||
common access
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/CommonAccessIDStatus.yaml
|
||||
responses:
|
||||
'202':
|
||||
$ref: ../../v3/responses/202.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
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
120
static/api-specs/idn/v2024/paths/common-access.yaml
Normal file
120
static/api-specs/idn/v2024/paths/common-access.yaml
Normal file
@@ -0,0 +1,120 @@
|
||||
get:
|
||||
operationId: getCommonAccess
|
||||
summary: Get a paginated list of common access
|
||||
tags:
|
||||
- IAI Common Access
|
||||
description: This endpoint returns the current common access for a customer. The
|
||||
returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read
|
||||
parameters:
|
||||
- $ref: ../../v3/parameters/offset.yaml
|
||||
- $ref: ../../v3/parameters/limit.yaml
|
||||
- $ref: ../../v3/parameters/count.yaml
|
||||
- in: query
|
||||
name: filters
|
||||
description: 'Filter results using the standard syntax described in [V3 API Standard
|
||||
Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
||||
|
||||
|
||||
Filtering is supported for the following fields and operators:
|
||||
|
||||
|
||||
**status**: *eq, sw*
|
||||
|
||||
|
||||
**reviewedByUser** *eq*
|
||||
|
||||
|
||||
**access.id**: *eq, sw*
|
||||
|
||||
|
||||
**access.type**: *eq*
|
||||
|
||||
|
||||
**access.name**: *sw, eq*
|
||||
|
||||
|
||||
**access.description**: *sw, eq*'
|
||||
example: access.type eq "ROLE"
|
||||
required: false
|
||||
style: form
|
||||
explode: true
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: sorters
|
||||
schema:
|
||||
type: string
|
||||
format: comma-separated
|
||||
description: 'Sort results using the standard syntax described in [V3 API Standard
|
||||
Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
||||
|
||||
|
||||
Sorting is supported for the following fields: **access.name, status**
|
||||
|
||||
|
||||
By default the common access items are sorted by name, ascending.'
|
||||
example: access.name
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: Succeeded. Returns a list of common access for a customer.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/CommonAccessResponse.yaml
|
||||
'400':
|
||||
$ref: ../../v3/responses/400.yaml
|
||||
'401':
|
||||
$ref: ../../v3/responses/401.yaml
|
||||
'403':
|
||||
$ref: ../../v3/responses/403.yaml
|
||||
'500':
|
||||
$ref: ../../v3/responses/500.yaml
|
||||
post:
|
||||
operationId: createCommonAccess
|
||||
summary: Create common access items
|
||||
tags:
|
||||
- IAI Common Access
|
||||
description: This API is used to add roles/access profiles to the list of common
|
||||
access for a customer. Requires authorization scope of iai:access-modeling:create
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/CommonAccessItemRequest.yaml
|
||||
responses:
|
||||
'202':
|
||||
description: Returns details of the common access classification request.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/CommonAccessItemResponse.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
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
@@ -0,0 +1,45 @@
|
||||
post:
|
||||
tags:
|
||||
- Connector Rule Management
|
||||
operationId: validateConnectorRule
|
||||
summary: Validate Connector Rule
|
||||
description: 'Returns a list of issues within the code to fix, if any.
|
||||
|
||||
A token with ORG_ADMIN authority is required to call this API.'
|
||||
requestBody:
|
||||
required: true
|
||||
description: The code to validate
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/SourceCode.yaml
|
||||
responses:
|
||||
'200':
|
||||
description: The status of the code's eligibility as a connector rule
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/ConnectorRuleValidationResponse.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:rule-management-connector:read
|
||||
- idn:rule-management-connector:manage
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
148
static/api-specs/idn/v2024/paths/connector-rule.yaml
Normal file
148
static/api-specs/idn/v2024/paths/connector-rule.yaml
Normal file
@@ -0,0 +1,148 @@
|
||||
get:
|
||||
tags:
|
||||
- Connector Rule Management
|
||||
summary: Connector-Rule by ID
|
||||
operationId: getConnectorRule
|
||||
description: 'Returns the connector rule specified by ID.
|
||||
|
||||
A token with ORG_ADMIN authority is required to call this API.'
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: ID of the connector rule to retrieve
|
||||
required: true
|
||||
style: simple
|
||||
explode: false
|
||||
schema:
|
||||
type: string
|
||||
example: 8c190e6787aa4ed9a90bd9d5344523fb
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: Connector rule with the given ID
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/ConnectorRuleResponse.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:rule-management-connector:read
|
||||
- idn:rule-management-connector:manage
|
||||
put:
|
||||
tags:
|
||||
- Connector Rule Management
|
||||
summary: Update a Connector Rule
|
||||
description: 'Updates an existing connector rule with the one provided in the request
|
||||
body. Note that the fields ''id'', ''name'', and ''type'' are immutable.
|
||||
|
||||
A token with ORG_ADMIN authority is required to call this API.'
|
||||
operationId: updateConnectorRule
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: ID of the connector rule to update
|
||||
required: true
|
||||
style: simple
|
||||
explode: false
|
||||
schema:
|
||||
type: string
|
||||
example: 8c190e6787aa4ed9a90bd9d5344523fb
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
requestBody:
|
||||
description: The connector rule with updated data
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/ConnectorRuleUpdateRequest.yaml
|
||||
responses:
|
||||
'200':
|
||||
description: The updated connector rule
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/ConnectorRuleResponse.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:rule-management-connector:manage
|
||||
delete:
|
||||
tags:
|
||||
- Connector Rule Management
|
||||
summary: Delete a Connector-Rule
|
||||
description: 'Deletes the connector rule specified by the given ID.
|
||||
|
||||
A token with ORG_ADMIN authority is required to call this API.'
|
||||
operationId: deleteConnectorRule
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: ID of the connector rule to delete
|
||||
required: true
|
||||
style: simple
|
||||
explode: false
|
||||
schema:
|
||||
type: string
|
||||
example: 8c190e6787aa4ed9a90bd9d5344523fb
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
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
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:rule-management-connector:manage
|
||||
84
static/api-specs/idn/v2024/paths/connector-rules.yaml
Normal file
84
static/api-specs/idn/v2024/paths/connector-rules.yaml
Normal file
@@ -0,0 +1,84 @@
|
||||
get:
|
||||
tags:
|
||||
- Connector Rule Management
|
||||
operationId: getConnectorRuleList
|
||||
summary: List Connector Rules
|
||||
description: 'Returns the list of connector rules.
|
||||
|
||||
A token with ORG_ADMIN authority is required to call this API.'
|
||||
responses:
|
||||
'200':
|
||||
description: A list of connector rules
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/ConnectorRuleResponse.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:rule-management-connector:read
|
||||
- idn:rule-management-connector:manage
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
post:
|
||||
tags:
|
||||
- Connector Rule Management
|
||||
operationId: createConnectorRule
|
||||
summary: Create Connector Rule
|
||||
description: 'Creates a new connector rule.
|
||||
|
||||
A token with ORG_ADMIN authority is required to call this API.'
|
||||
requestBody:
|
||||
required: true
|
||||
description: The connector rule to create
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/ConnectorRuleCreateRequest.yaml
|
||||
responses:
|
||||
'201':
|
||||
description: The created connector rule
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/ConnectorRuleResponse.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:rule-management-connector:manage
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
@@ -0,0 +1,115 @@
|
||||
get:
|
||||
operationId: getCustomPasswordInstructions
|
||||
tags:
|
||||
- Custom Password Instructions
|
||||
summary: Get Custom Password Instructions by Page ID
|
||||
description: This API returns the custom password instructions for the specified
|
||||
page ID. A token with ORG_ADMIN authority is required to call this API.
|
||||
parameters:
|
||||
- in: path
|
||||
name: pageId
|
||||
schema:
|
||||
type: string
|
||||
enum:
|
||||
- change-password:enter-password
|
||||
- change-password:finish
|
||||
- flow-selection:select
|
||||
- forget-username:user-email
|
||||
- mfa:enter-code
|
||||
- mfa:enter-kba
|
||||
- mfa:select
|
||||
- reset-password:enter-password
|
||||
- reset-password:enter-username
|
||||
- reset-password:finish
|
||||
- unlock-account:enter-username
|
||||
- unlock-account:finish
|
||||
required: true
|
||||
description: The page ID of custom password instructions to query.
|
||||
example: mfa:select
|
||||
- in: query
|
||||
name: locale
|
||||
schema:
|
||||
type: string
|
||||
description: The locale for the custom instructions, a BCP47 language tag. The
|
||||
default value is \"default\".
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: Reference to the custom password instructions.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/CustomPasswordInstruction.yaml
|
||||
example:
|
||||
pageId: reset-password:enter-password
|
||||
locale: default
|
||||
pageContent: See company password policies for details by clicking <a
|
||||
href="url">here</a>
|
||||
'400':
|
||||
$ref: ../../v3/responses/400.yaml
|
||||
'403':
|
||||
$ref: ../../v3/responses/403.yaml
|
||||
'404':
|
||||
$ref: ../../v3/responses/404.yaml
|
||||
'500':
|
||||
$ref: ../../v3/responses/500.yaml
|
||||
delete:
|
||||
operationId: deleteCustomPasswordInstructions
|
||||
tags:
|
||||
- Custom Password Instructions
|
||||
summary: Delete Custom Password Instructions by page ID
|
||||
description: This API delete the custom password instructions for the specified
|
||||
page ID. A token with ORG_ADMIN authority is required to call this API.
|
||||
parameters:
|
||||
- in: path
|
||||
name: pageId
|
||||
schema:
|
||||
type: string
|
||||
enum:
|
||||
- change-password:enter-password
|
||||
- change-password:finish
|
||||
- flow-selection:select
|
||||
- forget-username:user-email
|
||||
- mfa:enter-code
|
||||
- mfa:enter-kba
|
||||
- mfa:select
|
||||
- reset-password:enter-password
|
||||
- reset-password:enter-username
|
||||
- reset-password:finish
|
||||
- unlock-account:enter-username
|
||||
- unlock-account:finish
|
||||
required: true
|
||||
description: The page ID of custom password instructions to delete.
|
||||
example: mfa:select
|
||||
- in: query
|
||||
name: locale
|
||||
schema:
|
||||
type: string
|
||||
description: The locale for the custom instructions, a BCP47 language tag. The
|
||||
default value is \"default\".
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'204':
|
||||
$ref: ../../v3/responses/204.yaml
|
||||
'400':
|
||||
$ref: ../../v3/responses/400.yaml
|
||||
'403':
|
||||
$ref: ../../v3/responses/403.yaml
|
||||
'404':
|
||||
$ref: ../../v3/responses/404.yaml
|
||||
'500':
|
||||
$ref: ../../v3/responses/500.yaml
|
||||
@@ -0,0 +1,43 @@
|
||||
post:
|
||||
operationId: createCustomPasswordInstructions
|
||||
tags:
|
||||
- Custom Password Instructions
|
||||
summary: Create Custom Password Instructions
|
||||
description: This API creates the custom password instructions for the specified
|
||||
page ID. A token with ORG_ADMIN authority is required to call this API.
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/CustomPasswordInstruction.yaml
|
||||
example:
|
||||
pageId: reset-password:enter-password
|
||||
pageContent: See company password policies for details by clicking <a href="url">here</a>
|
||||
responses:
|
||||
'200':
|
||||
description: Reference to the custom password instructions.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/CustomPasswordInstruction.yaml
|
||||
example:
|
||||
pageId: reset-password:enter-password
|
||||
locale: default
|
||||
pageContent: See company password policies for details by clicking <a
|
||||
href="url">here</a>
|
||||
'400':
|
||||
$ref: ../../v3/responses/400.yaml
|
||||
'403':
|
||||
$ref: ../../v3/responses/403.yaml
|
||||
'500':
|
||||
$ref: ../../v3/responses/500.yaml
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
@@ -0,0 +1,40 @@
|
||||
post:
|
||||
operationId: updateEntitlementsInBulk
|
||||
tags:
|
||||
- Entitlements
|
||||
summary: Bulk update an entitlement list
|
||||
description: "This API applies an update to every entitlement of the list.\n\nThe\
|
||||
\ number of entitlements to update is limited to 50 items maximum.\n\nThe JsonPatch\
|
||||
\ update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\
|
||||
\ allowed operations : **{ \"op\": \"replace\", \"path\": \"/privileged\", \"\
|
||||
value\": boolean }** **{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\"\
|
||||
: boolean }** \n\nA token with ORG_ADMIN or API authority is required to call\
|
||||
\ this API."
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/EntitlementBulkUpdateRequest.yaml
|
||||
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
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
136
static/api-specs/idn/v2024/paths/ears-entitlement-children.yaml
Normal file
136
static/api-specs/idn/v2024/paths/ears-entitlement-children.yaml
Normal file
@@ -0,0 +1,136 @@
|
||||
get:
|
||||
operationId: listEntitlementChildren
|
||||
tags:
|
||||
- Entitlements
|
||||
summary: List of entitlements children
|
||||
description: This API returns a list of all child entitlements of a given entitlement.
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:entitlement:read
|
||||
parameters:
|
||||
- $ref: ../../v3/parameters/limit.yaml
|
||||
- $ref: ../../v3/parameters/offset.yaml
|
||||
- $ref: ../../v3/parameters/count.yaml
|
||||
- in: path
|
||||
name: id
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: Entitlement Id
|
||||
example: 2c91808874ff91550175097daaec161c
|
||||
- in: query
|
||||
name: sorters
|
||||
schema:
|
||||
type: string
|
||||
format: comma-separated
|
||||
description: 'Sort results using the standard syntax described in [V3 API Standard
|
||||
Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
||||
|
||||
|
||||
Sorting is supported for the following fields: **id, name, created, modified,
|
||||
type, attribute, value, source.id**'
|
||||
example: name,-modified
|
||||
required: false
|
||||
style: form
|
||||
explode: true
|
||||
- in: query
|
||||
name: filters
|
||||
schema:
|
||||
type: string
|
||||
description: 'Filter results using the standard syntax described in [V3 API Standard
|
||||
Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
||||
|
||||
|
||||
Filtering is supported for the following fields and operators:
|
||||
|
||||
|
||||
**id**: *eq, in*
|
||||
|
||||
|
||||
**name**: *eq, in, sw*
|
||||
|
||||
|
||||
**type**: *eq, in*
|
||||
|
||||
|
||||
**attribute**: *eq, in*
|
||||
|
||||
|
||||
**value**: *eq, in, sw*
|
||||
|
||||
|
||||
**source.id**: *eq, in*
|
||||
|
||||
|
||||
**requestable**: *eq*
|
||||
|
||||
|
||||
**created**: *gt, lt, ge, le*
|
||||
|
||||
|
||||
**modified**: *gt, lt, ge, le*'
|
||||
example: attribute eq "memberOf"
|
||||
required: false
|
||||
style: form
|
||||
explode: true
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: List of entitlements children from an entitlement
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/Entitlement.yaml
|
||||
example:
|
||||
- sourceSchemaObjectType: group
|
||||
attribute: memberOf
|
||||
attributes:
|
||||
GroupType: Security
|
||||
sAMAccountName: LauncherTest1
|
||||
GroupScope: Global
|
||||
objectguid: '{01a6e70b-9705-4155-a5c6-492a9bcc8c64}'
|
||||
objectSid: S-1-5-21-3585869415-1648031554-2909195034-1633
|
||||
cn: LauncherTest1
|
||||
msDS-PrincipalName: AUTOMATIONAD\LauncherTest1
|
||||
value: CN=LauncherTest1,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local
|
||||
description: some description
|
||||
privileged: false
|
||||
cloudGoverned: false
|
||||
source:
|
||||
type: SOURCE
|
||||
id: 2c9180877504c40e0175097d5ce707c8
|
||||
name: EndToEnd-ADSource
|
||||
owner:
|
||||
id: 2a2fdacca5e345f18bf7970cfbb8fec2
|
||||
name: identity 1
|
||||
type: IDENTITY
|
||||
segments:
|
||||
- 1d126fe0-45e2-4aea-bc64-a07e9344ef26
|
||||
manuallyUpdatedFields:
|
||||
DISPLAY_NAME: true
|
||||
DESCRIPTION: true
|
||||
id: 2c91808c74ff913f0175097daa9d59cd
|
||||
name: LauncherTest1
|
||||
created: '2020-10-08T18:33:52.029Z'
|
||||
modified: '2021-01-19T16:53:35.707Z'
|
||||
'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
|
||||
137
static/api-specs/idn/v2024/paths/ears-entitlement-parents.yaml
Normal file
137
static/api-specs/idn/v2024/paths/ears-entitlement-parents.yaml
Normal file
@@ -0,0 +1,137 @@
|
||||
get:
|
||||
operationId: listEntitlementParents
|
||||
tags:
|
||||
- Entitlements
|
||||
summary: List of entitlements parents
|
||||
description: This API returns a list of all parent entitlements of a given entitlement.
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:entitlement:read
|
||||
- idn:entitlement:manage
|
||||
parameters:
|
||||
- $ref: ../../v3/parameters/limit.yaml
|
||||
- $ref: ../../v3/parameters/offset.yaml
|
||||
- $ref: ../../v3/parameters/count.yaml
|
||||
- in: path
|
||||
name: id
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: Entitlement Id
|
||||
example: 2c91808c74ff913f0175097daa9d59cd
|
||||
- in: query
|
||||
name: sorters
|
||||
schema:
|
||||
type: string
|
||||
format: comma-separated
|
||||
description: 'Sort results using the standard syntax described in [V3 API Standard
|
||||
Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
||||
|
||||
|
||||
Sorting is supported for the following fields: **id, name, created, modified,
|
||||
type, attribute, value, source.id**'
|
||||
example: name,-modified
|
||||
required: false
|
||||
style: form
|
||||
explode: true
|
||||
- in: query
|
||||
name: filters
|
||||
schema:
|
||||
type: string
|
||||
description: 'Filter results using the standard syntax described in [V3 API Standard
|
||||
Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
||||
|
||||
|
||||
Filtering is supported for the following fields and operators:
|
||||
|
||||
|
||||
**id**: *eq, in*
|
||||
|
||||
|
||||
**name**: *eq, in, sw*
|
||||
|
||||
|
||||
**type**: *eq, in*
|
||||
|
||||
|
||||
**attribute**: *eq, in*
|
||||
|
||||
|
||||
**value**: *eq, in, sw*
|
||||
|
||||
|
||||
**source.id**: *eq, in*
|
||||
|
||||
|
||||
**requestable**: *eq*
|
||||
|
||||
|
||||
**created**: *gt, lt, ge, le*
|
||||
|
||||
|
||||
**modified**: *gt, lt, ge, le*'
|
||||
example: attribute eq "memberOf"
|
||||
required: false
|
||||
style: form
|
||||
explode: true
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: List of entitlements parents from an entitlement
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/Entitlement.yaml
|
||||
example:
|
||||
- sourceSchemaObjectType: group
|
||||
attribute: memberOf
|
||||
attributes:
|
||||
GroupType: Security
|
||||
sAMAccountName: LauncherTest1
|
||||
GroupScope: Global
|
||||
objectguid: '{01a6e70b-9705-4155-a5c6-492a9bcc8c64}'
|
||||
objectSid: S-1-5-21-3585869415-1648031554-2909195034-1633
|
||||
cn: LauncherTest1
|
||||
msDS-PrincipalName: AUTOMATIONAD\LauncherTest1
|
||||
value: CN=LauncherTest1,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local
|
||||
description: some description
|
||||
privileged: false
|
||||
cloudGoverned: false
|
||||
source:
|
||||
type: SOURCE
|
||||
id: 2c9180877504c40e0175097d5ce707c8
|
||||
name: EndToEnd-ADSource
|
||||
owner:
|
||||
id: 2a2fdacca5e345f18bf7970cfbb8fec2
|
||||
name: identity 1
|
||||
type: IDENTITY
|
||||
segments:
|
||||
- 1d126fe0-45e2-4aea-bc64-a07e9344ef26
|
||||
manuallyUpdatedFields:
|
||||
DISPLAY_NAME: true
|
||||
DESCRIPTION: true
|
||||
id: 2c91808c74ff913f0175097daa9d59cd
|
||||
name: LauncherTest1
|
||||
created: '2020-10-08T18:33:52.029Z'
|
||||
modified: '2021-01-19T16:53:35.707Z'
|
||||
'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
|
||||
208
static/api-specs/idn/v2024/paths/ears-entitlement.yaml
Normal file
208
static/api-specs/idn/v2024/paths/ears-entitlement.yaml
Normal file
@@ -0,0 +1,208 @@
|
||||
get:
|
||||
operationId: getEntitlement
|
||||
tags:
|
||||
- Entitlements
|
||||
summary: Get an entitlement
|
||||
description: This API returns an entitlement by its ID.
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:entitlement:read
|
||||
- idn:entitlement:manage
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: The entitlement ID
|
||||
example: 2c91808874ff91550175097daaec161c
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: An entitlement
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/Entitlement.yaml
|
||||
example:
|
||||
sourceSchemaObjectType: group
|
||||
attribute: memberOf
|
||||
attributes:
|
||||
GroupType: Security
|
||||
sAMAccountName: LauncherTest1
|
||||
GroupScope: Global
|
||||
objectguid: '{01a6e70b-9705-4155-a5c6-492a9bcc8c64}'
|
||||
objectSid: S-1-5-21-3585869415-1648031554-2909195034-1633
|
||||
cn: LauncherTest1
|
||||
msDS-PrincipalName: AUTOMATIONAD\LauncherTest1
|
||||
value: CN=LauncherTest1,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local
|
||||
description: some description
|
||||
privileged: false
|
||||
cloudGoverned: false
|
||||
source:
|
||||
type: SOURCE
|
||||
id: 2c9180877504c40e0175097d5ce707c8
|
||||
name: EndToEnd-ADSource
|
||||
owner:
|
||||
id: 2c9180858315595501831958427e5424
|
||||
name: Addie Smith
|
||||
type: IDENTITY
|
||||
segments:
|
||||
- 1d126fe0-45e2-4aea-bc64-a07e9344ef26
|
||||
manuallyUpdatedFields:
|
||||
DISPLAY_NAME: true
|
||||
DESCRIPTION: true
|
||||
id: 2c91808c74ff913f0175097daa9d59cd
|
||||
name: LauncherTest1
|
||||
created: '2020-10-08T18:33:52.029Z'
|
||||
modified: '2021-01-19T16:53:35.707Z'
|
||||
'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
|
||||
patch:
|
||||
operationId: patchEntitlement
|
||||
tags:
|
||||
- Entitlements
|
||||
summary: Patch an entitlement
|
||||
description: 'This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902)
|
||||
syntax.
|
||||
|
||||
|
||||
The following fields are patchable: **requestable**, **privileged**, **segments**,
|
||||
**owner**, **name**, **description**, and **manuallyUpdatedFields**
|
||||
|
||||
|
||||
When you''re patching owner, only owner type and owner id must be provided. Owner
|
||||
name is optional, and it won''t be modified. If the owner name is provided, it
|
||||
should correspond to the real name. The only owner type currently supported is
|
||||
IDENTITY.
|
||||
|
||||
|
||||
A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API.'
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:entitlement:manage
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: ID of the entitlement to patch
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
example: 2c91808a7813090a017814121e121518
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
requestBody:
|
||||
content:
|
||||
application/json-patch+json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/JsonPatchOperation.yaml
|
||||
example:
|
||||
- op: replace
|
||||
path: /requestable
|
||||
value: true
|
||||
examples:
|
||||
Make an entitlement requestable and privileged in one call:
|
||||
description: This example shows how multiple fields may be updated with
|
||||
a single patch call.
|
||||
value:
|
||||
- op: replace
|
||||
path: /requestable
|
||||
value: true
|
||||
- op: replace
|
||||
path: /privileged
|
||||
value: true
|
||||
Assign an entitlement to a segment:
|
||||
description: This example shows how to use patch to assign an entitlement
|
||||
to a segment by adding the segment's ID to the entitlement's segments
|
||||
array.
|
||||
value:
|
||||
- op: add
|
||||
path: /segments/-
|
||||
value: f7b1b8a3-5fed-4fd4-ad29-82014e137e19
|
||||
Assign an owner to an entitlement:
|
||||
description: This example shows how to use patch to assign an owner to
|
||||
an entitlement by adding the owner's info to the entitlement.
|
||||
value:
|
||||
- op: add
|
||||
path: /owner
|
||||
value:
|
||||
type: IDENTITY
|
||||
id: 2c9180858315595501831958427e5424
|
||||
Replace an owner for an entitlement:
|
||||
description: This example shows how to use patch to replace an entitlement's
|
||||
owner by replacing the owner's info to the entitlement.
|
||||
value:
|
||||
- op: replace
|
||||
path: /owner
|
||||
value:
|
||||
type: IDENTITY
|
||||
id: 2c9180858315595501831958427e5424
|
||||
Set entitlement manually updated fields:
|
||||
description: 'This example shows how to set an entitlement''s manually
|
||||
updated fields values with patch request. Values for all manually updateable
|
||||
fields must be specified in the request. For now only two entitlement
|
||||
fields support this: DISPLAY_NAME and DESCRIPTION.'
|
||||
value:
|
||||
- op: replace
|
||||
path: /manuallyUpdatedFields
|
||||
value:
|
||||
DISPLAY_NAME: true
|
||||
DESCRIPTION: true
|
||||
Add the description for an entitlement:
|
||||
description: This example shows how to use patch to add a description
|
||||
for the entitlement.
|
||||
value:
|
||||
- op: add
|
||||
path: /description
|
||||
value: new description for the entitlement
|
||||
Update the name for an entitlement:
|
||||
description: This example shows how to use patch to update an entitlement's
|
||||
name.
|
||||
value:
|
||||
- op: replace
|
||||
path: /name
|
||||
value: entitlement new name
|
||||
responses:
|
||||
'200':
|
||||
description: Responds with the entitlement as updated.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/Entitlement.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
|
||||
@@ -0,0 +1,108 @@
|
||||
post:
|
||||
summary: Add metadata to an entitlement.
|
||||
description: Add single Access Model Metadata to an entitlement.
|
||||
tags:
|
||||
- Entitlements
|
||||
operationId: createAccessModelMetadataForEntitlement
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:entitlement:update
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: The entitlement id.
|
||||
example: 2c91808c74ff913f0175097daa9d59cd
|
||||
- name: attributeKey
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Technical name of the Attribute.
|
||||
example: iscPrivacy
|
||||
- name: attributeValue
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Technical name of the Attribute Value.
|
||||
example: public
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/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
|
||||
delete:
|
||||
summary: Remove metadata from an entitlement.
|
||||
description: Remove single Access Model Metadata from an entitlement.
|
||||
tags:
|
||||
- Entitlements
|
||||
operationId: deleteAccessModelMetadataFromEntitlement
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:entitlement:delete
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: The entitlement id.
|
||||
example: 2c91808c74ff913f0175097daa9d59cd
|
||||
- name: attributeKey
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Technical name of the Attribute.
|
||||
example: iscPrivacy
|
||||
- name: attributeValue
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Technical name of the Attribute Value.
|
||||
example: public
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
'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
|
||||
121
static/api-specs/idn/v2024/paths/entitlement-request-config.yaml
Normal file
121
static/api-specs/idn/v2024/paths/entitlement-request-config.yaml
Normal file
@@ -0,0 +1,121 @@
|
||||
get:
|
||||
operationId: getEntitlementRequestConfig
|
||||
tags:
|
||||
- Entitlements
|
||||
summary: Get Entitlement Request Config
|
||||
description: This API returns the entitlement request config for a specified entitlement.
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:entitlement:read
|
||||
- idn:entitlement:manage
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: Entitlement Id
|
||||
example: 2c91808874ff91550175097daaec161c
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: An Entitlement Request Config
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/EntitlementRequestConfig.yaml
|
||||
example:
|
||||
accessRequestConfig:
|
||||
requestCommentRequired: true
|
||||
denialCommentRequired: true
|
||||
approvalSchemes:
|
||||
- approverType: ENTITLEMENT_OWNER
|
||||
approverId: null
|
||||
- approverType: SOURCE_OWNER
|
||||
approverId: null
|
||||
- approverType: MANAGER
|
||||
approverId: null
|
||||
- approverType: GOVERNANCE_GROUP
|
||||
approverId: 46c79819-a69f-49a2-becb-12c971ae66c6
|
||||
'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
|
||||
put:
|
||||
operationId: putEntitlementRequestConfig
|
||||
tags:
|
||||
- Entitlements
|
||||
summary: Replace Entitlement Request Config
|
||||
description: This API replaces the entitlement request config for a specified entitlement.
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:entitlement:manage
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: Entitlement ID
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
example: 2c91808a7813090a017814121e121518
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/EntitlementRequestConfig.yaml
|
||||
responses:
|
||||
'200':
|
||||
description: Responds with the entitlement request config as updated.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/EntitlementRequestConfig.yaml
|
||||
example:
|
||||
accessRequestConfig:
|
||||
requestCommentRequired: true
|
||||
denialCommentRequired: true
|
||||
approvalSchemes:
|
||||
- approverType: ENTITLEMENT_OWNER
|
||||
approverId: null
|
||||
- approverType: SOURCE_OWNER
|
||||
approverId: null
|
||||
- approverType: MANAGER
|
||||
approverId: null
|
||||
- approverType: GOVERNANCE_GROUP
|
||||
approverId: 46c79819-a69f-49a2-becb-12c971ae66c6
|
||||
'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
|
||||
150
static/api-specs/idn/v2024/paths/entitlements.yaml
Normal file
150
static/api-specs/idn/v2024/paths/entitlements.yaml
Normal file
@@ -0,0 +1,150 @@
|
||||
get:
|
||||
operationId: listEntitlements
|
||||
tags:
|
||||
- Entitlements
|
||||
summary: Gets a list of entitlements.
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:entitlement:read
|
||||
- idn:entitlement:manage
|
||||
description: 'This API returns a list of entitlements.
|
||||
|
||||
|
||||
This API can be used in one of the two following ways: either getting entitlements
|
||||
for a specific **account-id**, or getting via use of **filters** (those two options
|
||||
are exclusive).
|
||||
|
||||
|
||||
Any authenticated token can call this API.'
|
||||
parameters:
|
||||
- in: query
|
||||
name: account-id
|
||||
schema:
|
||||
type: string
|
||||
description: The account ID. If specified, returns only entitlements associated
|
||||
with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**,
|
||||
**for-segment-ids**, or **include-unsegmented** param(s).
|
||||
example: ef38f94347e94562b5bb8424a56397d8
|
||||
required: false
|
||||
- in: query
|
||||
name: segmented-for-identity
|
||||
schema:
|
||||
type: string
|
||||
description: 'If present and not empty, additionally filters Entitlements to those
|
||||
which are assigned to the Segment(s) which are visible to the Identity with
|
||||
the specified ID. By convention, the value **me** can stand in for the current
|
||||
user''s Identity ID.
|
||||
|
||||
Cannot be specified with the **account-id** or **for-segment-ids** param(s).
|
||||
It is also illegal to specify a value that refers to a different user''s Identity.'
|
||||
example: me
|
||||
required: false
|
||||
- in: query
|
||||
name: for-segment-ids
|
||||
schema:
|
||||
type: string
|
||||
format: comma-separated
|
||||
description: 'If present and not empty, additionally filters Access Profiles to
|
||||
those which are assigned to the Segment(s) with the specified IDs.
|
||||
|
||||
Cannot be specified with the **account-id** or **segmented-for-identity** param(s).'
|
||||
example: 041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649
|
||||
required: false
|
||||
- in: query
|
||||
name: include-unsegmented
|
||||
schema:
|
||||
type: boolean
|
||||
default: true
|
||||
description: Whether or not the response list should contain unsegmented Entitlements.
|
||||
If **for-segment-ids** and **segmented-for-identity** are both absent or empty,
|
||||
specifying **include-unsegmented=false** results in an error.
|
||||
example: true
|
||||
required: false
|
||||
- $ref: ../../v3/parameters/offset.yaml
|
||||
- $ref: ../../v3/parameters/limit.yaml
|
||||
- $ref: ../../v3/parameters/count.yaml
|
||||
- in: query
|
||||
name: sorters
|
||||
schema:
|
||||
type: string
|
||||
format: comma-separated
|
||||
description: 'Sort results using the standard syntax described in [V3 API Standard
|
||||
Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
||||
|
||||
|
||||
Sorting is supported for the following fields: **id, name, created, modified,
|
||||
type, attribute, value, source.id, requestable**'
|
||||
example: name,-modified
|
||||
required: false
|
||||
style: form
|
||||
explode: true
|
||||
- in: query
|
||||
name: filters
|
||||
schema:
|
||||
type: string
|
||||
description: 'Filter results using the standard syntax described in [V3 API Standard
|
||||
Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
||||
|
||||
|
||||
Filtering is supported for the following fields and operators:
|
||||
|
||||
|
||||
**id**: *eq, in*
|
||||
|
||||
|
||||
**name**: *eq, in, sw*
|
||||
|
||||
|
||||
**type**: *eq, in*
|
||||
|
||||
|
||||
**attribute**: *eq, in*
|
||||
|
||||
|
||||
**value**: *eq, in, sw*
|
||||
|
||||
|
||||
**source.id**: *eq, in*
|
||||
|
||||
|
||||
**requestable**: *eq*
|
||||
|
||||
|
||||
**created**: *gt, lt, ge, le*
|
||||
|
||||
|
||||
**modified**: *gt, lt, ge, le*
|
||||
|
||||
|
||||
**owner.id**: *eq, in*'
|
||||
example: attribute eq "memberOf"
|
||||
required: false
|
||||
style: form
|
||||
explode: true
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: List of entitlements
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/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
|
||||
@@ -0,0 +1,211 @@
|
||||
post:
|
||||
tags:
|
||||
- Custom Forms
|
||||
summary: Preview form definition data source.
|
||||
operationId: showPreviewDataSource
|
||||
parameters:
|
||||
- name: formDefinitionID
|
||||
in: path
|
||||
description: Form definition ID
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
x-go-name: FormDefinitionID
|
||||
example: 00000000-0000-0000-0000-000000000000
|
||||
x-go-name: FormDefinitionID
|
||||
- name: limit
|
||||
in: query
|
||||
description: 'Limit
|
||||
|
||||
|
||||
Integer specifying the maximum number of records to return in a single API call.
|
||||
The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).
|
||||
|
||||
If it is not specified, a default limit is used.'
|
||||
schema:
|
||||
type: integer
|
||||
format: int64
|
||||
maxLength: 250
|
||||
minLength: 0
|
||||
default: 10
|
||||
x-go-name: Limit
|
||||
example: 10
|
||||
required: false
|
||||
x-go-name: Limit
|
||||
- name: filters
|
||||
in: query
|
||||
description: 'Filter results using the standard syntax described in [V3 API Standard
|
||||
Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
||||
|
||||
|
||||
Filtering is supported for the following fields and operators:
|
||||
|
||||
|
||||
**value**: *eq, ne, in*
|
||||
|
||||
|
||||
Supported composite operators: *not*
|
||||
|
||||
|
||||
Only a single *not* may be used, and it can only be used with the `in` operator.
|
||||
The `not` composite operator must be used in front of the field. For example,
|
||||
the following is valid: `not value in ("ID01")`'
|
||||
schema:
|
||||
type: string
|
||||
x-go-name: Filters
|
||||
example: value eq "ID01"
|
||||
required: false
|
||||
x-go-name: Filters
|
||||
- name: query
|
||||
in: query
|
||||
description: String that is passed to the underlying API to filter other (non-ID)
|
||||
fields. For example, for access profile data sources, this string will be
|
||||
passed to the access profile api and used with a "starts with" filter against several
|
||||
fields.
|
||||
schema:
|
||||
type: string
|
||||
x-go-name: Query
|
||||
example: ac
|
||||
required: false
|
||||
x-go-name: Query
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
requestBody:
|
||||
description: Body is the request payload to create a form definition dynamic schema
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/FormElementPreviewRequest.yaml
|
||||
required: false
|
||||
responses:
|
||||
'200':
|
||||
description: Returns a preview of a form definition data source
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/PreviewDataSourceResponse.yaml
|
||||
'400':
|
||||
description: An error with the request occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'401':
|
||||
description: An error with the authorization occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'403':
|
||||
description: An error with the user permissions occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'404':
|
||||
description: An error with the item not found
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'429':
|
||||
description: Too many requests
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/Error.yaml
|
||||
'500':
|
||||
description: An internal server error occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- sp:forms:manage
|
||||
543
static/api-specs/idn/v2024/paths/form-definition-file.yaml
Normal file
543
static/api-specs/idn/v2024/paths/form-definition-file.yaml
Normal file
@@ -0,0 +1,543 @@
|
||||
get:
|
||||
tags:
|
||||
- Custom Forms
|
||||
summary: Download definition file by fileId.
|
||||
operationId: getFileFromS3
|
||||
parameters:
|
||||
- name: formDefinitionID
|
||||
in: path
|
||||
description: 'FormDefinitionID
|
||||
|
||||
|
||||
Form definition ID'
|
||||
required: true
|
||||
example: 00000000-0000-0000-0000-000000000000
|
||||
schema:
|
||||
type: string
|
||||
x-go-name: FormDefinitionID
|
||||
x-go-name: FormDefinitionID
|
||||
- name: fileID
|
||||
in: path
|
||||
description: 'FileID
|
||||
|
||||
|
||||
String specifying the hashed name of the uploaded file we are retrieving.'
|
||||
required: true
|
||||
example: 00000031N0J7R2B57M8YG73J7M.png
|
||||
schema:
|
||||
type: string
|
||||
x-go-name: FileID
|
||||
x-go-name: FileID
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: Returns a file that is referred to by fileID and associated with
|
||||
the formDefinitionID
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: string
|
||||
format: binary
|
||||
image/jpeg:
|
||||
schema:
|
||||
type: string
|
||||
format: binary
|
||||
image/png:
|
||||
schema:
|
||||
type: string
|
||||
format: binary
|
||||
application/octet-stream:
|
||||
schema:
|
||||
type: string
|
||||
format: binary
|
||||
'400':
|
||||
description: An error with the request occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
image/jpeg:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
image/png:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
application/octet-stream:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'401':
|
||||
description: An error with the authorization occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
image/jpeg:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
image/png:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
application/octet-stream:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'403':
|
||||
description: An error with the user permissions occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
image/jpeg:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
image/png:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
application/octet-stream:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'404':
|
||||
description: An error with the item not found
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
image/jpeg:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
image/png:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
application/octet-stream:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'429':
|
||||
description: Too many requests
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/Error.yaml
|
||||
'500':
|
||||
description: An internal server error occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
image/jpeg:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
image/png:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
application/octet-stream:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'503':
|
||||
description: An external service is not available
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
image/jpeg:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
image/png:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
application/octet-stream:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- sp:forms:manage
|
||||
x-codegen-request-body-name: Body
|
||||
237
static/api-specs/idn/v2024/paths/form-definition-files.yaml
Normal file
237
static/api-specs/idn/v2024/paths/form-definition-files.yaml
Normal file
@@ -0,0 +1,237 @@
|
||||
post:
|
||||
tags:
|
||||
- Custom Forms
|
||||
summary: Upload new form definition file.
|
||||
description: Parameter `{formDefinitionID}` should match a form definition ID.
|
||||
operationId: createFormDefinitionFileRequest
|
||||
parameters:
|
||||
- name: formDefinitionID
|
||||
in: path
|
||||
description: 'FormDefinitionID
|
||||
|
||||
|
||||
String specifying FormDefinitionID'
|
||||
required: true
|
||||
example: 00000000-0000-0000-0000-000000000000
|
||||
schema:
|
||||
type: string
|
||||
x-go-name: FormDefinitionID
|
||||
x-go-name: FormDefinitionID
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
requestBody:
|
||||
content:
|
||||
multipart/form-data:
|
||||
schema:
|
||||
type: object
|
||||
required:
|
||||
- file
|
||||
properties:
|
||||
file:
|
||||
type: string
|
||||
description: File specifying the multipart
|
||||
format: binary
|
||||
x-go-name: File
|
||||
encoding:
|
||||
file:
|
||||
contentType: image/png, image/jpeg
|
||||
required: true
|
||||
responses:
|
||||
'201':
|
||||
description: Returns a new form definition file
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/FormDefinitionFileUploadResponse.yaml
|
||||
'400':
|
||||
description: An error with the request occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'401':
|
||||
description: An error with the authorization occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'403':
|
||||
description: An error with the user permissions occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'404':
|
||||
description: An error with the item not found
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'413':
|
||||
description: An error with payload size too large
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'415':
|
||||
description: An error with unsupported media type
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'429':
|
||||
description: Too many requests
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/Error.yaml
|
||||
'500':
|
||||
description: An internal server error occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'503':
|
||||
description: An external service is not available
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- sp:forms:manage
|
||||
x-codegen-request-body-name: Body
|
||||
@@ -0,0 +1,155 @@
|
||||
post:
|
||||
tags:
|
||||
- Custom Forms
|
||||
summary: Generate JSON Schema dynamically.
|
||||
operationId: createFormDefinitionDynamicSchema
|
||||
requestBody:
|
||||
description: Body is the request payload to create a form definition dynamic schema
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/FormDefinitionDynamicSchemaRequest.yaml
|
||||
example:
|
||||
id: sp:forms
|
||||
attributes:
|
||||
formDefinitionId: 00000000-0000-0000-0000-000000000000
|
||||
description: AnotherDescription
|
||||
type: action
|
||||
versionNumber: 1
|
||||
required: false
|
||||
responses:
|
||||
'200':
|
||||
description: Returns a form elements dynamic schema
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/FormDefinitionDynamicSchemaResponse.yaml
|
||||
'400':
|
||||
description: An error with the request occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'401':
|
||||
description: An error with the authorization occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'403':
|
||||
description: An error with the user permissions occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'404':
|
||||
description: An error with the item not found
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'429':
|
||||
description: Too many requests
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/Error.yaml
|
||||
'500':
|
||||
description: An internal server error occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- sp:forms:manage
|
||||
x-codegen-request-body-name: Body
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
462
static/api-specs/idn/v2024/paths/form-definition.yaml
Normal file
462
static/api-specs/idn/v2024/paths/form-definition.yaml
Normal file
@@ -0,0 +1,462 @@
|
||||
get:
|
||||
tags:
|
||||
- Custom Forms
|
||||
summary: Return a form definition.
|
||||
description: Parameter `{formDefinitionID}` should match a form definition ID.
|
||||
operationId: getFormDefinitionByKey
|
||||
parameters:
|
||||
- name: formDefinitionID
|
||||
in: path
|
||||
description: Form definition ID
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
x-go-name: FormDefinitionID
|
||||
example: 00000000-0000-0000-0000-000000000000
|
||||
x-go-name: FormDefinitionID
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: Returns a form definition
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/FormDefinitionResponse.yaml
|
||||
'400':
|
||||
description: An error with the request occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'401':
|
||||
description: An error with the authorization occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'403':
|
||||
description: An error with the user permissions occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'404':
|
||||
description: An error with the item not found
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'429':
|
||||
description: Too many requests
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/Error.yaml
|
||||
'500':
|
||||
description: An internal server error occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- sp:forms:manage
|
||||
delete:
|
||||
tags:
|
||||
- Custom Forms
|
||||
summary: Deletes a form definition.
|
||||
description: Parameter `{formDefinitionID}` should match a form definition ID.
|
||||
operationId: deleteFormDefinition
|
||||
parameters:
|
||||
- name: formDefinitionID
|
||||
in: path
|
||||
description: Form definition ID
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
x-go-name: FormDefinitionID
|
||||
example: 00000000-0000-0000-0000-000000000000
|
||||
x-go-name: FormDefinitionID
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'204':
|
||||
description: Returns an empty body
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/Nil.yaml
|
||||
'400':
|
||||
description: An error with the request occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'401':
|
||||
description: An error with the authorization occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'403':
|
||||
description: An error with the user permissions occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'404':
|
||||
description: An error with the item not found
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'429':
|
||||
description: Too many requests
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/Error.yaml
|
||||
'500':
|
||||
description: An internal server error occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- sp:forms:manage
|
||||
patch:
|
||||
tags:
|
||||
- Custom Forms
|
||||
summary: Patch a form definition.
|
||||
description: Parameter `{formDefinitionID}` should match a form definition ID.
|
||||
operationId: patchFormDefinition
|
||||
parameters:
|
||||
- name: formDefinitionID
|
||||
in: path
|
||||
description: Form definition ID
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
x-go-name: FormDefinitionID
|
||||
example: 00000000-0000-0000-0000-000000000000
|
||||
x-go-name: FormDefinitionID
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
requestBody:
|
||||
description: 'Body is the request payload to patch a form definition, check: https://jsonpatch.com'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/Patch.yaml
|
||||
example:
|
||||
- op: replace
|
||||
path: /description
|
||||
value: test-description
|
||||
required: false
|
||||
responses:
|
||||
'200':
|
||||
description: Returns the form definition updated
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/FormDefinitionResponse.yaml
|
||||
'400':
|
||||
description: An error with the request occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'401':
|
||||
description: An error with the authorization occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'403':
|
||||
description: An error with the user permissions occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'404':
|
||||
description: An error with the user permissions occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'429':
|
||||
description: Too many requests
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/Error.yaml
|
||||
'500':
|
||||
description: An internal server error occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- sp:forms:manage
|
||||
x-codegen-request-body-name: Body
|
||||
207
static/api-specs/idn/v2024/paths/form-definitions-export.yaml
Normal file
207
static/api-specs/idn/v2024/paths/form-definitions-export.yaml
Normal file
@@ -0,0 +1,207 @@
|
||||
get:
|
||||
tags:
|
||||
- Custom Forms
|
||||
summary: List form definitions by tenant.
|
||||
description: No parameters required.
|
||||
operationId: exportFormDefinitionsByTenant
|
||||
parameters:
|
||||
- name: offset
|
||||
in: query
|
||||
description: 'Offset
|
||||
|
||||
|
||||
Integer specifying the offset of the first result from the beginning of the
|
||||
collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).
|
||||
|
||||
The offset value is record-based, not page-based, and the index starts at 0.'
|
||||
schema:
|
||||
type: integer
|
||||
format: int64
|
||||
default: 0
|
||||
x-go-name: Offset
|
||||
example: 0
|
||||
required: false
|
||||
x-go-name: Offset
|
||||
- name: limit
|
||||
in: query
|
||||
description: 'Limit
|
||||
|
||||
|
||||
Integer specifying the maximum number of records to return in a single API call.
|
||||
The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).
|
||||
|
||||
If it is not specified, a default limit is used.'
|
||||
schema:
|
||||
type: integer
|
||||
format: int64
|
||||
maxLength: 250
|
||||
minLength: 0
|
||||
default: 250
|
||||
x-go-name: Limit
|
||||
example: 250
|
||||
required: false
|
||||
x-go-name: Limit
|
||||
- name: filters
|
||||
in: query
|
||||
description: 'Filter results using the standard syntax described in [V3 API Standard
|
||||
Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
||||
|
||||
|
||||
Filtering is supported for the following fields and operators:
|
||||
|
||||
|
||||
**name**: *eq, gt, sw, in*
|
||||
|
||||
|
||||
**description**: *eq, gt, sw, in*
|
||||
|
||||
|
||||
**created**: *eq, gt, sw, in*
|
||||
|
||||
|
||||
**modified**: *eq, gt, sw, in*'
|
||||
schema:
|
||||
type: string
|
||||
x-go-name: Filters
|
||||
example: name sw "my form"
|
||||
required: false
|
||||
x-go-name: Filters
|
||||
- name: sorters
|
||||
in: query
|
||||
description: 'Sort results using the standard syntax described in [V3 API Standard
|
||||
Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
||||
|
||||
|
||||
Sorting is supported for the following fields: **name, description, created,
|
||||
modified**'
|
||||
schema:
|
||||
type: string
|
||||
default: name
|
||||
x-go-name: Sorters
|
||||
example: name
|
||||
required: false
|
||||
x-go-name: Sorters
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: Returns a list of form definition objects by tenant used by SP-Config
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
object:
|
||||
$ref: ../../beta/schemas/forms/FormDefinitionResponse.yaml
|
||||
self:
|
||||
type: string
|
||||
x-go-name: Self
|
||||
version:
|
||||
type: integer
|
||||
format: int8
|
||||
x-go-name: Version
|
||||
'400':
|
||||
description: An error with the request occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'401':
|
||||
description: An error with the authorization occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'403':
|
||||
description: An error with the user permissions occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'429':
|
||||
description: Too many requests
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/Error.yaml
|
||||
'500':
|
||||
description: An internal server error occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- sp:forms:manage
|
||||
258
static/api-specs/idn/v2024/paths/form-definitions-import.yaml
Normal file
258
static/api-specs/idn/v2024/paths/form-definitions-import.yaml
Normal file
@@ -0,0 +1,258 @@
|
||||
post:
|
||||
tags:
|
||||
- Custom Forms
|
||||
summary: Import form definitions from export.
|
||||
operationId: importFormDefinitions
|
||||
requestBody:
|
||||
description: Body is the request payload to import form definitions
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
object:
|
||||
$ref: ../../beta/schemas/forms/FormDefinitionResponse.yaml
|
||||
self:
|
||||
type: string
|
||||
x-go-name: Self
|
||||
version:
|
||||
type: integer
|
||||
format: int8
|
||||
x-go-name: Version
|
||||
example:
|
||||
- version: 1
|
||||
self:
|
||||
name: All fields not required
|
||||
id: 05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa
|
||||
type: FORM_DEFINITION
|
||||
object:
|
||||
id: 05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa
|
||||
name: All fields not required
|
||||
description: description
|
||||
owner:
|
||||
type: IDENTITY
|
||||
id: 3447d8ec2602455ab6f1e8408a0f0150
|
||||
usedBy:
|
||||
- type: WORKFLOW
|
||||
id: 5008594c-dacc-4295-8fee-41df60477304
|
||||
- type: WORKFLOW
|
||||
id: 97e75a75-c179-4fbc-a2da-b5fa4aaa8743
|
||||
formInput:
|
||||
- type: STRING
|
||||
label: input1
|
||||
description: A single dynamic scalar value (i.e. number, string, date,
|
||||
etc) that can be passed into the form for use in conditional logic
|
||||
formElements:
|
||||
- id: '3069272797630701'
|
||||
elementType: SECTION
|
||||
config:
|
||||
label: First Section
|
||||
formElements:
|
||||
- id: '3069272797630700'
|
||||
elementType: TEXT
|
||||
key: firstName
|
||||
config:
|
||||
label: First Name
|
||||
- id: '3498415402897539'
|
||||
elementType: TEXT
|
||||
key: lastName
|
||||
config:
|
||||
label: Last Name
|
||||
formConditions:
|
||||
- ruleOperator: AND
|
||||
rules:
|
||||
- sourceType: INPUT
|
||||
source: Department
|
||||
operator: EQ
|
||||
valueType: STRING
|
||||
value: Sales
|
||||
effects:
|
||||
- effectType: HIDE
|
||||
config:
|
||||
element: '2614088730489570'
|
||||
created: '2022-10-04T19:27:04.456Z'
|
||||
modified: '2022-11-16T20:45:02.172Z'
|
||||
required: false
|
||||
responses:
|
||||
'202':
|
||||
description: Returns statuses of those form definition objects imported
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
errors:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
detail:
|
||||
type: object
|
||||
additionalProperties:
|
||||
type: object
|
||||
x-go-name: Detail
|
||||
key:
|
||||
type: string
|
||||
x-go-name: Key
|
||||
text:
|
||||
type: string
|
||||
x-go-name: Text
|
||||
x-go-name: Errors
|
||||
importedObjects:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
object:
|
||||
$ref: ../../beta/schemas/forms/FormDefinitionResponse.yaml
|
||||
self:
|
||||
type: string
|
||||
x-go-name: Self
|
||||
version:
|
||||
type: integer
|
||||
format: int8
|
||||
x-go-name: Version
|
||||
x-go-name: ImportedObjects
|
||||
infos:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
detail:
|
||||
type: object
|
||||
additionalProperties:
|
||||
type: object
|
||||
x-go-name: Detail
|
||||
key:
|
||||
type: string
|
||||
x-go-name: Key
|
||||
text:
|
||||
type: string
|
||||
x-go-name: Text
|
||||
x-go-name: Infos
|
||||
warnings:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
detail:
|
||||
type: object
|
||||
additionalProperties:
|
||||
type: object
|
||||
x-go-name: Detail
|
||||
key:
|
||||
type: string
|
||||
x-go-name: Key
|
||||
text:
|
||||
type: string
|
||||
x-go-name: Text
|
||||
x-go-name: Warnings
|
||||
'400':
|
||||
description: An error with the request occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'401':
|
||||
description: An error with the authorization occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'403':
|
||||
description: An error with the user permissions occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'429':
|
||||
description: Too many requests
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/Error.yaml
|
||||
'500':
|
||||
description: An internal server error occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- sp:forms:manage
|
||||
x-codegen-request-body-name: Body
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
@@ -0,0 +1,119 @@
|
||||
get:
|
||||
tags:
|
||||
- Custom Forms
|
||||
summary: List predefined select options.
|
||||
description: No parameters required.
|
||||
operationId: searchPreDefinedSelectOptions
|
||||
responses:
|
||||
'200':
|
||||
description: Returns a list of available predefined select options
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/ListPredefinedSelectOptionsResponse.yaml
|
||||
'400':
|
||||
description: An error with the request occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'401':
|
||||
description: An error with the authorization occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'403':
|
||||
description: An error with the user permissions occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'429':
|
||||
description: Too many requests
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/Error.yaml
|
||||
'500':
|
||||
description: An internal server error occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- sp:forms:manage
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
327
static/api-specs/idn/v2024/paths/form-definitions.yaml
Normal file
327
static/api-specs/idn/v2024/paths/form-definitions.yaml
Normal file
@@ -0,0 +1,327 @@
|
||||
get:
|
||||
tags:
|
||||
- Custom Forms
|
||||
summary: Export form definitions by tenant.
|
||||
description: No parameters required.
|
||||
operationId: searchFormDefinitionsByTenant
|
||||
parameters:
|
||||
- name: offset
|
||||
in: query
|
||||
description: 'Offset
|
||||
|
||||
|
||||
Integer specifying the offset of the first result from the beginning of the
|
||||
collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).
|
||||
|
||||
The offset value is record-based, not page-based, and the index starts at 0.'
|
||||
schema:
|
||||
type: integer
|
||||
format: int64
|
||||
default: 0
|
||||
x-go-name: Offset
|
||||
example: 250
|
||||
required: false
|
||||
x-go-name: Offset
|
||||
- name: limit
|
||||
in: query
|
||||
description: 'Limit
|
||||
|
||||
|
||||
Integer specifying the maximum number of records to return in a single API call.
|
||||
The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).
|
||||
|
||||
If it is not specified, a default limit is used.'
|
||||
schema:
|
||||
type: integer
|
||||
format: int64
|
||||
maxLength: 250
|
||||
minLength: 0
|
||||
default: 250
|
||||
x-go-name: Limit
|
||||
example: 250
|
||||
required: false
|
||||
x-go-name: Limit
|
||||
- name: filters
|
||||
in: query
|
||||
description: 'Filter results using the standard syntax described in [V3 API Standard
|
||||
Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
||||
|
||||
|
||||
Filtering is supported for the following fields and operators:
|
||||
|
||||
|
||||
**name**: *eq, gt, sw, in*
|
||||
|
||||
|
||||
**description**: *eq, gt, sw, in*
|
||||
|
||||
|
||||
**created**: *eq, gt, sw, in*
|
||||
|
||||
|
||||
**modified**: *eq, gt, sw, in*'
|
||||
schema:
|
||||
type: string
|
||||
x-go-name: Filters
|
||||
example: name sw "my form"
|
||||
required: false
|
||||
x-go-name: Filters
|
||||
- name: sorters
|
||||
in: query
|
||||
description: 'Sort results using the standard syntax described in [V3 API Standard
|
||||
Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
||||
|
||||
|
||||
Sorting is supported for the following fields: **name, description, created,
|
||||
modified**'
|
||||
schema:
|
||||
type: string
|
||||
default: name
|
||||
x-go-name: Sorters
|
||||
example: name
|
||||
required: false
|
||||
x-go-name: Sorters
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: Returns a list of form definitions by tenant
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/ListFormDefinitionsByTenantResponse.yaml
|
||||
'400':
|
||||
description: An error with the request occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'401':
|
||||
description: An error with the authorization occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'403':
|
||||
description: An error with the user permissions occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'429':
|
||||
description: Too many requests
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/Error.yaml
|
||||
'500':
|
||||
description: An internal server error occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- sp:forms:manage
|
||||
post:
|
||||
tags:
|
||||
- Custom Forms
|
||||
summary: Creates a form definition.
|
||||
operationId: createFormDefinition
|
||||
requestBody:
|
||||
description: Body is the request payload to create form definition request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/CreateFormDefinitionRequest.yaml
|
||||
example:
|
||||
name: my form
|
||||
description: my form description
|
||||
owner:
|
||||
type: IDENTITY
|
||||
id: 00000000-0000-0000-0000-000000000000
|
||||
required: false
|
||||
responses:
|
||||
'201':
|
||||
description: Returns a new form definition
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/FormDefinitionResponse.yaml
|
||||
'400':
|
||||
description: An error with the request occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'401':
|
||||
description: An error with the authorization occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'403':
|
||||
description: An error with the user permissions occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'429':
|
||||
description: Too many requests
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/Error.yaml
|
||||
'500':
|
||||
description: An internal server error occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- sp:forms:manage
|
||||
x-codegen-request-body-name: Body
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
217
static/api-specs/idn/v2024/paths/form-instance-data-source.yaml
Normal file
217
static/api-specs/idn/v2024/paths/form-instance-data-source.yaml
Normal file
@@ -0,0 +1,217 @@
|
||||
get:
|
||||
tags:
|
||||
- Custom Forms
|
||||
summary: Retrieves dynamic data by element.
|
||||
description: 'Parameter `{formInstanceID}` should match a form instance ID.
|
||||
|
||||
Parameter `{formElementID}` should match a form element ID at the data source
|
||||
configuration.'
|
||||
operationId: searchFormElementDataByElementID
|
||||
parameters:
|
||||
- name: formInstanceID
|
||||
in: path
|
||||
description: Form instance ID
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
x-go-name: FormInstanceID
|
||||
example: 00000000-0000-0000-0000-000000000000
|
||||
x-go-name: FormInstanceID
|
||||
- name: formElementID
|
||||
in: path
|
||||
description: Form element ID
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
x-go-name: FormElementID
|
||||
example: 1
|
||||
x-go-name: FormElementID
|
||||
- name: limit
|
||||
in: query
|
||||
description: 'Limit
|
||||
|
||||
|
||||
Integer specifying the maximum number of records to return in a single API call.
|
||||
The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).
|
||||
|
||||
If it is not specified, a default limit is used.'
|
||||
schema:
|
||||
type: integer
|
||||
format: int64
|
||||
maxLength: 250
|
||||
minLength: 0
|
||||
default: 250
|
||||
x-go-name: Limit
|
||||
example: 250
|
||||
required: false
|
||||
x-go-name: Limit
|
||||
- name: filters
|
||||
in: query
|
||||
description: 'Filter results using the standard syntax described in [V3 API Standard
|
||||
Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
||||
|
||||
|
||||
Filtering is supported for the following fields and operators:
|
||||
|
||||
|
||||
**value**: *eq, ne, in*
|
||||
|
||||
|
||||
Supported composite operators: *not*
|
||||
|
||||
|
||||
Only a single *not* may be used, and it can only be used with the `in` operator.
|
||||
The `not` composite operator must be used in front of the field. For example,
|
||||
the following is valid: `not value in ("ID01")`'
|
||||
schema:
|
||||
type: string
|
||||
x-go-name: Filters
|
||||
example: value eq "ID01"
|
||||
required: false
|
||||
x-go-name: Filters
|
||||
- name: query
|
||||
in: query
|
||||
description: String that is passed to the underlying API to filter other (non-ID)
|
||||
fields. For example, for access profile data sources, this string will be
|
||||
passed to the access profile api and used with a "starts with" filter against several
|
||||
fields.
|
||||
schema:
|
||||
type: string
|
||||
x-go-name: Query
|
||||
example: support
|
||||
required: false
|
||||
x-go-name: Query
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: Retrieves dynamic data to aid in correctly completing a valid form
|
||||
by form element ID from data source configuration
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/ListFormElementDataByElementIDResponse.yaml
|
||||
'400':
|
||||
description: An error with the request occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'401':
|
||||
description: An error with the authorization occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'403':
|
||||
description: An error with the user permissions occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'404':
|
||||
description: An error with the item not found
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'429':
|
||||
description: Too many requests
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/Error.yaml
|
||||
'500':
|
||||
description: An internal server error occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
security:
|
||||
- UserContextAuth: []
|
||||
543
static/api-specs/idn/v2024/paths/form-instance-file.yaml
Normal file
543
static/api-specs/idn/v2024/paths/form-instance-file.yaml
Normal file
@@ -0,0 +1,543 @@
|
||||
get:
|
||||
tags:
|
||||
- Custom Forms
|
||||
summary: Download instance file by fileId.
|
||||
operationId: getFormInstanceFile
|
||||
parameters:
|
||||
- name: formInstanceID
|
||||
in: path
|
||||
description: 'FormInstanceID
|
||||
|
||||
|
||||
Form instance ID'
|
||||
required: true
|
||||
example: 00000000-0000-0000-0000-000000000000
|
||||
schema:
|
||||
type: string
|
||||
x-go-name: FormInstanceID
|
||||
x-go-name: FormInstanceID
|
||||
- name: fileID
|
||||
in: path
|
||||
description: 'FileID
|
||||
|
||||
|
||||
String specifying the hashed name of the uploaded file we are retrieving.'
|
||||
required: true
|
||||
example: 00000031N0J7R2B57M8YG73J7M.png
|
||||
schema:
|
||||
type: string
|
||||
x-go-name: FileID
|
||||
x-go-name: FileID
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: Returns a file that is referred to by fileID and associated with
|
||||
the formInstanceID
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: string
|
||||
format: binary
|
||||
image/jpeg:
|
||||
schema:
|
||||
type: string
|
||||
format: binary
|
||||
image/png:
|
||||
schema:
|
||||
type: string
|
||||
format: binary
|
||||
application/octet-stream:
|
||||
schema:
|
||||
type: string
|
||||
format: binary
|
||||
'400':
|
||||
description: An error with the request occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
image/jpeg:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
image/png:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
application/octet-stream:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'401':
|
||||
description: An error with the authorization occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
image/jpeg:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
image/png:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
application/octet-stream:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'403':
|
||||
description: An error with the user permissions occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
image/jpeg:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
image/png:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
application/octet-stream:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'404':
|
||||
description: An error with the item not found
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
image/jpeg:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
image/png:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
application/octet-stream:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'429':
|
||||
description: Too many requests
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/Error.yaml
|
||||
'500':
|
||||
description: An internal server error occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
image/jpeg:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
image/png:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
application/octet-stream:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'503':
|
||||
description: An external service is not available
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
image/jpeg:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
image/png:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
application/octet-stream:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- sp:forms:manage
|
||||
x-codegen-request-body-name: Body
|
||||
338
static/api-specs/idn/v2024/paths/form-instance.yaml
Normal file
338
static/api-specs/idn/v2024/paths/form-instance.yaml
Normal file
@@ -0,0 +1,338 @@
|
||||
get:
|
||||
tags:
|
||||
- Custom Forms
|
||||
summary: Returns a form instance.
|
||||
description: Parameter `{formInstanceID}` should match a form instance ID.
|
||||
operationId: getFormInstanceByKey
|
||||
parameters:
|
||||
- name: formInstanceID
|
||||
in: path
|
||||
description: Form instance ID
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
x-go-name: FormInstanceID
|
||||
example: 00000000-0000-0000-0000-000000000000
|
||||
x-go-name: FormInstanceID
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: Returns a form instance by its key
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/FormInstanceResponse.yaml
|
||||
'400':
|
||||
description: An error with the request occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'401':
|
||||
description: An error with the authorization occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'403':
|
||||
description: An error with the user permissions occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'404':
|
||||
description: An error with the item not found
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'429':
|
||||
description: Too many requests
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/Error.yaml
|
||||
'500':
|
||||
description: An internal server error occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
security:
|
||||
- UserContextAuth: []
|
||||
patch:
|
||||
tags:
|
||||
- Custom Forms
|
||||
summary: Patch a form instance.
|
||||
description: Parameter `{formInstanceID}` should match a form instance ID.
|
||||
operationId: patchFormInstance
|
||||
parameters:
|
||||
- name: formInstanceID
|
||||
in: path
|
||||
description: Form instance ID
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
x-go-name: FormInstanceID
|
||||
example: 00000000-0000-0000-0000-000000000000
|
||||
x-go-name: FormInstanceID
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
requestBody:
|
||||
description: 'Body is the request payload to patch a form instance, check: https://jsonpatch.com'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/Patch.yaml
|
||||
example:
|
||||
- op: replace
|
||||
path: /state
|
||||
value: SUBMITTED
|
||||
- op: replace
|
||||
path: /formData
|
||||
value:
|
||||
a-key-1: a-value-1
|
||||
a-key-2: true
|
||||
a-key-3: 1
|
||||
required: false
|
||||
responses:
|
||||
'200':
|
||||
description: Returns the form instance updated
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/FormInstanceResponse.yaml
|
||||
'400':
|
||||
description: An error with the request occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'401':
|
||||
description: An error with the authorization occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'403':
|
||||
description: An error with the user permissions occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'404':
|
||||
description: An error with the item not found
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'409':
|
||||
description: An error with the request property conflicts with stored
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'429':
|
||||
description: Too many requests
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/Error.yaml
|
||||
'500':
|
||||
description: An internal server error occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
security:
|
||||
- UserContextAuth: []
|
||||
x-codegen-request-body-name: Body
|
||||
254
static/api-specs/idn/v2024/paths/form-instances.yaml
Normal file
254
static/api-specs/idn/v2024/paths/form-instances.yaml
Normal file
@@ -0,0 +1,254 @@
|
||||
get:
|
||||
tags:
|
||||
- Custom Forms
|
||||
summary: List form instances by tenant.
|
||||
description: No parameters required.
|
||||
operationId: searchFormInstancesByTenant
|
||||
responses:
|
||||
'200':
|
||||
description: Returns a list of form instances by tenant
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/ListFormInstancesByTenantResponse.yaml
|
||||
'400':
|
||||
description: An error with the request occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'401':
|
||||
description: An error with the authorization occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'403':
|
||||
description: An error with the user permissions occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'429':
|
||||
description: Too many requests
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/Error.yaml
|
||||
'500':
|
||||
description: An internal server error occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- sp:forms:manage
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
post:
|
||||
tags:
|
||||
- Custom Forms
|
||||
summary: Creates a form instance.
|
||||
operationId: createFormInstance
|
||||
requestBody:
|
||||
description: Body is the request payload to create a form instance
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/CreateFormInstanceRequest.yaml
|
||||
example:
|
||||
expire: '2023-06-20T15:57:55.332882Z'
|
||||
formDefinitionId: 00000000-0000-0000-0000-000000000000
|
||||
recipients:
|
||||
- type: IDENTITY
|
||||
id: an-identity-id
|
||||
createdBy:
|
||||
type: WORKFLOW_EXECUTION
|
||||
id: a-workflow-execution-id
|
||||
required: false
|
||||
responses:
|
||||
'201':
|
||||
description: Returns a new form instance
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/FormInstanceResponse.yaml
|
||||
'400':
|
||||
description: An error with the request occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'401':
|
||||
description: An error with the authorization occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'403':
|
||||
description: An error with the user permissions occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
'429':
|
||||
description: Too many requests
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/forms/Error.yaml
|
||||
'500':
|
||||
description: An internal server error occurred
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
detailCode:
|
||||
type: string
|
||||
x-go-name: DetailCode
|
||||
messages:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/forms/ErrorMessage.yaml
|
||||
x-go-name: Messages
|
||||
statusCode:
|
||||
type: integer
|
||||
format: int64
|
||||
x-go-name: StatusCode
|
||||
trackingId:
|
||||
type: string
|
||||
x-go-name: TrackingID
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- sp:forms:manage
|
||||
x-codegen-request-body-name: Body
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
61
static/api-specs/idn/v2024/paths/historical-identities.yaml
Normal file
61
static/api-specs/idn/v2024/paths/historical-identities.yaml
Normal file
@@ -0,0 +1,61 @@
|
||||
get:
|
||||
operationId: listHistoricalIdentities
|
||||
summary: Lists all the identities
|
||||
description: This gets the list of identities for the customer. This list end point
|
||||
does not support count=true request param. The total count of identities would
|
||||
never be returned even if the count param is specified in the request Requires
|
||||
authorization scope of 'idn:identity-history:read'
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:identity-history:read
|
||||
tags:
|
||||
- Identity History
|
||||
parameters:
|
||||
- in: query
|
||||
name: starts-with-query
|
||||
schema:
|
||||
type: string
|
||||
description: This param is used for starts-with search for first, last and display
|
||||
name of the identity
|
||||
example: Ada
|
||||
- in: query
|
||||
name: is-deleted
|
||||
schema:
|
||||
type: boolean
|
||||
description: Indicates if we want to only list down deleted identities or not.
|
||||
example: true
|
||||
- in: query
|
||||
name: is-active
|
||||
schema:
|
||||
type: boolean
|
||||
description: Indicates if we want to only list active or inactive identities.
|
||||
example: true
|
||||
- $ref: ../../v3/parameters/limit.yaml
|
||||
- $ref: ../../v3/parameters/offset.yaml
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: List of identities for the customer.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/IdentityListItem.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
|
||||
@@ -0,0 +1,102 @@
|
||||
get:
|
||||
operationId: listIdentityAccessItems
|
||||
tags:
|
||||
- Identity History
|
||||
summary: Gets a list of access items for the identity filtered by item type
|
||||
description: 'This method retrieves a list of access item for the identity filtered
|
||||
by the access item type Requires authorization scope of ''idn:identity-history:read'' '
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: The identity id
|
||||
example: 8c190e6787aa4ed9a90bd9d5344523fb
|
||||
- in: query
|
||||
name: type
|
||||
schema:
|
||||
type: string
|
||||
description: The type of access item for the identity. If not provided, it defaults
|
||||
to account
|
||||
example: account
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: The list of access items.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
oneOf:
|
||||
- $ref: ../../beta/schemas/AccessItemAccessProfileResponse.yaml
|
||||
- $ref: ../../beta/schemas/AccessItemAccountResponse.yaml
|
||||
- $ref: ../../beta/schemas/AccessItemAppResponse.yaml
|
||||
- $ref: ../../beta/schemas/AccessItemEntitlementResponse.yaml
|
||||
- $ref: ../../beta/schemas/AccessItemRoleResponse.yaml
|
||||
examples:
|
||||
Access Profile:
|
||||
description: An access profile response
|
||||
value:
|
||||
- accessType: accessProfile
|
||||
id: 2c918087763e69d901763e72e97f006f
|
||||
name: sample
|
||||
sourceName: DataScienceDataset
|
||||
sourceId: 2793o32dwd
|
||||
description: AccessProfile - Workday/Citizenship access
|
||||
displayName: Dr. Arden Rogahn MD
|
||||
entitlementCount: 12
|
||||
appDisplayName: AppName
|
||||
Account:
|
||||
description: An account response
|
||||
value:
|
||||
- accessType: account
|
||||
id: 2c918087763e69d901763e72e97f006f
|
||||
nativeIdentity: dr.arden.ogahn.d
|
||||
sourceName: DataScienceDataset
|
||||
sourceId: 2793o32dwd
|
||||
entitlementCount: 12
|
||||
displayName: Dr. Arden Rogahn MD
|
||||
App:
|
||||
description: An app response
|
||||
value:
|
||||
- accessType: app
|
||||
id: 2c918087763e69d901763e72e97f006f
|
||||
name: appName
|
||||
Entitlement:
|
||||
description: An entitlement event
|
||||
value:
|
||||
- accessType: entitlement
|
||||
id: 2c918087763e69d901763e72e97f006f
|
||||
attribute: groups
|
||||
value: Upward mobility access
|
||||
type: group
|
||||
sourceName: DataScienceDataset
|
||||
sourceId: 2793o32dwd
|
||||
description: Entitlement - Workday/Citizenship access
|
||||
displayName: Dr. Arden Rogahn MD
|
||||
Role:
|
||||
description: A role response
|
||||
value:
|
||||
- accessType: role
|
||||
id: 2c918087763e69d901763e72e97f006f
|
||||
name: sample
|
||||
description: Role - Workday/Citizenship access
|
||||
'400':
|
||||
$ref: ../../v3/responses/400.yaml
|
||||
'401':
|
||||
$ref: ../../v3/responses/401.yaml
|
||||
'403':
|
||||
$ref: ../../v3/responses/403.yaml
|
||||
'404':
|
||||
$ref: ../../v3/responses/404.yaml
|
||||
'500':
|
||||
$ref: ../../v3/responses/500.yaml
|
||||
@@ -0,0 +1,72 @@
|
||||
get:
|
||||
operationId: compareIdentitySnapshotsAccessType
|
||||
tags:
|
||||
- Identity History
|
||||
summary: Gets a list of differences of specific accessType for the given identity
|
||||
between 2 snapshots
|
||||
description: 'This method gets a list of differences of specific accessType for
|
||||
the given identity between 2 snapshots Requires authorization scope of ''idn:identity-history:read'' '
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: The identity id
|
||||
example: 8c190e6787aa4ed9a90bd9d5344523fb
|
||||
- in: path
|
||||
name: accessType
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: The specific type which needs to be compared
|
||||
example: role
|
||||
- in: query
|
||||
name: access-associated
|
||||
schema:
|
||||
type: boolean
|
||||
description: Indicates if added or removed access needs to be returned. true -
|
||||
added, false - removed, null - both added & removed
|
||||
example: '2007-03-01T13:00:00Z'
|
||||
- in: query
|
||||
name: snapshot1
|
||||
schema:
|
||||
type: string
|
||||
description: The snapshot 1 of identity
|
||||
example: '2008-03-01T13:00:00Z'
|
||||
- in: query
|
||||
name: snapshot2
|
||||
schema:
|
||||
type: string
|
||||
description: The snapshot 2 of identity
|
||||
example: '2009-03-01T13:00:00Z'
|
||||
- $ref: ../../v3/parameters/limit.yaml
|
||||
- $ref: ../../v3/parameters/offset.yaml
|
||||
- $ref: ../../v3/parameters/count.yaml
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: A list of events for the identity
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/AccessItemDiff.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
|
||||
'500':
|
||||
$ref: ../../v3/responses/500.yaml
|
||||
@@ -0,0 +1,67 @@
|
||||
get:
|
||||
operationId: compareIdentitySnapshots
|
||||
tags:
|
||||
- Identity History
|
||||
summary: Gets a difference of count for each access item types for the given identity
|
||||
between 2 snapshots
|
||||
description: 'This method gets a difference of count for each access item types
|
||||
for the given identity between 2 snapshots Requires authorization scope of ''idn:identity-history:read'' '
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: The identity id
|
||||
example: 8c190e6787aa4ed9a90bd9d5344523fb
|
||||
- in: query
|
||||
name: snapshot1
|
||||
schema:
|
||||
type: string
|
||||
description: The snapshot 1 of identity
|
||||
example: '2007-03-01T13:00:00Z'
|
||||
- in: query
|
||||
name: snapshot2
|
||||
schema:
|
||||
type: string
|
||||
description: The snapshot 2 of identity
|
||||
example: '2008-03-01T13:00:00Z'
|
||||
- in: query
|
||||
name: accessItemTypes
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
description: 'An optional list of access item types (app, account, entitlement,
|
||||
etc...) to return. If null or empty, all access items types are returned '
|
||||
- $ref: ../../v3/parameters/limit.yaml
|
||||
- $ref: ../../v3/parameters/offset.yaml
|
||||
- $ref: ../../v3/parameters/count.yaml
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: A IdentityCompare object with difference details for each access
|
||||
item type
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/IdentityCompareResponse.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
|
||||
'500':
|
||||
$ref: ../../v3/responses/500.yaml
|
||||
203
static/api-specs/idn/v2024/paths/historical-identity-events.yaml
Normal file
203
static/api-specs/idn/v2024/paths/historical-identity-events.yaml
Normal file
@@ -0,0 +1,203 @@
|
||||
get:
|
||||
operationId: getHistoricalIdentityEvents
|
||||
tags:
|
||||
- Identity History
|
||||
summary: Lists all events for the given identity
|
||||
description: 'This method retrieves all access events for the identity Requires
|
||||
authorization scope of ''idn:identity-history:read'' '
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: The identity id
|
||||
example: 8c190e6787aa4ed9a90bd9d5344523fb
|
||||
- in: query
|
||||
name: from
|
||||
schema:
|
||||
type: string
|
||||
description: The optional instant until which access events are returned
|
||||
example: '2024-03-01T13:00:00Z'
|
||||
- in: query
|
||||
name: eventTypes
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
description: An optional list of event types to return. If null or empty, all
|
||||
events are returned
|
||||
example:
|
||||
- AccessAddedEvent
|
||||
- AccessRemovedEvent
|
||||
- in: query
|
||||
name: accessItemTypes
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
description: An optional list of access item types (app, account, entitlement,
|
||||
etc...) to return. If null or empty, all access items types are returned
|
||||
example:
|
||||
- entitlement
|
||||
- account
|
||||
- $ref: ../../v3/parameters/limit.yaml
|
||||
- $ref: ../../v3/parameters/offset.yaml
|
||||
- $ref: ../../v3/parameters/count.yaml
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: The list of events for the identity
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
anyOf:
|
||||
- $ref: ../../beta/schemas/AccessItemAssociated.yaml
|
||||
- $ref: ../../beta/schemas/AccessItemRemoved.yaml
|
||||
- $ref: ../../beta/schemas/AttributesChanged.yaml
|
||||
- $ref: ../../beta/schemas/AccessRequested.yaml
|
||||
- $ref: ../../beta/schemas/IdentityCertified.yaml
|
||||
- $ref: ../../beta/schemas/AccountStatusChanged.yaml
|
||||
examples:
|
||||
AccessItemAssociated:
|
||||
description: An Access item associated event
|
||||
value:
|
||||
- accessItem:
|
||||
id: 8c190e6787aa4ed9a90bd9d5344523fb
|
||||
accessType: account
|
||||
nativeIdentity: 127999
|
||||
sourceName: JDBC Entitlements Source
|
||||
entitlementCount: 0
|
||||
displayName: Sample Name
|
||||
eventType: AccessItemAssociated
|
||||
identityId: 8a80828f643d484f01643e14202e206f
|
||||
dt: '2019-03-08T22:37:33.901Z'
|
||||
governanceEvent:
|
||||
name: Access Request 58
|
||||
dt: '2019-03-08T22:37:33.901Z'
|
||||
type: accessRequest
|
||||
governanceId: 2c91808a77ff216301782327a50f09e1
|
||||
owners:
|
||||
- id: bc693f07e7b645539626c25954c58554
|
||||
displayName: Jon Snow
|
||||
reviewers:
|
||||
- id: bc693f07e7b645539626c25954c58554
|
||||
displayName: Jon Snow
|
||||
decisionMaker:
|
||||
id: bc693f07e7b645539626c25954c58554
|
||||
displayName: Jon Snow
|
||||
AccessItemRemoved:
|
||||
description: An Access item removed event
|
||||
value:
|
||||
- accessItem:
|
||||
id: 8c190e6787aa4ed9a90bd9d5344523fb
|
||||
accessType: account
|
||||
nativeIdentity: 127999
|
||||
sourceName: JDBC Entitlements Source
|
||||
entitlementCount: 0
|
||||
displayName: Sample Name
|
||||
eventType: AccessItemRemoved
|
||||
identityId: 8a80828f643d484f01643e14202e206f
|
||||
dt: '2019-03-08T22:37:33.901Z'
|
||||
governanceEvent:
|
||||
name: Manager Certification for Jon Snow
|
||||
dt: '2019-03-08T22:37:33.901Z'
|
||||
type: certification
|
||||
governanceId: 2c91808a77ff216301782327a50f09bf
|
||||
owners:
|
||||
- id: bc693f07e7b645539626c25954c58554
|
||||
displayName: Jon Snow
|
||||
reviewers:
|
||||
- id: bc693f07e7b645539626c25954c58554
|
||||
displayName: Jon Snow
|
||||
decisionMaker:
|
||||
id: bc693f07e7b645539626c25954c58554
|
||||
displayName: Jon Snow
|
||||
AttributesChanged:
|
||||
description: An attribute changed event
|
||||
value:
|
||||
- attributeChanges:
|
||||
- name: firstname
|
||||
previousValue: adam
|
||||
newValue: zampa
|
||||
eventType: AttributesChanged
|
||||
identityId: 8a80828f643d484f01643e14202e206f
|
||||
dt: '2019-03-08T22:37:33.901Z'
|
||||
AccessRequested:
|
||||
description: An access requested event
|
||||
value:
|
||||
accessRequest:
|
||||
requesterId: 2c91808a77ff216301782327a50f09bf
|
||||
requestName: Bing C
|
||||
items:
|
||||
- operation: Add
|
||||
accessItemType: role
|
||||
name: Role-1
|
||||
decision: APPROVED
|
||||
description: The role descrition
|
||||
sourceId: 8a80828f643d484f01643e14202e206f
|
||||
sourceName: Source1
|
||||
approvalInfos:
|
||||
- name: John Snow
|
||||
id: 8a80828f643d484f01643e14202e2000
|
||||
status: Approved
|
||||
eventType: AccessRequested
|
||||
identityId: 8a80828f643d484f01643e14202e206f
|
||||
dt: '2019-03-08T22:37:33.901Z'
|
||||
IdentityCertified:
|
||||
description: An identity certified event
|
||||
value:
|
||||
- certification:
|
||||
id: 2c91808a77ff216301782327a50f09bf
|
||||
name: Cert name
|
||||
signedDate: '2019-03-08T22:37:33.901Z'
|
||||
certifiers:
|
||||
- id: 8a80828f643d484f01643e14202e206f
|
||||
displayName: John Snow
|
||||
reviewers:
|
||||
- id: 8a80828f643d484f01643e14202e206f
|
||||
displayName: Daenerys Targaryen
|
||||
signer:
|
||||
id: 8a80828f643d484f01643e14202e206f
|
||||
displayName: Tyrion Lannister
|
||||
eventType: IdentityCertified
|
||||
identityId: 8a80828f643d484f01643e14202e206f
|
||||
dt: '2019-03-08T22:37:33.901Z'
|
||||
AccountStatusChanged:
|
||||
description: An account status changed event
|
||||
value:
|
||||
- account:
|
||||
id: 2c91808a77ff216301782327a50f09bf
|
||||
nativeIdentity: 127999
|
||||
displayName: Sample Name
|
||||
sourceId: 8a80828f643d484f01643e14202e206f
|
||||
sourceName: JDBC Entitlements Source
|
||||
entitlementCount: 0
|
||||
accessType: account
|
||||
statusChange:
|
||||
previousStatus: ENABLED
|
||||
newStatus: DISABLED
|
||||
eventType: AccountStatusChanged
|
||||
identityId: 8a80828f643d484f01643e14202e206f
|
||||
dt: '2019-03-08T22:37:33.901Z'
|
||||
'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
|
||||
@@ -0,0 +1,109 @@
|
||||
get:
|
||||
operationId: listIdentitySnapshotAccessItems
|
||||
tags:
|
||||
- Identity History
|
||||
summary: Gets the list of identity access items at a given date filterd by item
|
||||
type
|
||||
description: 'This method retrieves the list of identity access items at a given
|
||||
date filterd by item type Requires authorization scope of ''idn:identity-history:read'' '
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: The identity id
|
||||
example: 8c190e6787aa4ed9a90bd9d5344523fb
|
||||
- in: path
|
||||
name: date
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: The specified date
|
||||
example: '2007-03-01T13:00:00Z'
|
||||
- in: query
|
||||
name: type
|
||||
schema:
|
||||
type: string
|
||||
description: The access item type
|
||||
example: account
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: The identity object.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
oneOf:
|
||||
- $ref: ../../beta/schemas/AccessItemAccessProfileResponse.yaml
|
||||
- $ref: ../../beta/schemas/AccessItemAccountResponse.yaml
|
||||
- $ref: ../../beta/schemas/AccessItemAppResponse.yaml
|
||||
- $ref: ../../beta/schemas/AccessItemEntitlementResponse.yaml
|
||||
- $ref: ../../beta/schemas/AccessItemRoleResponse.yaml
|
||||
examples:
|
||||
Access Item AccessProfile Response:
|
||||
description: An access profile response
|
||||
value:
|
||||
- type: accessProfile
|
||||
id: 2c918087763e69d901763e72e97f006f
|
||||
name: sample
|
||||
sourceName: DataScienceDataset
|
||||
sourceId: 2793o32dwd
|
||||
description: AccessProfile - Workday/Citizenship access
|
||||
displayName: Dr. Arden Rogahn MD
|
||||
entitlementCount: 12
|
||||
appDisplayName: AppName
|
||||
Access Item Account Response:
|
||||
description: An account response
|
||||
value:
|
||||
- type: account
|
||||
id: 2c918087763e69d901763e72e97f006f
|
||||
nativeIdentity: dr.arden.ogahn.d
|
||||
sourceName: DataScienceDataset
|
||||
sourceId: 2793o32dwd
|
||||
entitlementCount: 12
|
||||
displayName: Dr. Arden Rogahn MD
|
||||
Access Item App Response:
|
||||
description: An app response
|
||||
value:
|
||||
- type: app
|
||||
id: 2c918087763e69d901763e72e97f006f
|
||||
name: appName
|
||||
Access Item Entitlement Response:
|
||||
description: An entitlement event
|
||||
value:
|
||||
- type: entitlement
|
||||
id: 2c918087763e69d901763e72e97f006f
|
||||
attribute: groups
|
||||
value: Upward mobility access
|
||||
entitlementType: entitlement
|
||||
sourceName: DataScienceDataset
|
||||
sourceId: 2793o32dwd
|
||||
description: Entitlement - Workday/Citizenship access
|
||||
displayName: Dr. Arden Rogahn MD
|
||||
Access Item Role Response:
|
||||
description: A role response
|
||||
value:
|
||||
- type: role
|
||||
id: 2c918087763e69d901763e72e97f006f
|
||||
name: sample
|
||||
description: Role - Workday/Citizenship access
|
||||
'400':
|
||||
$ref: ../../v3/responses/400.yaml
|
||||
'401':
|
||||
$ref: ../../v3/responses/401.yaml
|
||||
'403':
|
||||
$ref: ../../v3/responses/403.yaml
|
||||
'404':
|
||||
$ref: ../../v3/responses/404.yaml
|
||||
'500':
|
||||
$ref: ../../v3/responses/500.yaml
|
||||
@@ -0,0 +1,47 @@
|
||||
get:
|
||||
operationId: getIdentitySnapshot
|
||||
tags:
|
||||
- Identity History
|
||||
summary: Gets an identity snapshot at a given date
|
||||
description: 'This method retrieves a specified identity snapshot at a given date
|
||||
Requires authorization scope of ''idn:identity-history:read'' '
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: The identity id
|
||||
example: 8c190e6787aa4ed9a90bd9d5344523fb
|
||||
- in: path
|
||||
name: date
|
||||
schema:
|
||||
type: string
|
||||
description: The specified date
|
||||
example: '2007-03-01T13:00:00Z'
|
||||
required: true
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: The identity object.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/IdentityHistoryResponse.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
|
||||
'500':
|
||||
$ref: ../../v3/responses/500.yaml
|
||||
@@ -0,0 +1,65 @@
|
||||
get:
|
||||
operationId: getIdentitySnapshotSummary
|
||||
tags:
|
||||
- Identity History
|
||||
summary: Gets the summary for the event count for a specific identity
|
||||
description: 'This method gets the summary for the event count for a specific identity
|
||||
by month/day Requires authorization scope of ''idn:identity-history:read'' '
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: The identity id
|
||||
example: 8c190e6787aa4ed9a90bd9d5344523fb
|
||||
- in: query
|
||||
name: before
|
||||
schema:
|
||||
type: string
|
||||
description: The date before which snapshot summary is required
|
||||
example: '2007-03-01T13:00:00Z'
|
||||
- in: query
|
||||
name: interval
|
||||
schema:
|
||||
type: string
|
||||
enum:
|
||||
- day
|
||||
- month
|
||||
description: The interval indicating day or month. Defaults to month if not specified
|
||||
- in: query
|
||||
name: time-zone
|
||||
schema:
|
||||
type: string
|
||||
description: The time zone. Defaults to UTC if not provided
|
||||
example: UTC
|
||||
- $ref: ../../v3/parameters/limit.yaml
|
||||
- $ref: ../../v3/parameters/offset.yaml
|
||||
- $ref: ../../v3/parameters/count.yaml
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: A summary list of identity changes in date histogram format.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/MetricResponse.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
|
||||
'500':
|
||||
$ref: ../../v3/responses/500.yaml
|
||||
@@ -0,0 +1,60 @@
|
||||
get:
|
||||
operationId: listIdentitySnapshots
|
||||
tags:
|
||||
- Identity History
|
||||
summary: Lists all the snapshots for the identity
|
||||
description: 'This method retrieves all the snapshots for the identity Requires
|
||||
authorization scope of ''idn:identity-history:read'' '
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: The identity id
|
||||
example: 8c190e6787aa4ed9a90bd9d5344523fb
|
||||
- in: query
|
||||
name: start
|
||||
schema:
|
||||
type: string
|
||||
description: The specified start date
|
||||
example: '2007-03-01T13:00:00Z'
|
||||
- in: query
|
||||
name: interval
|
||||
schema:
|
||||
type: string
|
||||
enum:
|
||||
- day
|
||||
- month
|
||||
description: The interval indicating the range in day or month for the specified
|
||||
interval-name
|
||||
- $ref: ../../v3/parameters/limit.yaml
|
||||
- $ref: ../../v3/parameters/offset.yaml
|
||||
- $ref: ../../v3/parameters/count.yaml
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: A list of identity summary for each snapshot.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/IdentitySnapshotSummaryResponse.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
|
||||
'500':
|
||||
$ref: ../../v3/responses/500.yaml
|
||||
@@ -0,0 +1,41 @@
|
||||
get:
|
||||
operationId: getIdentityStartDate
|
||||
tags:
|
||||
- Identity History
|
||||
summary: Gets the start date of the identity
|
||||
description: 'This method retrieves start date of the identity Requires authorization
|
||||
scope of ''idn:identity-history:read'' '
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: The identity id
|
||||
example: 8c190e6787aa4ed9a90bd9d5344523fb
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: The start date of the identity
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: string
|
||||
example: '2017-03-01T13:00:00.000Z'
|
||||
'400':
|
||||
$ref: ../../v3/responses/400.yaml
|
||||
'401':
|
||||
$ref: ../../v3/responses/401.yaml
|
||||
'403':
|
||||
$ref: ../../v3/responses/403.yaml
|
||||
'404':
|
||||
$ref: ../../v3/responses/404.yaml
|
||||
'500':
|
||||
$ref: ../../v3/responses/500.yaml
|
||||
43
static/api-specs/idn/v2024/paths/historical-identity.yaml
Normal file
43
static/api-specs/idn/v2024/paths/historical-identity.yaml
Normal file
@@ -0,0 +1,43 @@
|
||||
get:
|
||||
operationId: getHistoricalIdentity
|
||||
tags:
|
||||
- Identity History
|
||||
summary: Get latest snapshot of identity
|
||||
description: This method retrieves a specified identity Requires authorization scope
|
||||
of 'idn:identity-history:read'
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:identity-history:read
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: The identity id
|
||||
example: 8c190e6787aa4ed9a90bd9d5344523fb
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: The identity object.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/IdentityHistoryResponse.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
|
||||
119
static/api-specs/idn/v2024/paths/icon.yaml
Normal file
119
static/api-specs/idn/v2024/paths/icon.yaml
Normal file
@@ -0,0 +1,119 @@
|
||||
put:
|
||||
operationId: setIcon
|
||||
tags:
|
||||
- Icons
|
||||
summary: Update an icon
|
||||
description: This API endpoint updates an icon by object type and object id. A token
|
||||
with ORG_ADMIN authority is required to call this API.
|
||||
parameters:
|
||||
- in: path
|
||||
name: objectType
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: Object type. Available options ['application']
|
||||
example: application
|
||||
- in: path
|
||||
name: objectId
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: Object id.
|
||||
example: a291e870-48c3-4953-b656-fb5ce2a93169
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
multipart/form-data:
|
||||
schema:
|
||||
type: object
|
||||
required:
|
||||
- image
|
||||
properties:
|
||||
image:
|
||||
type: string
|
||||
format: binary
|
||||
description: file with icon. Allowed mime-types ['image/png', 'image/jpeg']
|
||||
example: \x00\x00\x00\x02
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:icons:manage
|
||||
responses:
|
||||
'200':
|
||||
description: Icon updated
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
icon:
|
||||
type: string
|
||||
description: url to file with icon
|
||||
example: ''
|
||||
'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: deleteIcon
|
||||
tags:
|
||||
- Icons
|
||||
summary: Delete an icon
|
||||
description: This API endpoint delete an icon by object type and object id. A token
|
||||
with ORG_ADMIN authority is required to call this API.
|
||||
parameters:
|
||||
- in: path
|
||||
name: objectType
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: Object type. Available options ['application']
|
||||
example: application
|
||||
- in: path
|
||||
name: objectId
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: Object id.
|
||||
example: a291e870-48c3-4953-b656-fb5ce2a93169
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:icons:manage
|
||||
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
|
||||
@@ -0,0 +1,55 @@
|
||||
post:
|
||||
operationId: disableAccountsForIdentities
|
||||
tags:
|
||||
- Accounts
|
||||
summary: Disable IDN Accounts for Identities
|
||||
description: This API submits tasks to disable IDN account for each identity provided
|
||||
in the request body.
|
||||
externalDocs:
|
||||
description: Learn more about disabling identities here
|
||||
url: https://documentation.sailpoint.com/saas/help/common/users/user_access.html#disabling-user-identities
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:accounts-state:manage
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/IdentitiesAccountsBulkRequest.yaml
|
||||
responses:
|
||||
'207':
|
||||
description: Bulk response details.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/BulkIdentitiesAccountsResponse.yaml
|
||||
example:
|
||||
- id: 2c9180858082150f0180893dbaf553fe
|
||||
statusCode: 404
|
||||
message: Referenced identity "2c9180858082150f0180893dbaf553fe" was
|
||||
not found.
|
||||
- id: 2c91808384203c2d018437e631158308
|
||||
statusCode: 202
|
||||
message: null
|
||||
'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
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
@@ -0,0 +1,55 @@
|
||||
post:
|
||||
operationId: enableAccountsForIdentities
|
||||
tags:
|
||||
- Accounts
|
||||
summary: Enable IDN Accounts for Identities
|
||||
description: This API submits tasks to enable IDN account for each identity provided
|
||||
in the request body.
|
||||
externalDocs:
|
||||
description: Learn more about enabling identities here
|
||||
url: https://documentation.sailpoint.com/saas/help/common/users/user_access.html#enabling-user-identities
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:accounts-state:manage
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/IdentitiesAccountsBulkRequest.yaml
|
||||
responses:
|
||||
'207':
|
||||
description: Bulk response details.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/BulkIdentitiesAccountsResponse.yaml
|
||||
example:
|
||||
- id: 2c9180858082150f0180893dbaf553fe
|
||||
statusCode: 404
|
||||
message: Referenced identity "2c9180858082150f0180893dbaf553fe" was
|
||||
not found.
|
||||
- id: 2c91808384203c2d018437e631158308
|
||||
statusCode: 202
|
||||
message: null
|
||||
'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
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
60
static/api-specs/idn/v2024/paths/identities-process.yaml
Normal file
60
static/api-specs/idn/v2024/paths/identities-process.yaml
Normal file
@@ -0,0 +1,60 @@
|
||||
post:
|
||||
operationId: startIdentityProcessing
|
||||
tags:
|
||||
- Identities
|
||||
summary: Process a list of identityIds
|
||||
description: "This operation should not be used to schedule your own identity processing\
|
||||
\ or to perform system wide identity refreshes. The system will use a combination\
|
||||
\ of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing)\
|
||||
\ and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing)\
|
||||
\ that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep\
|
||||
\ your identities synchronized. \n\nThis endpoint will perform the following tasks:\n\
|
||||
1. Calculate identity attributes, including applying or running any rules or transforms\
|
||||
\ (e.g. calculate Lifecycle State at a point-in-time it's expected to change).\n\
|
||||
2. Evaluate role assignments, leading to assignment of new roles and removal of\
|
||||
\ existing roles.\n3. Enforce provisioning for any assigned accesses that haven't\
|
||||
\ been fulfilled (e.g. failure due to source health).\n4. Recalculate manager\
|
||||
\ relationships.\n5. Potentially clean-up identity processing errors, assuming\
|
||||
\ the error has been resolved.\n\nA token with ORG_ADMIN or HELPDESK authority\
|
||||
\ is required to call this API.\n"
|
||||
externalDocs:
|
||||
description: Learn more about manually processing identities here
|
||||
url: https://documentation.sailpoint.com/saas/help/setup/identity_processing.html
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:identity:manage
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/ProcessIdentitiesRequest.yaml
|
||||
responses:
|
||||
'202':
|
||||
description: Object containing the DTO type TASK_RESULT and the job id for the
|
||||
task
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/TaskResultResponse.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
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
@@ -0,0 +1,50 @@
|
||||
get:
|
||||
operationId: getRoleAssignment
|
||||
tags:
|
||||
- Identities
|
||||
summary: Role assignment details
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:identity:read
|
||||
parameters:
|
||||
- in: path
|
||||
name: identityId
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: Identity Id
|
||||
example: ef38f94347e94562b5bb8424a56397d8
|
||||
- in: path
|
||||
name: assignmentId
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: Assignment Id
|
||||
example: 1cbb0705b38c4226b1334eadd8874086
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: A role assignment object
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/RoleAssignmentDto.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
|
||||
@@ -0,0 +1,64 @@
|
||||
get:
|
||||
operationId: getRoleAssignments
|
||||
tags:
|
||||
- Identities
|
||||
summary: List role assignments
|
||||
description: This returns either a list of Role Assignments when querying with either
|
||||
a Role Id or Role Name, or a list of Role Assignment References if querying with
|
||||
only identity Id.
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:identity:read
|
||||
parameters:
|
||||
- in: path
|
||||
name: identityId
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: Identity Id to get the role assignments for
|
||||
example: ef38f94347e94562b5bb8424a56397d8
|
||||
- in: query
|
||||
name: roleId
|
||||
schema:
|
||||
type: string
|
||||
required: false
|
||||
description: Role Id to filter the role assignments with
|
||||
example: e7697a1e96d04db1ac7b0f4544915d2c
|
||||
- in: query
|
||||
name: roleName
|
||||
schema:
|
||||
type: string
|
||||
required: false
|
||||
description: Role name to filter the role assignments with
|
||||
example: Engineer
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: A role assignment object
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
anyOf:
|
||||
- $ref: ../../beta/schemas/RoleAssignmentRef.yaml
|
||||
- $ref: ../../beta/schemas/RoleAssignmentDto.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
|
||||
112
static/api-specs/idn/v2024/paths/identities.yaml
Normal file
112
static/api-specs/idn/v2024/paths/identities.yaml
Normal file
@@ -0,0 +1,112 @@
|
||||
get:
|
||||
operationId: listIdentities
|
||||
tags:
|
||||
- Identities
|
||||
summary: List Identities
|
||||
description: This API returns a list of identities.
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:identity:read
|
||||
- idn:identity:manage
|
||||
parameters:
|
||||
- in: query
|
||||
name: filters
|
||||
schema:
|
||||
type: string
|
||||
required: false
|
||||
description: 'Filter results using the standard syntax described in [V3 API Standard
|
||||
Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
||||
|
||||
|
||||
Filtering is supported for the following fields and operators:
|
||||
|
||||
|
||||
**id**: *eq, in*
|
||||
|
||||
|
||||
**name**: *eq, sw*
|
||||
|
||||
|
||||
**alias**: *eq, sw*
|
||||
|
||||
|
||||
**firstname**: *eq, sw*
|
||||
|
||||
|
||||
**lastname**: *eq, sw*
|
||||
|
||||
|
||||
**email**: *eq, sw*
|
||||
|
||||
|
||||
**cloudStatus**: *eq*
|
||||
|
||||
|
||||
**processingState**: *eq*
|
||||
|
||||
|
||||
**correlated**: *eq*
|
||||
|
||||
|
||||
**protected**: *eq*'
|
||||
example: id eq "6c9079b270a266a60170a2779fcb0006" or correlated eq false
|
||||
- in: query
|
||||
name: sorters
|
||||
schema:
|
||||
type: string
|
||||
format: comma-separated
|
||||
required: false
|
||||
description: 'Sort results using the standard syntax described in [V3 API Standard
|
||||
Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
||||
|
||||
|
||||
Sorting is supported for the following fields: **name, alias, cloudStatus**'
|
||||
example: name,-cloudStatus
|
||||
- in: query
|
||||
name: defaultFilter
|
||||
schema:
|
||||
type: string
|
||||
enum:
|
||||
- CORRELATED_ONLY
|
||||
- NONE
|
||||
default: CORRELATED_ONLY
|
||||
required: false
|
||||
description: 'Adds additional filter to filters query parameter.
|
||||
|
||||
|
||||
CORRELATED_ONLY adds correlated=true and returns only identities that are correlated.
|
||||
|
||||
|
||||
NONE does not add any and returns all identities that satisfy filters query
|
||||
parameter.'
|
||||
example: NONE
|
||||
- $ref: ../../v3/parameters/count.yaml
|
||||
- $ref: ../../v3/parameters/limit.yaml
|
||||
- $ref: ../../v3/parameters/offset.yaml
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: List of identities.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/Identity.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
|
||||
@@ -0,0 +1,43 @@
|
||||
post:
|
||||
operationId: disableAccountForIdentity
|
||||
tags:
|
||||
- Accounts
|
||||
summary: Disable IDN Account for Identity
|
||||
description: This API submits a task to disable IDN account for a single identity.
|
||||
externalDocs:
|
||||
description: Learn more about disabling identities here
|
||||
url: https://documentation.sailpoint.com/saas/help/common/users/user_access.html#disabling-user-identities
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:accounts-state:manage
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: The identity id.
|
||||
example: 2c91808384203c2d018437e631158309
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'202':
|
||||
$ref: ../../v3/responses/202.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
|
||||
@@ -0,0 +1,43 @@
|
||||
post:
|
||||
operationId: enableAccountForIdentity
|
||||
tags:
|
||||
- Accounts
|
||||
summary: Enable IDN Account for Identity
|
||||
description: This API submits a task to enable IDN account for a single identity.
|
||||
externalDocs:
|
||||
description: Learn more about enabling identities here
|
||||
url: https://documentation.sailpoint.com/saas/help/common/users/user_access.html#enabling-user-identities
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:accounts-state:manage
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: The identity id.
|
||||
example: 2c91808384203c2d018437e631158309
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'202':
|
||||
$ref: ../../v3/responses/202.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
|
||||
137
static/api-specs/idn/v2024/paths/identity-attribute.yaml
Normal file
137
static/api-specs/idn/v2024/paths/identity-attribute.yaml
Normal file
@@ -0,0 +1,137 @@
|
||||
get:
|
||||
operationId: getIdentityAttribute
|
||||
tags:
|
||||
- Identity Attributes
|
||||
summary: Get Identity Attribute
|
||||
description: This gets an identity attribute for a given technical name.
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:identity-profile-attribute:read
|
||||
parameters:
|
||||
- in: path
|
||||
name: name
|
||||
schema:
|
||||
type: string
|
||||
description: The attribute's technical name.
|
||||
required: true
|
||||
example: displayName
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: The identity attribute with the given name
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../v3/schemas/identity-attributes/IdentityAttribute.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
|
||||
put:
|
||||
operationId: putIdentityAttribute
|
||||
tags:
|
||||
- Identity Attributes
|
||||
summary: Update Identity Attribute
|
||||
description: This updates an existing identity attribute. Making an attribute searchable
|
||||
requires that the `system`, `standard`, and `multi` properties be set to false.
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:identity-profile-attribute:create
|
||||
parameters:
|
||||
- in: path
|
||||
name: name
|
||||
schema:
|
||||
type: string
|
||||
description: The attribute's technical name.
|
||||
required: true
|
||||
example: displayName
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../v3/schemas/identity-attributes/IdentityAttribute.yaml
|
||||
responses:
|
||||
'200':
|
||||
description: The identity attribute was updated successfully
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../v3/schemas/identity-attributes/IdentityAttribute.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: deleteIdentityAttribute
|
||||
tags:
|
||||
- Identity Attributes
|
||||
summary: Delete Identity Attribute
|
||||
description: This deletes an identity attribute with the given name. The `system`
|
||||
and `standard` properties must be set to false before you can delete an identity
|
||||
attribute.
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:identity-profile-attribute:delete
|
||||
parameters:
|
||||
- in: path
|
||||
name: name
|
||||
schema:
|
||||
type: string
|
||||
description: The attribute's technical name.
|
||||
required: true
|
||||
example: displayName
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
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
|
||||
@@ -0,0 +1,42 @@
|
||||
delete:
|
||||
operationId: deleteIdentityAttributesInBulk
|
||||
tags:
|
||||
- Identity Attributes
|
||||
summary: Bulk delete Identity Attributes
|
||||
description: Use this API to bulk delete identity attributes for a given set of
|
||||
names. Attributes that are currently mapped in an identity profile cannot be deleted. The
|
||||
`system` and `standard` properties must be set to 'false' before you can delete
|
||||
an identity attribute.
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:identity-profile-attribute-bulk:delete
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../v3/schemas/identity-attributes/IdentityAttributeNames.yaml
|
||||
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
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
105
static/api-specs/idn/v2024/paths/identity-attributes.yaml
Normal file
105
static/api-specs/idn/v2024/paths/identity-attributes.yaml
Normal file
@@ -0,0 +1,105 @@
|
||||
get:
|
||||
operationId: listIdentityAttributes
|
||||
tags:
|
||||
- Identity Attributes
|
||||
summary: List Identity Attributes
|
||||
description: Use this API to get a collection of identity attributes.
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:identity-profile-attribute-list:read
|
||||
parameters:
|
||||
- in: query
|
||||
name: includeSystem
|
||||
schema:
|
||||
type: boolean
|
||||
default: false
|
||||
description: Include 'system' attributes in the response.
|
||||
required: false
|
||||
example: false
|
||||
- in: query
|
||||
name: includeSilent
|
||||
schema:
|
||||
type: boolean
|
||||
default: false
|
||||
description: Include 'silent' attributes in the response.
|
||||
required: false
|
||||
example: false
|
||||
- in: query
|
||||
name: searchableOnly
|
||||
schema:
|
||||
type: boolean
|
||||
default: false
|
||||
description: Include only 'searchable' attributes in the response.
|
||||
required: false
|
||||
example: false
|
||||
- $ref: ../../v3/parameters/count.yaml
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: List of identity attributes.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../v3/schemas/identity-attributes/IdentityAttribute.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: createIdentityAttribute
|
||||
tags:
|
||||
- Identity Attributes
|
||||
summary: Create Identity Attribute
|
||||
description: Use this API to create a new identity attribute.
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:identity-profile-attribute:create
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../v3/schemas/identity-attributes/IdentityAttribute.yaml
|
||||
responses:
|
||||
'201':
|
||||
description: The identity attribute was created successfully.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../v3/schemas/identity-attributes/IdentityAttribute.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
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
57
static/api-specs/idn/v2024/paths/identity-ownership.yaml
Normal file
57
static/api-specs/idn/v2024/paths/identity-ownership.yaml
Normal file
@@ -0,0 +1,57 @@
|
||||
get:
|
||||
operationId: getIdentityOwnershipDetails
|
||||
summary: Get ownership details
|
||||
tags:
|
||||
- Identities
|
||||
description: "Use this API to return an identity's owned objects that will cause\
|
||||
\ problems for deleting the identity. \nUse this API as a checklist of objects\
|
||||
\ that you need to reassign to a different identity before you can delete the\
|
||||
\ identity. \nFor a full list of objects owned by an identity, use the [Search\
|
||||
\ API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search\
|
||||
\ for identities, the returned identities have a property, `owns`, that contains\
|
||||
\ a more comprehensive list of identity's owned objects."
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:identity:read
|
||||
parameters:
|
||||
- in: path
|
||||
name: identityId
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: Identity ID.
|
||||
example: ff8081814d2a8036014d701f3fbf53fa
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: Identity's ownership association details.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/IdentityOwnershipAssociationDetails.yaml
|
||||
example:
|
||||
associationDetails:
|
||||
associationType: ROLE_OWNER
|
||||
entities:
|
||||
- id: b660a232f05b4e04812ca974b3011e0f
|
||||
name: Gaston.800ddf9640a
|
||||
type: ROLE
|
||||
'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
|
||||
@@ -0,0 +1,48 @@
|
||||
post:
|
||||
operationId: generateIdentityPreview
|
||||
tags:
|
||||
- Identity Profiles
|
||||
summary: Generate Identity Profile Preview
|
||||
description: 'This generates a non-persisted IdentityDetails object that will represent
|
||||
as the preview of the identities attribute when the given policy''s attribute
|
||||
config is applied.
|
||||
|
||||
A token with ORG_ADMIN authority is required to call this API to generate an identity
|
||||
preview.'
|
||||
requestBody:
|
||||
description: Identity Preview request body.
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/IdentityPreviewRequest.yaml
|
||||
responses:
|
||||
'200':
|
||||
description: Object representing the preview object with all of the identity
|
||||
attributes using the current mappings.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/IdentityPreviewResponse.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:identity-profile:manage
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
43
static/api-specs/idn/v2024/paths/identity-reset.yaml
Normal file
43
static/api-specs/idn/v2024/paths/identity-reset.yaml
Normal file
@@ -0,0 +1,43 @@
|
||||
post:
|
||||
operationId: resetIdentity
|
||||
tags:
|
||||
- Identities
|
||||
summary: Reset an identity
|
||||
description: Use this endpoint to reset a user's identity if they have forgotten
|
||||
their authentication information like their answers to knowledge-based questions.
|
||||
Resetting an identity de-registers the user and removes any elevated user levels
|
||||
they have.
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:identity:update
|
||||
parameters:
|
||||
- in: path
|
||||
name: identityId
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: Identity Id
|
||||
example: ef38f94347e94562b5bb8424a56397d8
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'202':
|
||||
description: Accepted. The reset request accepted and is in progress.
|
||||
'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
|
||||
@@ -0,0 +1,48 @@
|
||||
post:
|
||||
operationId: synchronizeAttributesForIdentity
|
||||
tags:
|
||||
- Identities
|
||||
summary: Attribute synchronization for single identity.
|
||||
description: This end-point performs attribute synchronization for a selected identity.
|
||||
The endpoint can be called once in 10 seconds per identity. A token with ORG_ADMIN
|
||||
or API authority is required to call this API.
|
||||
parameters:
|
||||
- in: path
|
||||
name: identityId
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: The Identity id
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'202':
|
||||
description: An Identity Sync job
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/IdentitySyncJob.yaml
|
||||
example:
|
||||
id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3dfc
|
||||
status: IN_PROGRESS
|
||||
payload:
|
||||
type: SYNCHRONIZE_IDENTITY_ATTRIBUTES
|
||||
dataJson: '{"identityId":"2c918083746f642c01746f990884012a"}'
|
||||
'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
|
||||
98
static/api-specs/idn/v2024/paths/identity.yaml
Normal file
98
static/api-specs/idn/v2024/paths/identity.yaml
Normal file
@@ -0,0 +1,98 @@
|
||||
get:
|
||||
operationId: getIdentity
|
||||
tags:
|
||||
- Identities
|
||||
summary: Identity Details
|
||||
description: This API returns a single identity using the Identity ID.
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:identity:read
|
||||
- idn:identity:manage
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: Identity Id
|
||||
example: ef38f94347e94562b5bb8424a56397d8
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: An identity object
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/Identity.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: deleteIdentity
|
||||
tags:
|
||||
- Identities
|
||||
summary: Delete identity
|
||||
description: The API returns successful response if the requested identity was deleted.
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:identity:delete
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: Identity Id
|
||||
example: ef38f94347e94562b5bb8424a56397d8
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'204':
|
||||
$ref: ../../v3/responses/204.yaml
|
||||
'400':
|
||||
description: Client Error - Returned if the request is invalid. It may indicate
|
||||
that the specified identity is marked as protected and cannot be deleted.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/IdentityAssociationDetails.yaml
|
||||
example:
|
||||
message: Identity is the owner of following resources
|
||||
associationDetails:
|
||||
associationType: CAMPAIGN_OWNER
|
||||
entities:
|
||||
- id: b660a232f05b4e04812ca974b3011e0f
|
||||
name: Gaston.800ddf9640a
|
||||
type: CAMPAIGN_CAMPAIGNER
|
||||
'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
|
||||
61
static/api-specs/idn/v2024/paths/load-accounts.yaml
Normal file
61
static/api-specs/idn/v2024/paths/load-accounts.yaml
Normal file
@@ -0,0 +1,61 @@
|
||||
post:
|
||||
tags:
|
||||
- Sources
|
||||
summary: Account Aggregation
|
||||
operationId: importAccounts
|
||||
description: "Starts an account aggregation on the specified source. \nIf the target\
|
||||
\ source is a delimited file source, then the CSV file needs to be included in\
|
||||
\ the request body.\nYou will also need to set the Content-Type header to `multipart/form-data`.\n\
|
||||
A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required\
|
||||
\ to call this API."
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:sources:manage
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: Source Id
|
||||
example: ef38f94347e94562b5bb8424a56397d8
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
requestBody:
|
||||
content:
|
||||
multipart/form-data:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
file:
|
||||
type: string
|
||||
format: binary
|
||||
description: The CSV file containing the source accounts to aggregate.
|
||||
disableOptimization:
|
||||
type: string
|
||||
example: 'true'
|
||||
description: Use this flag to reprocess every account whether or not
|
||||
the data has changed.
|
||||
responses:
|
||||
'202':
|
||||
description: Aggregate Accounts Task
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/LoadAccountsTask.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
|
||||
@@ -0,0 +1,65 @@
|
||||
post:
|
||||
tags:
|
||||
- Entitlements
|
||||
summary: Aggregate Entitlements
|
||||
deprecated: true
|
||||
operationId: importEntitlementsBySource
|
||||
description: 'Starts an entitlement aggregation on the specified source. Though
|
||||
this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements).
|
||||
|
||||
|
||||
If the target source is a direct connection, then the request body must be empty.
|
||||
You will also need to make sure the Content-Type header is not set. If you set
|
||||
the Content-Type header without specifying a body, then you will receive a 500
|
||||
error.
|
||||
|
||||
|
||||
If the target source is a delimited file source, then the CSV file needs to be
|
||||
included in the request body. You will also need to set the Content-Type header
|
||||
to `multipart/form-data`.'
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: Source Id
|
||||
example: ef38f94347e94562b5bb8424a56397d8
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
requestBody:
|
||||
content:
|
||||
multipart/form-data:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
csvFile:
|
||||
type: string
|
||||
format: binary
|
||||
description: The CSV file containing the source entitlements to aggregate.
|
||||
responses:
|
||||
'202':
|
||||
description: Aggregate Entitlements Task
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/LoadEntitlementTask.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:entitlements:manage
|
||||
@@ -0,0 +1,52 @@
|
||||
post:
|
||||
tags:
|
||||
- Sources
|
||||
summary: Process Uncorrelated Accounts
|
||||
operationId: importUncorrelatedAccounts
|
||||
description: File is required for upload. You will also need to set the Content-Type
|
||||
header to `multipart/form-data`
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:sources:manage
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: Source Id
|
||||
example: 75dbec1ebe154d5785da27b95e1dd5d7
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
requestBody:
|
||||
content:
|
||||
multipart/form-data:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
file:
|
||||
type: string
|
||||
format: binary
|
||||
responses:
|
||||
'202':
|
||||
description: Uncorrelated Accounts Task
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/LoadUncorrelatedAccountsTask.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
|
||||
43
static/api-specs/idn/v2024/paths/mail-from-attribute.yaml
Normal file
43
static/api-specs/idn/v2024/paths/mail-from-attribute.yaml
Normal file
@@ -0,0 +1,43 @@
|
||||
get:
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- sp:notification-mail-from-attributes:read
|
||||
operationId: getMailFromAttributes
|
||||
tags:
|
||||
- Notifications
|
||||
summary: Get MAIL FROM Attributes
|
||||
description: Retrieve MAIL FROM attributes for a given AWS SES identity.
|
||||
parameters:
|
||||
- in: query
|
||||
name: id
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Returns the MX and TXT record to be put in your DNS, as well as the
|
||||
MAIL FROM domain status
|
||||
example: bobsmith@sailpoint.com
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: MAIL FROM Attributes object
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/MailFromAttributes.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
|
||||
45
static/api-specs/idn/v2024/paths/mail-from-attributes.yaml
Normal file
45
static/api-specs/idn/v2024/paths/mail-from-attributes.yaml
Normal file
@@ -0,0 +1,45 @@
|
||||
put:
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- sp:notification-mail-from-attributes:write
|
||||
operationId: putMailFromAttributes
|
||||
tags:
|
||||
- Notifications
|
||||
summary: Change MAIL FROM domain
|
||||
description: Change the MAIL FROM domain of an AWS SES email identity and provide
|
||||
the MX and TXT records to be placed in the caller's DNS
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/MailFromAttributesDto.yaml
|
||||
example:
|
||||
identity: BobSmith@sailpoint.com
|
||||
mailFromDomain: example.sailpoint.com
|
||||
responses:
|
||||
'200':
|
||||
description: MAIL FROM Attributes required to verify the change
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/MailFromAttributes.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
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
@@ -0,0 +1,142 @@
|
||||
get:
|
||||
operationId: getNativeChangeDetectionConfig
|
||||
tags:
|
||||
- Sources
|
||||
summary: Native Change Detection Configuration
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:sources:read
|
||||
description: 'This API returns the existing native change detection configuration
|
||||
for a source specified by the given ID.
|
||||
|
||||
A token with ORG_ADMIN authority is required to call this API.'
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: The source id
|
||||
example: 2c9180835d191a86015d28455b4a2329
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: Native change detection configuration for a source
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/NativeChangeDetectionConfig.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
|
||||
put:
|
||||
operationId: putNativeChangeDetectionConfig
|
||||
tags:
|
||||
- Sources
|
||||
summary: Update Native Change Detection Configuration
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:sources:update
|
||||
description: "Replaces the native change detection configuration for the source\
|
||||
\ specified by the given ID with the configuration provided in the request body.\n\
|
||||
\ \nA token with ORG_ADMIN authority is required to call this API."
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: The source id
|
||||
example: 2c9180835d191a86015d28455b4a2329
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/NativeChangeDetectionConfig.yaml
|
||||
responses:
|
||||
'200':
|
||||
description: Updated native change detection configuration for a source
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/NativeChangeDetectionConfig.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: deleteNativeChangeDetectionConfig
|
||||
tags:
|
||||
- Sources
|
||||
summary: Delete Native Change Detection Configuration
|
||||
description: 'Deletes the native change detection configuration for the source specified
|
||||
by the given ID.
|
||||
|
||||
A token with API, or ORG_ADMIN authority is required to call this API.'
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:sources:update
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: The source id
|
||||
example: 2c9180835d191a86015d28455b4a2329
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
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
|
||||
@@ -0,0 +1,39 @@
|
||||
get:
|
||||
operationId: listNotificationPreferences
|
||||
tags:
|
||||
- Notifications
|
||||
summary: List Notification Preferences for tenant.
|
||||
description: Returns a list of notification preferences for tenant.
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:notification-preferences:read
|
||||
responses:
|
||||
'200':
|
||||
description: Return preference for the given notification key.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/PreferencesDto.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
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
@@ -0,0 +1,39 @@
|
||||
get:
|
||||
operationId: getNotificationsTemplateContext
|
||||
tags:
|
||||
- Notifications
|
||||
summary: Get Notification Template Context
|
||||
description: "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\n that will be available per\
|
||||
\ tenant (organization)."
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:notification-templates:read
|
||||
responses:
|
||||
'200':
|
||||
description: Notification template context attributes for a specific tenant.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/NotificationTemplateContext.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
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
@@ -0,0 +1,59 @@
|
||||
get:
|
||||
operationId: listNotificationTemplateDefaults
|
||||
tags:
|
||||
- Notifications
|
||||
summary: List Notification Template Defaults
|
||||
description: 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
|
||||
- in: query
|
||||
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)
|
||||
|
||||
|
||||
Filtering is supported for the following fields and operators:
|
||||
|
||||
|
||||
**key**: *eq, in, sw*
|
||||
|
||||
|
||||
**medium**: *eq, sw*
|
||||
|
||||
|
||||
**locale**: *eq, sw*'
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: A list of the default template objects
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/TemplateDtoDefault.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
|
||||
43
static/api-specs/idn/v2024/paths/notification-template.yaml
Normal file
43
static/api-specs/idn/v2024/paths/notification-template.yaml
Normal file
@@ -0,0 +1,43 @@
|
||||
get:
|
||||
operationId: getNotificationTemplate
|
||||
tags:
|
||||
- Notifications
|
||||
summary: Get Notification Template By Id
|
||||
description: This gets a template that you have modified for your site by Id.
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: Id of the Notification Template
|
||||
required: true
|
||||
style: simple
|
||||
explode: false
|
||||
schema:
|
||||
type: string
|
||||
example: c17bea3a-574d-453c-9e04-4365fbf5af0b
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: A template object for your site
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/TemplateDto.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
|
||||
@@ -0,0 +1,40 @@
|
||||
post:
|
||||
operationId: deleteNotificationTemplatesInBulk
|
||||
tags:
|
||||
- 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, please contact support to enable usage.
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:notification-templates:delete
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/TemplateBulkDeleteDto.yaml
|
||||
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
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
104
static/api-specs/idn/v2024/paths/notification-templates.yaml
Normal file
104
static/api-specs/idn/v2024/paths/notification-templates.yaml
Normal file
@@ -0,0 +1,104 @@
|
||||
get:
|
||||
operationId: listNotificationTemplates
|
||||
tags:
|
||||
- Notifications
|
||||
summary: List Notification Templates
|
||||
description: 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
|
||||
- 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:
|
||||
|
||||
|
||||
**key**: *eq, in, sw*
|
||||
|
||||
|
||||
**medium**: *eq, sw*
|
||||
|
||||
|
||||
**locale**: *eq, sw*'
|
||||
example: medium eq "EMAIL"
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: A list of template objects for your site
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/TemplateDto.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: createNotificationTemplate
|
||||
tags:
|
||||
- Notifications
|
||||
summary: Create Notification Template
|
||||
description: "This creates a template for your site. \n\nYou 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:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/TemplateDto.yaml
|
||||
responses:
|
||||
'200':
|
||||
description: A template object for your site
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/TemplateDto.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
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
@@ -0,0 +1,47 @@
|
||||
get:
|
||||
operationId: getValidTimeZones
|
||||
tags:
|
||||
- Org Config
|
||||
summary: Get list of time zones
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:org-configs:read
|
||||
- idn:org-configs-user:read
|
||||
description: Get a list of valid time zones that can be set in org configurations.
|
||||
responses:
|
||||
'200':
|
||||
description: Request successful
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
example:
|
||||
- Etc/GMT-6
|
||||
- Etc/GMT+8
|
||||
- EST
|
||||
- America/Chicago
|
||||
- America/Toronto
|
||||
- Asia/Gaza
|
||||
- Europe/Brussels
|
||||
- Europe/Kiev
|
||||
'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
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
91
static/api-specs/idn/v2024/paths/org-config.yaml
Normal file
91
static/api-specs/idn/v2024/paths/org-config.yaml
Normal file
@@ -0,0 +1,91 @@
|
||||
get:
|
||||
operationId: getOrgConfig
|
||||
tags:
|
||||
- Org Config
|
||||
summary: Get Org configuration settings
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:org-configs:read
|
||||
- idn:org-configs:manage
|
||||
description: Get org configuration with only external (org admin) accessible properties
|
||||
for the current org.
|
||||
responses:
|
||||
'200':
|
||||
description: Request succeeded.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/OrgConfig.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
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
patch:
|
||||
operationId: patchOrgConfig
|
||||
tags:
|
||||
- Org Config
|
||||
summary: Patch an Org configuration property
|
||||
security:
|
||||
- UserContextAuth:
|
||||
- idn:org-configs:manage
|
||||
description: Patch configuration of the current org using http://jsonpatch.com/
|
||||
syntax. Commonly used for changing the time zone of an org.
|
||||
requestBody:
|
||||
description: A list of schema attribute update operations according to the [JSON
|
||||
Patch](https://tools.ietf.org/html/rfc6902) standard.
|
||||
content:
|
||||
application/json-patch+json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/JsonPatchOperation.yaml
|
||||
example:
|
||||
- op: replace
|
||||
path: /timeZone
|
||||
value: America/Toronto
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: The Org was successfully patched.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/OrgConfig.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
|
||||
parameters:
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
@@ -0,0 +1,56 @@
|
||||
get:
|
||||
operationId: getOutlierContributingFeatureSummary
|
||||
tags:
|
||||
- IAI Outliers
|
||||
summary: Get identity outlier contibuting feature summary
|
||||
description: 'This API returns a summary of a contributing feature for an identity
|
||||
outlier. The object contains: contributing feature name (translated text or message
|
||||
key), identity outlier display name, feature values, feature definition and explanation
|
||||
(translated text or message key), peer display name and identityId, access item
|
||||
reference, translation messages object
|
||||
|
||||
Requires authorization scope of ''iai:outliers-management:read'''
|
||||
parameters:
|
||||
- in: path
|
||||
name: outlierFeatureId
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: Contributing feature id
|
||||
example: 04654b66-7561-4090-94f9-abee0722a1af
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: Succeeded. Returns selected contributing feature summary for an
|
||||
outlier
|
||||
headers:
|
||||
accept-language:
|
||||
description: The locale to use for translations
|
||||
schema:
|
||||
type: string
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../beta/schemas/OutlierFeatureSummary.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:
|
||||
- iai:outliers-management:read
|
||||
@@ -0,0 +1,50 @@
|
||||
get:
|
||||
operationId: getLatestIdentityOutlierSnapshots
|
||||
tags:
|
||||
- IAI Outliers
|
||||
summary: IAI Identity Outliers Latest Summary
|
||||
description: 'This API returns a most recent snapshot of each outlier type, each
|
||||
containing: the number of identities that customer has, the number of outliers,
|
||||
and the type of outlier
|
||||
|
||||
Requires authorization scope of ''iai:outliers-management:read'''
|
||||
parameters:
|
||||
- name: type
|
||||
in: query
|
||||
description: Type of the identity outliers snapshot to filter on
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
enum:
|
||||
- LOW_SIMILARITY
|
||||
- STRUCTURAL
|
||||
- name: X-SailPoint-Experimental
|
||||
in: header
|
||||
description: Use this header to enable this experimental API.
|
||||
example: true
|
||||
schema:
|
||||
type: string
|
||||
default: true
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: Succeeded. Returns list of objects. Each object is a summary to
|
||||
give high level statistics/counts of outliers
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../beta/schemas/LatestOutlierSummary.yaml
|
||||
'202':
|
||||
$ref: ../../v3/responses/202.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
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user