LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-10 20:37:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e8c6d4aad70eef6d6870aafd342c04847f4cdba0
developer.sailpoint.com/docs/api/v3/get-connector.api.mdx
darrell-thobe-sp e8c6d4aad7 merge main and fix conflicts
2024-03-06 16:17:34 -05:00

102 lines
50 KiB
Plaintext
Raw Blame History

---
id: get-connector
sidebar_label: getConnector
hide_title: true
hide_table_of_contents: true
api: eJztXHtz2za2/yq46h9JOpbkV5ONx05HsZWsWr9qyc3ea2VciIQkJCTIkqBt2ePvvr8DgC9Ljh03vd3tKDOxJBA473NwDgDipqH5JG1snTV2I6WEp6MkbXxcaUSxSLiWker5ja3GROjicWOl4YvUS2RMj/HwndDeVKSMMy/vw/SUa5alUk2Y1Cmz3ZnioWgNVYfp6LNQ7FLqKTs6eX/e2TvoHTKe6WmUSD1jMmWJ+D2TifDRlXk8CAARrZ3jXgv4Y54AkhYJEX7TILCgwyI5pB8rDUmUxVxP58gdTAUru7ILHmSCRWMgECUDLdY3XQg0kUMPMyV/R1fps4lQJB1QBy5Lpr1EGJERiTn9jS2dZGKlkepZYIiUYRwQgeIqDiIfTWMepNQBMgx5Y+umoWex6akTiM/05GbMVoP3SxZvb1duLJcgKpmhnxNDEEFehOELEFUWksp96qYi/BlLGnBBhGckYI0/n+nB9bQ5+GCGkFCpeZzY5t1DfE6pt0jxx6M/nzgNDkjm9E0FZEol/cB3u0gdlmRSNY/jYEZfnDbGctJivTFTEbuQfBQUfaGTibwQagX2BUOCgfhizLNA0+AhyB02GrcfSQ9pHKkUJEIO66ur9FEnoMMK02Z7GByNPuEHcRQpLZSmEUSW9Ixy259SGnYzL95iYJyQ92hpkVq1zCthXgylJSlrxKXkTANkZ4F8HTDTtwqsL5IL6YnD6JJAegFP08MnEGkGzpNaab5dqTrlV4KvxIwa/NRSryz1Fc38Kwy+FkdlNLsKgxqe7R/Rwi4QZPB059laa/UZE8qLfIDdeXY6eNf8x7Mf3wzV9v/sHe0O/ve4yzoVaMenb/d7u7DElMsgjqTSLV/7w8Z8C4Gojiyo26l2LSPTUSxUYbEdn8eIg4BLcsIIL0t1FLKOJi1Irlg/k1qwJtsNoozwk3ge0a8Nsox1REkiAkPZrnHHJ0i5AsP59B8QdhMkRvEskZOpZs93X7D11fU11oegjklQbCC8qYqCaAL3W2E95bUY6yA8mAE0r5D9CL/Fmk3Aq6pv9y6rX6dEgJqH8CitsI7nRRlor4xnFoCFrLc7GoIeZVp0MH6iQsSl1DzBs3cygAmwYsYGvu4vINKFoRl+I1DJAE1mssNv+7P9VRDinl+BgN9BNBPiMAtHZH9fA8uXaRzwGQWFCkRP5VC22/ewu92ek7Az0zTKEk882ULt8McZ57AB6wTdhXkOG8Y+0ZRqrnweRIr4UdGw8eObxQa78USD3X4XJSHRp1JgmGodb7Xbl5eXrWqgCNtXqd8uWs7HGHO+fr7aQjOILLg+fGTE8JHHeHn+hwGU0KB5LANxCiPgftnmzH33IZAQlM6IBShT8FRUAlO/oklj/Qz/tt+iU6Fw5v7B1kTgs5BfwegEgVsjxeB3X14TrI3V1ZKokl4iIIvjKEEG173CHE96peGfeFISQv2zvD+MVPrI+H7qHx3SM8rZrLkaQtp36KNowMheSV9v7hroH7LOpWUuLfNPs8x3SRT+sdiJAm4iVT1hi5uut0G3sR/ZTOdhRNBVwieCUR3HPosZG5vSErm/V6lGK6mn0W6zeNhOiyKOUFuZCd/opIKdJwmfLeQykKmm2jAfaUwrLXXERrO7dWPPVJKJYJccJbGaMXElvEyb2sWOLoDZMqc2ejCLJZW7M8vmSDBMtKiIuS1BK7DwqACEKjTXQqUEVVkQUNe8BIWhh+m80G8rEjxrxJHfjpJJu6DJCKutRapLsdKvtRZssvHxdqVivhXgoyiC/6g5qRIpTNpq29EMPgmEY6eqUEu3K+xcpUwFZNXtn4yTu/CRi989egR+nXCV2iTkuFbq3S0E7xaaIY8Jm+ZS0cpIBQ5U6DKelGwKgjBVLmweYLjvS+rEgyo6S1xBK5W1QPLdfEjffEJIH6rv2N4ROzwasO5ebwDDnOZqosq7WP8ArZVceOAYEiaYhyHmHEBC9pbt85EIzp3KwEpfaA0RpDu/imQklZ/hu5Aq1SII8B3le2VYZzJJxITXxlXa7g5MLQo3NoPWlXbF1SPQ1kc/CXNPjaP7EP9swmSWSIQIzD4SPi2VMKb4GRNRSRe7vpS0xKCYj3T6lwxYBNsTAXpz1hdwdM2okMfDI9U8TkQoU1qj8lnPJ7x6hvq+tT1K3tD/92Lk0I2EZNtw/UhN3vyfkHo4zFZXxx6SeGBL0EC4qVNJynbb9QeZgiYxGfKAiSTg2Qg0ExSfZyDkuVTsQCpYsXrBxg5yYkZVGLuAuVdoZKHUVR4hjwVkE4yc7H9GqW6enuxX6MJwJ5tmf7d30LSS+f2LEPGZQ+wc95oDWpOsg3QUXWcJy9U5ltdQHbFBUO+ofIG11DnoVu2lIqEeJM8qwzFxLKAY0vUxEbyj1KIgvQ/pCzVJLKyX5sMfi7rOOuqaTwNAZbA/HYF0bQeITSIEv1dMP56NjT0m9PdaBIowEwLGDXFgXbNLkZDs0giywbhLoRSbJFGOme1xSlwceH0NzhFXpzCWMa35msGGuSHSkDp/YcGVIXNsSsk6J28FZbZ35Uf0VIaQ+NATZSbSsC2WIaiZtd70EtGqP2wsEG2J+n2C2V2oRchrj0YVSur4KvVtgRKmgjZP/DMKYFnn3PMq6t6Zo7Dee5LE1d6L4NcHTOEhO5SEp8jCb5xnnJNnnFvPMD1u2xfrQ+VH3r5Un78YLg/ENGFlpGD3h88aNLsWMD/cqKppglVNpENFrg3P3sldfKjKOWMgQxFleueRUWuo4NXng6Ofu4c7hX8PFeXJx8gnD3gcU41Ev5vU0MwXHZru0VBZ+kGBnX+RMruVGhPHc2tb1O99EmUxvL/O3TGS2XNTAdzjtUPVN6vKxfrHjv1d0Gbpp3zYET5GEaD6U2Sje0g2dvYQH3pKi4ldfEnDyM+CWrQtnebByWQkhcYDsvwDR+gkkN70M4h3YQKpCHn1+whDFVfIrEr4P5v186qWW6yL9FeRTeQa1NcaUSfnH7EhNDGuq/wmTIQ+9slJ0+vZ5yBLoRoFGdJ6UIt2QBpFTnogNEcZtHA9/oE0LHRDmUmtEPJ0vgFx2qNvlGmjEHx8IlaUB6c94Ov+a/BT32yLcE0FL9UpHtU6aa41ainKqSqxxKEtSL+0i7PXPT7p7nYG3T007nV/7e4fHR90Dwfm18ERPk66+91OH88/PlDKWVzVkqoYSrTAhkxjsfy8B9HJAM/o6eai3ZXdQJJAu0kC+E12InSWKCSOLh2nbTIUE2wU+WbbTypTz7a+3faLb0jcNVttD9Wb76D9JlxHEoXCkOxhIK1dXkjf2EqUUOZAIPM9Q9OvVRMaJNFaY2+5D34tf7uOGVs9eJ8Bq+c/TNCp3XLMh9Deoy2BF6IVrwQfvVx9vb45frnJ+fo/Ntde/TB6PeYbG6uvf3j9mrCHIk3hQQ+Xv+8px5ee3W9DyPKhKw7ZGwIM8sZ8SXmPDtyW5KMWFtz+Xs6mo5dpcaVXULO93T1mm69YwDH1mnY+uSME1Tztz1W/4NwCPrLrE190p3ed0/2BcZtfTrt9fCNYc67TUbBWn8wSpMIWpgiuumSAyv9UBBAHrZB976B+D4ZQI1U7ut3ldIZpNMx3MTHCYV8wogqajZMorLmS8ZsrVH+yJVoriF5oC7n2pmxE61kMKqTu32MqE7Fu7jtJfs+mgiN3eNFinSLM2cX5FONnFAYR/8h1LYBxBlcWZhMfszJTEbIGUddFKcq7axF5JNmvKoWcA5Q/bCcdT2cgzrBZ9cLCWhyJTj+g2UquTt2gIjQj0hmmBE+79RezaeUhMoE3OsLgwhGpK0XgUXm/ImJVA6QJdweWmD0d2amKZ+kj/O44QPhpGtaKBxfCOV9K85GNRkYbuZpcRHLTlhnsehXqyh0fRTzqh6XvLn136buP9N27D0/cmRL31KQ+a/Opz6lyJ5po8pxLfRJjPSrKjz1d28LfKnKFQSAuRfrpw8Cdl0J/cRXTqaJvmB/ZqXzBqZhcH7Z9ZBYsc2XVdEEEul0I4mCMSCT8LUN3SbERlBXVxjw2VEwj6VMVP58iUm3MZlHGOESWZMrk7DxdYX4kUvVMsylHfERBDXptBCSsKBzsrtMyk1xmksvZaDkb/W1mo2UmufTdpe/+d/ruFzPJgirjLS5PSrMw5MnMWpp7Ttxyhg4sP91cHlo2qrqbrRAwVuRYjXrm0Bitr43Wxq88senzTf/lxuvxuvdynf/wau3V2mhz/VWjOteflX5cOFndpyr6tnq0J+7t6nKmfFr8jSK/vvwH8SZiTGHNnALP82bIHCL9WOaOm/O542GkwRutMjcBY/Hy4unJPsEHagOe5GbPAZDTGtHZNxYopSQbhqRl+g3PgC9Tx2XquJx+ltPPMnVcpo5L31367p+dOm4+lDpufkXquMkoxRpTivVXpo4+8g5KzcZQCr1rmkG8itLGmE4tQvJ29dG5vebJROgi0atlkeuv57PIQRSxAzqu65KltLYSqUpxUXhD35D6JnlfdOD2fUQ6RCCR3ZJVyZBOltNBSRbIUBo/JoYAN5k1O2M6qWR9Jre3AotUXpCBQhMUgojWXiPYmIQ5iTGlf4Bg1kEnCNTfcI3TaesPrQezE+J4nzhm3StPCPL5Yv33h0WnBOjISkLhwh1Cuee4gF0z53SmRFzFNnwVKegyVV+m6svpfjnd/z2m+2WqvvTdpe/+d/ruV6TqLhu6P1VHh0en6ujbWmVFLvXOvLX0/52xG1dxFNgLOSLP5Op+mYPTsVaBRqlnBslpak5PEwQ6gE6eKX21VRxMbdqXC7cQ1PzGR7rWIxSwRHczDYUguuhlq1G+tZa2b8qbJ24bKw1bRFiesiRA5+J4PFQNFd+2eCxb0p2UVtGleV/1YmNB4KJzqtZJEfr8zBxOp6tpXKXSMgpKzHUlNmAaBFZd7lWy8p2pL8I318/ADmYoYpgFs0JvgTp7NM0gM0Yx8szeudEy9jfHI3g7TYLbh/j5deNLfFgg9/CxSHxfxIX+DFTeYY/I/1iahzn+brHPGUk5E9F+wfocsiPqts7eCp7QSXVzhOb5Tx8GLyrvr9krioSk4gLedgwTMbGwkx8noUFmekqibDI1hHdqB3bI99g4AMNsqPpCsLPqafsTRHUj0vqLFR+f55rxxYUIaP6886I07L8NCbV5bdwLM1eaokIqOkxuX/YcqibbMy8z0pl/08exaGpEdhbnfPEKX08l4rscWtNCaxpo6Ys7VFjRnnn2ALiHAEAgeJAaaT0ZuYXXrMCjCgwtBPUuDSQJR0f9mJWXa+3JdNTgNQlenY6h+jCVmIjrw5gNXCzFPBr4rMe8aRSl4kfGyHTIDc4mGbzoyWRdEtKm8Yjm+mqFpKZF2ZRNpJWGvn04hrLGxEc0rZusJrILLMYlfzOahc//hqLbZ7/VeDbNZ5h9qacfeemTaSaETULYtDEgdfTbyY0MC75NPJg4YA1gt9S/iQSO0ErMs7AWRnUDvm3G0NTggVQDJY237I+tMsDl10qZB9S76IMQTFl5cfCMbilzsGiGqwkrX0+4K8F5eundXHVHbpbeYleUJtv/NH6J48otRkcqmH3rKH1PJPnPibt/UcRbRpq/Y6RxeTKZm0HrCoqqkdtsbX4RkFappwJ/8dR4qknIUe7YGxcph6mCyV9MMz7tTaUwywex4OaiiRWyqyg0foh0l5wfRaIBNKHLJgTd1MZR8MkA8FrsgzD3z2Tm4g46tguonyJXpJUXEezlikMCFYaZomsfQUQW0mUWD2nXl6mX2SCUX95gCIpMGleMyj2SzIZE0TJVShKmR2N3BV5FiQ/ggg5Tt8jM7aUT7rrFkpETdzEV9aun3w/BhuU0pyKIqToM6G67VFQwHPQGcxABTLmdDbqtww1K29QXQNyNQBiw0UJNSE1xlGqUshW4tD9y762eN+V6+l9wwaebMijXb8e0wGWub7G1h631zspXJkneW5V7BlE+0NvN1OfmhtZBqPK5pWZ7UyaVgJA8GbdfXL95L/OVdapvfT/lPXzSpR+VazxdrW+vs8zrsa9k4vmJk/YLswH1519/upCxfB1Tzaps5QxXNHhL18rYJSrDqO1gF7EqQ+e2eWorA++75Db8niTEfdk6oyWJfwMrSolm
sidebar_class_name: "get api-method"
info_path: docs/api/v3/identitynow-v-3-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'getConnector' (get-connector)"
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
<h1 className={"openapi__heading"}>getConnector</h1>
<MethodEndpoint method={"get"} path={"/connectors/{scriptName}"}></MethodEndpoint>
Fetches a connector that using its script name.
A token with ORG_ADMIN authority is required to call this API.
## Request
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"scriptName","in":"path","description":"The scriptName value of the connector. Scriptname is the unique id generated at connector creation.","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"aScriptName"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"locale","schema":{"type":"string","enum":["de","no","fi","sv","ru","pt","ko","zh-TW","en","it","fr","zh-CN","hu","es","cs","ja","pl","da","nl"],"example":"de"},"description":"The locale to apply to the config. If no viable locale is given, it will default to \"en\""}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
A Connector Dto object
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The connector name","example":"name"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The connector type","example":"ServiceNow"}}></SchemaItem><SchemaItem collapsible={false} name={"className"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The connector class name","example":"class name"}}></SchemaItem><SchemaItem collapsible={false} name={"scriptName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The connector script name","example":"servicenow"}}></SchemaItem><SchemaItem collapsible={false} name={"applicationXml"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The connector application xml","example":"<?xml version='1.0' encoding='UTF-8'?>\n<!DOCTYPE Application PUBLIC \"sailpoint.dtd\" \"sailpoint.dtd\">\n<Application connector=\"sailpoint.connector.OpenConnectorAdapter\" name=\"custom Atlassian Suite - Cloud\" type=\"custom Atlassian Suite - Cloud\"/>\n"}}></SchemaItem><SchemaItem collapsible={false} name={"correlationConfigXml"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The connector correlation config xml","example":"<?xml version='1.0' encoding='UTF-8'?>\n<!-- Copyright (C) 2021 SailPoint Technologies, Inc. All rights reserved. -->\n\n<!DOCTYPE CorrelationConfig PUBLIC \"sailpoint.dtd\" \"sailpoint.dtd\">\n\n<CorrelationConfig name=\"custom Atlassian Suite - Cloud Account Correlation Config\">\n\t<AttributeAssignments>\n\t\t<Filter operation=\"EQ\" property=\"email\" value=\"mail\"/>\n\t\t<Filter operation=\"EQ\" property=\"empId\" value=\"employeeNumber\"/>\n\t\t<Filter operation=\"EQ\" property=\"displayName\" value=\"cn\"/>\n\t</AttributeAssignments>\n</CorrelationConfig>\n"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceConfigXml"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The connector source config xml","example":"<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?><!-- Copyright (C) 2023 SailPoint Technologies, Inc. All rights reserved. --><Form xmlns=\"http://www.sailpoint.com/xsd/sailpoint_form_2_0.xsd\" connectorName=\"custom Atlassian Suite - Cloud\" directConnect=\"true\" fileUpload=\"true\" name=\"Custom Atlassian Suite - Cloud\" status=\"released\" type=\"SourceConfig\">\n <BaseConfig>\n <Field maxFiles=\"10\" maxSize=\"300\" name=\"fileUpload\" supportedExtensions=\"jar\" type=\"fileupload\" validateJSON=\"false\"/>\n </BaseConfig>\n \n\n \n</Form>"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceConfig"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The connector source config","example":"<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?><!-- Copyright (C) 2023 SailPoint Technologies, Inc. All rights reserved. --><Form xmlns=\"http://www.sailpoint.com/xsd/sailpoint_form_2_0.xsd\" connectorName=\"custom Atlassian Suite - Cloud\" directConnect=\"true\" fileUpload=\"true\" name=\"Custom Atlassian Suite - Cloud\" status=\"released\" type=\"SourceConfig\">\n <BaseConfig>\n <Field maxFiles=\"10\" maxSize=\"300\" name=\"fileUpload\" supportedExtensions=\"jar\" type=\"fileupload\" validateJSON=\"false\"/>\n </BaseConfig>\n \n\n \n</Form>"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceConfigFrom"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The connector source config origin","example":"sp-connect"}}></SchemaItem><SchemaItem collapsible={false} name={"s3Location"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"storage path key for this connector","example":"custom-connector/scriptname"}}></SchemaItem><SchemaItem collapsible={false} name={"uploadedFiles"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"The list of uploaded files supported by the connector. If there was any executable files uploaded to thee connector. Typically this be empty as the executable be uploaded at source creation.","nullable":true,"items":{"type":"string"},"example":["pod/org/connectorFiles/testconnector/test1.jar"]}}></SchemaItem><SchemaItem collapsible={false} name={"fileUpload"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"true if the source is file upload","example":true,"default":false}}></SchemaItem><SchemaItem collapsible={false} name={"directConnect"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"true if the source is a direct connect source","example":true,"default":false}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>translationProperties</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
A map containing translation attributes by loacale key
</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"A map containing translation attributes by loacale key","additionalProperties":true,"example":{"de":"# Copyright (C) 2024 SailPoint Technologies, Inc. All rights reserved.\n# DO NOT EDIT. This file is generated by \"sailpointTranslate\" command.\nmenuLabel_ConnectionSettings=Verbindungseinstellungen\nmenuLabel_AggregationSettings=Aggregationseinstellungen\nsectionLabel_AuthenticationSettings=Verbindungseinstellungen\nsectionLabel_AggregationSettings=Aggregationseinstellungen\nsectionInfo_AuthenticationSettings=Konfigurieren Sie eine direkte Verbindung zwischen der Quelle Delinea Secret Server On-Premise und IdentityNow.<br><br>Geben Sie bei <strong>Zeit\\u00fcberschreitung bei Verbindung</strong> die maximal erlaubte Zeitdauer (in Minuten) f\\u00fcr die Verbindung von IdentityNow mit der Quelle ein.<br><br>Geben Sie die <strong>Host-URL</strong> der Delinea-SCIM-Serverquelle ein.<br><br>Geben Sie den <strong>API-Token</strong> der Quelle zur Authentifizierung ein.\nsectionInfo_AggregationSettings=Geben Sie die Einstellungen f\\u00fcr Ihre Aggregation an.<br><br>Geben Sie in das Feld <strong>Seitengr\\u00f6\\u00dfe</strong> die Anzahl an Kontoeintr\\u00e4gen ein, die auf einer einzelnen Seite aggregiert werden sollen, wenn gro\\u00dfe Datens\\u00e4tze durchlaufen werden.<br>\\n<br>Geben Sie im <strong>Kontofilter</strong> die Bedingungen f\\u00fcr den Kontofilter an. Beispiel: userName sw \"S\"<br><br>Geben Sie im <strong>Gruppenfilter</strong> die Gruppenfilterbedingungen an. Beispiel: displayName sw \"S\".\nplaceHolder_accAggregation=userName sw \"S\"\nplaceHolder_grpAggregation=displayName sw \"S\"\nplaceHolder_host=https://{Delinea_SCIM_Server_host}/v2\ndocLinkLabel_AuthenticationSettings=Mehr \\u00fcber Verbindungseinstellungen\ndocLinkLabel_Filters=Mehr \\u00fcber Konto- und Gruppenfilter\nHostURL=Host-URL\nConnectionTimeout=Zeit\\u00fcberschreitung bei Verbindung\nAPI_TOKEN=API-Token\nJSONPathMapping=JSON-Path-Attribut-Mapping\nFilterConditionForAccounts=Kontofilter\nFilterConditionForGroups=Gruppenfilter\nPage_Size=Seitengr\\u00f6\\u00dfe\nSchemaAttribute=Schema-Attribut\nJSONpath=JSON-Pfad\nShortDesc=Das Integrationsmodul IdentityNow f\\u00fcr Delinea Secret Server On-Premise bietet die M\\u00f6glichkeit einer tiefen Governance f\\u00fcr Konten und Gruppen. Es unterst\\u00fctzt au\\u00dferdem das End-to-End-Lebenszyklus-Management."}}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>connectorMetadata</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
A map containing metadata pertinent to the UI to be used
</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"A map containing metadata pertinent to the UI to be used","additionalProperties":true,"example":{"supportedUI":"EXTJS","platform":"ccg","shortDesc":"connector description"}}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`DEPRECATED`, `DEVELOPMENT`, `DEMO`, `RELEASED`]"} schema={{"type":"string","enum":["DEPRECATED","DEVELOPMENT","DEMO","RELEASED"],"description":"The connector status","example":"RELEASED"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"name\": \"name\",\n \"type\": \"ServiceNow\",\n \"className\": \"class name\",\n \"scriptName\": \"servicenow\",\n \"applicationXml\": \"<?xml version='1.0' encoding='UTF-8'?>\\n<!DOCTYPE Application PUBLIC \\\"sailpoint.dtd\\\" \\\"sailpoint.dtd\\\">\\n<Application connector=\\\"sailpoint.connector.OpenConnectorAdapter\\\" name=\\\"custom Atlassian Suite - Cloud\\\" type=\\\"custom Atlassian Suite - Cloud\\\"/>\\n\",\n \"correlationConfigXml\": \"<?xml version='1.0' encoding='UTF-8'?>\\n<!-- Copyright (C) 2021 SailPoint Technologies, Inc. All rights reserved. -->\\n\\n<!DOCTYPE CorrelationConfig PUBLIC \\\"sailpoint.dtd\\\" \\\"sailpoint.dtd\\\">\\n\\n<CorrelationConfig name=\\\"custom Atlassian Suite - Cloud Account Correlation Config\\\">\\n\\t<AttributeAssignments>\\n\\t\\t<Filter operation=\\\"EQ\\\" property=\\\"email\\\" value=\\\"mail\\\"/>\\n\\t\\t<Filter operation=\\\"EQ\\\" property=\\\"empId\\\" value=\\\"employeeNumber\\\"/>\\n\\t\\t<Filter operation=\\\"EQ\\\" property=\\\"displayName\\\" value=\\\"cn\\\"/>\\n\\t</AttributeAssignments>\\n</CorrelationConfig>\\n\",\n \"sourceConfigXml\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"no\\\"?><!-- Copyright (C) 2023 SailPoint Technologies, Inc. All rights reserved. --><Form xmlns=\\\"http://www.sailpoint.com/xsd/sailpoint_form_2_0.xsd\\\" connectorName=\\\"custom Atlassian Suite - Cloud\\\" directConnect=\\\"true\\\" fileUpload=\\\"true\\\" name=\\\"Custom Atlassian Suite - Cloud\\\" status=\\\"released\\\" type=\\\"SourceConfig\\\">\\n <BaseConfig>\\n <Field maxFiles=\\\"10\\\" maxSize=\\\"300\\\" name=\\\"fileUpload\\\" supportedExtensions=\\\"jar\\\" type=\\\"fileupload\\\" validateJSON=\\\"false\\\"/>\\n </BaseConfig>\\n \\n\\n \\n</Form>\",\n \"sourceConfig\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"no\\\"?><!-- Copyright (C) 2023 SailPoint Technologies, Inc. All rights reserved. --><Form xmlns=\\\"http://www.sailpoint.com/xsd/sailpoint_form_2_0.xsd\\\" connectorName=\\\"custom Atlassian Suite - Cloud\\\" directConnect=\\\"true\\\" fileUpload=\\\"true\\\" name=\\\"Custom Atlassian Suite - Cloud\\\" status=\\\"released\\\" type=\\\"SourceConfig\\\">\\n <BaseConfig>\\n <Field maxFiles=\\\"10\\\" maxSize=\\\"300\\\" name=\\\"fileUpload\\\" supportedExtensions=\\\"jar\\\" type=\\\"fileupload\\\" validateJSON=\\\"false\\\"/>\\n </BaseConfig>\\n \\n\\n \\n</Form>\",\n \"sourceConfigFrom\": \"sp-connect\",\n \"s3Location\": \"custom-connector/scriptname\",\n \"uploadedFiles\": [\n \"pod/org/connectorFiles/testconnector/test1.jar\"\n ],\n \"fileUpload\": true,\n \"directConnect\": true,\n \"translationProperties\": {\n \"de\": \"# Copyright (C) 2024 SailPoint Technologies, Inc. All rights reserved.\\n# DO NOT EDIT. This file is generated by \\\"sailpointTranslate\\\" command.\\nmenuLabel_ConnectionSettings=Verbindungseinstellungen\\nmenuLabel_AggregationSettings=Aggregationseinstellungen\\nsectionLabel_AuthenticationSettings=Verbindungseinstellungen\\nsectionLabel_AggregationSettings=Aggregationseinstellungen\\nsectionInfo_AuthenticationSettings=Konfigurieren Sie eine direkte Verbindung zwischen der Quelle Delinea Secret Server On-Premise und IdentityNow.<br><br>Geben Sie bei <strong>Zeit\\\\u00fcberschreitung bei Verbindung</strong> die maximal erlaubte Zeitdauer (in Minuten) f\\\\u00fcr die Verbindung von IdentityNow mit der Quelle ein.<br><br>Geben Sie die <strong>Host-URL</strong> der Delinea-SCIM-Serverquelle ein.<br><br>Geben Sie den <strong>API-Token</strong> der Quelle zur Authentifizierung ein.\\nsectionInfo_AggregationSettings=Geben Sie die Einstellungen f\\\\u00fcr Ihre Aggregation an.<br><br>Geben Sie in das Feld <strong>Seitengr\\\\u00f6\\\\u00dfe</strong> die Anzahl an Kontoeintr\\\\u00e4gen ein, die auf einer einzelnen Seite aggregiert werden sollen, wenn gro\\\\u00dfe Datens\\\\u00e4tze durchlaufen werden.<br>\\\\n<br>Geben Sie im <strong>Kontofilter</strong> die Bedingungen f\\\\u00fcr den Kontofilter an. Beispiel: userName sw \\\"S\\\"<br><br>Geben Sie im <strong>Gruppenfilter</strong> die Gruppenfilterbedingungen an. Beispiel: displayName sw \\\"S\\\".\\nplaceHolder_accAggregation=userName sw \\\"S\\\"\\nplaceHolder_grpAggregation=displayName sw \\\"S\\\"\\nplaceHolder_host=https://{Delinea_SCIM_Server_host}/v2\\ndocLinkLabel_AuthenticationSettings=Mehr \\\\u00fcber Verbindungseinstellungen\\ndocLinkLabel_Filters=Mehr \\\\u00fcber Konto- und Gruppenfilter\\nHostURL=Host-URL\\nConnectionTimeout=Zeit\\\\u00fcberschreitung bei Verbindung\\nAPI_TOKEN=API-Token\\nJSONPathMapping=JSON-Path-Attribut-Mapping\\nFilterConditionForAccounts=Kontofilter\\nFilterConditionForGroups=Gruppenfilter\\nPage_Size=Seitengr\\\\u00f6\\\\u00dfe\\nSchemaAttribute=Schema-Attribut\\nJSONpath=JSON-Pfad\\nShortDesc=Das Integrationsmodul IdentityNow f\\\\u00fcr Delinea Secret Server On-Premise bietet die M\\\\u00f6glichkeit einer tiefen Governance f\\\\u00fcr Konten und Gruppen. Es unterst\\\\u00fctzt au\\\\u00dferdem das End-to-End-Lebenszyklus-Management.\"\n },\n \"connectorMetadata\": {\n \"supportedUI\": \"EXTJS\",\n \"platform\": \"ccg\",\n \"shortDesc\": \"connector description\"\n },\n \"status\": \"RELEASED\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
Client Error - Returned if the request body is invalid.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><p> An example of a 403 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
Not Found - returned if the request URL refers to a resource or object that does not exist
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><p> An example of a 404 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
Internal Server Error - Returned if there is an unexpected error.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><p> An example of a 500 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
Reference in New Issue View Git Blame Copy Permalink