mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
124 lines
34 KiB
Plaintext
124 lines
34 KiB
Plaintext
---
|
|
id: set-identity-password
|
|
sidebar_label: Set Identity's Password
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztXHtT4sgW/ypd3D9WR8JbELembvEeVHzwUFGn1iZpIBLSmE5EnJrvfs/pTkIAnXF2Z/fubrG790qSfpzn75zTnc6XGJ8xh7omt5tG7DAmmNs0mO2a7uKcCjHnjhGLx1w6ErHD21hwi7SoTUdsCg1jn+MxgwndMWc4CAzRHZuClM6bBP54ghnE5QSGJZTMgu5D7hBqE9OfKUHu7Du7tLxBdHiqj6k9YsQdM9MhfG4vu+9QQebMsgj8pfaC8KHfiuo692xX/BK2FbvElE8XSAvQ4PIJs8mI2cg1EDdY+H2b1VNs4sSJ8PSxHJrcgmwEt6mFIzMhVO/PO2PXnYnDZNJgT8xCASYENa0ZN203ofNp0jTsJJ2ZSerB2MCRLgX8n2A0TY2mydGAQpDG7V0MG3PHfJFtf9O5we5ixGCO+QRknpXg6R+cfmUCDSfQRg61XW1o8fluQurAl8/chNluUYl+J3fxu6fVLROuNN1hUrvUEtFppaoHLLQUX+sfPoBiP3wILeIXsVQ/iAsmiFwPI1YQ7RGYg7Sv2Ao3IFqHDUEfOGdgFe6YuoTb1oKMQf042F1MUf9bhHroKukn7mLGpNT63JNsoIW5aP3MNqRYcPDA1NDg75mtO4sZ2F3gSfdkp90pkfA+jGHaIzLzBpapH7PFLtLe5cQAH+JxcBwLhIakwVTCZaAPJCCdID24cXvhMWdBQi9t2kP+frU9ZZOP2F8LBKuZ0H9X8eBKcajpkUB85Eylgg/JfSDzpnEfJ/eCe47O1O+QkbVLvAjUA7+pbcBDDs9MJu4VHmQSpDLmXEjJ+W3J0OFTpX2HPZncE6BGMeO2lDxobwGqmJsADTOHPwFZCiLCuYAKIB1bOdAR2BVuCE92RAuBCBQlWV+8HWjWXJpXIOcfEjFMFQp4V/IdUCqNdylWycqI+yxLihl1wBodItWUIF3wMkINQ9kc+jPyss5boLtN5qTp3N/fP9Anemeb0xl3XIIXzwnZlCcq5mzMnF9XHiYE0z10oQSosU51lzuLt1qcB+p+q4GYMT1xvZ8q1myk34CmHbi12px4rmklylSwfO5XpLnjOmiDPkc7/mVoW3Hi33F5TTUBIx47fC5I7VlnMk6RL3c2AfB32e3nZc8yXAvykai5EiC6KkO6nJ3dhCF/7Sw989fICKFwgxH8G21Bd1ZHjy+pwvHlvZ27WK9b1w7uYrtqVIe5nmNHyFDiQTKY/NXlisWd1Ymx91eU0AyiBmLOKnlIzassx4OGIW1quDfEFqqVTOB/H8nSEJDWpi1causMuAJoA54SAQSqfjs2m5NNna/JyZdEoEkAXLF0jY9Ejp2sVcrJ8+NKJ30ObgDt7mKykzJboqs/H/3rFdpWB1RzqfYJ0zbdnXQceVvRhv/Y4HUTYvjOmqiU5MGbCPyDKmjafix4ptOZxQDvwh73kdgjscyiAEoue3aXQQ29nzoMoclFCSBSYFgNdAn34sHNKK6uDx2qagVOJJibDiBEgBT4WAC0KcQLIpqcEcPabQNgJAwsFRWk237fjktdT/wQDI4iMKipmK8JOcyuygKYPlmN8n5iENCrGgMIhrEROZh68CgKqPd+ewT+TSBdCwHR+VAOkPn6LcrcWMQOv8hLE1KB2KHreCwe07ntYhIMj+hsZvkpT/JBYCb8JSaAjynFX5grQG7MBw9Md2FcoBHk40K0w6fL+BlpK6TpxzbT62WOA0mrCns+mcx4TWYwhG+E0P2AHqQKRk4vZPX93P5+OpVWv4YpmkplhsPYV2i9nqW8j6rVRGa2LB+Ws1+/nO7158cjJ1PZa9qTVr/eKjeyPfehVZvv3zQfreR13brmB/rRKRPWdDKznvNPdm5i5JK5bLNe7HTLk/22/dLOX08fZrWzvfr8U5Wb5Xn/pjQp3Rwnm2L+PMmdGYtBI9/PtTruUeWsYh4fcHHsZPebrVbnMjkdnOXmJWa5vDIpGLR79dJtnJjNfI92993hXj1TGxkPRzeF/mPr4OrAKdDelZhmZ5lrN5Xu5/I37efUBW0V0xeOZzafM06tUu9mZr2z1NzZK/CLQuFhMSt1F42rtluqCi/b158qk2S+t996rNjXrZfjst6monBq3xidk6Sx/yndGFmXjZfs5cl5i5pPjVySn+T08VlrWq+0reTLpWg83xTb49MD51m0G/X6sb3njGvPXXNvQJ+zpY8fUWuRVOt9+gqQBAAVcbxZXVFV/+oic/pwkWt1m+7NQz91WkmlWle155Or+kPrYeKeNU6nrZdetp+5tE4fJhkkIcyyvk9AyU/owIL9xD1I8WT9CP9hbmAOTTQlFpZ2RLkUJnHYR6WakPvYQ3PkqTo2QZputPY0TIFo6ZliHKkIWtxR6VZQgAzhgUEA4RkJcAwwa+rZMk9ZwTF3Pxmkgad8rlW4bTMMfyL5CS4NrjU1YNYc2RDzNGpr/qwadUEWAw9vQvE3ZpovBK1Z1SAWaTTpUm2WPEhl91MruqicfiwNoFLtTKEui5/1PpY85En+mkKFqFOBv6tsyuPVykeoYk38S/Upw79AM2onyMvfZx1LxfhCxqJ9PjahNg7hxxQB8sgg/Tuhx8gN8qlMLh/7CkTCuLJxAD0q1PiRRoJTMN4qbH4f2F7FtVijWTovdGlpVOhnakdunT/wSbn69OkiaV7Xs4+T1Etqj5144vG61ZnUxqWhk801Fkb9ZLFXbmW8m3Ixp88H3f6xWXTaTqXdNsYH+XTqkj3O2tWHsadnDuyz8/5j9+jsOVVsNo4M58CwctPBuJIeZtJHlcdWuezUO6Xc5cXFk5E/a10KnfHr7kO1maLHdNzunz5YLUucebTZu2GnF89X5YVx4rXzT/1G9rF0XDuvvPRvBk+LvlfuLazeVckZPs4vc8ZoftyojqqT7kl5ctErnlx6WUcIfa98Tdlz3sof6eWqeT4qzJ+Oq+lG1rrZK9OG05rYg+fsQ6qb6ZlPo71Pz/PusHA+dUsezZ8VW4V68QCEXDxu7Yl+vdvLFlolw7q68ZL6Ym+eqRqfLo3KCBBpDZB+HE9W4ORnuEDUA95jjGiOQXUpw3QmlcE/q77SxnwLLIuFKdeqCyRiPy1NCHOZ1zzY9iyLDtAxVGqy6dFvpVJrwJ86KB4Ui8N0lh4McwYtHGRyxWI+XUzvHxQGdFCUUALZF3uNCmZ7U1wpbJ7+dt4+a7RrnQ7crTdPm51PNZynXmqewI+NVcPzNeLUDN9CBKWYCCRIGa2Pg7HExpRwBKqULZ6o5UnafSbWaI0I+R2i+KrMJJdKbVpGRS4dkZrjAHJqkC1jGQExSS1IhuIfQG6pyATKTOMn2ovBXIhbFSiyvg/5UNTI5UATKWSSZLmioJJphPcpRkw1ZBAZZLvEivWAJBJpqFyNsDqo+MygKh2qT2Cs98Sgnm1CfxJ0gaAjI9Ab07ICo+C4xUxumM9RmjnIpQv7g+KQZrOp4n5RGu0UDICOlGj8uanj0MXG1A2sV02dWFwHjbyAQBxGQfaSADk5dDFdNhXf14Ec4x3yRwdVbUM2fXplYQi1HilXzkmuQCywa0/ep6M1Idhar7MBBcC5GvjMMUem/S2vrdbqpd5JF+60axe9Wgd+4VgbzopL9baBZgmkgi2M1ZpkwMCcQvbGLBAHgzrqgz/qB2AIiu5oQ1NdiQWULlOwrSH1LKhAP/izv9IjOvSylA1cSfoNVNE7ZoIl4pDVwT2o8CFlGVDMBrnKGj9A3sVmrnbiS/IDpH3UYM5ugpQMw0QmqUUkTgjov8D0kBoGuq4aYOiBKzO5Ss49l9jcNXW2qoulKNeBOcCzk6hS0DmA8vfkza4HxEk2o14YWotPoq8foFlJbpW6bkRoUqQL26U6Ltlb1gLE6DggYQKpKjFdQXw4kkk5AI8dtAsRKwrTEu5aipiqy+UznXriHX53jusgmmQtfPDEfOeTSxrhqu5STT4i+cFXLaKoVqG6AscnUE1YxtZ3t7679d13+u76wyDt8p/K1Ce9mfr07GCzEZjYSH0caT02Jys7kr4i47i/56dIR1ddf2tOLqTOcOntJ+ZHKpRvEF8K9aHuD4LiNgj9S10ggVKOioMhIBEzDiXdS4ojWWJ2c7Y6dwYmGKj9SoqI+9HhSrDj2bZcCRZxYnAm7F9cMqZPbLk3HW4+amqtYptJbjPJbTTaRqN/TTTaZpJb39367j/Td7+ZSa6u4fl5kvCmU+oslKX5z+XLXgQaLN/7CV0uXNiLZis4GAlzrNhq5hAbZNKD9LCgs5xBc0Y+Wxxm9HyG7hfShfQglynEorH+dunHoZOt+lRE30qPUsSQxD1BHufZYFzC5dxYXf7zcPt2iLAm30UL8maQOYj0c5g7ZoqbuWOXc3wVcxFkSGIlh7Qj70YBpkHbKbZ1grbQgJIR4KKNO2wml2/SueaUwSjyjTXLnJrSeeXuLnOdhVYausCKcpTAyMJZTFu3PKBQIoHF5Rs4YFgmMMmGmPPBCDKDHQE6/8Ts1FfRH8rkSRs5PkGO5esuDB09zNz3X1vfbQLxDmJERyn4jYVeVe3g64E2FAQKs8K8c5ufb/PzbYzfxvh/R4zf5udb39367j/Td38gP/ezobfzc2jw7vwc2iZSJMyl6mhcf3maLl3Fp0CaN+G67jlyuTnIwWVeAaaEBM24kCBC3TFcrbzUj6+ZyHxQkeI5FrQI3ij7AhoCzXxN0JmZCF5fsvlcvlY2ALG8gjjqbTi0FmwgT1apCRJSpo6JZqswTg6uJCy5QAMN3lz75sg2nUrVybdj1TBxPN/im5C8DSTOoH74RcjWCWkyG/wBXz3H+vrHeVEDvcHLa+L75mzQngClaywiC59RXeo0gtRXD+ipKIDCI1dw73O0TQcTckXhRstlkMEiLrNBkDzDlSFlRh2oFtS+xs7RVXc3chxNHf9hJtYN4EjnwfmzUuT8mToA5XBvNJbMlVZ2UdCtCB6twjeYO4yR28i7iqQNgC3FXlo5pPV7D3ftyjA4Dd6l9F+nT9zZGqmaiE4mhnNs47Moy7+/6FzdGhVKtLfqQBeJHOiS0vqTjre9IgmfjtW9Lz3Q2p90ug9f6r+SL2+udiMK0oiAEGkZpEl0eeTqv4Sg6aCr3I488LTfTZZ8Y1STHqFlUhGSNDWlZmqQMUr6TsAxbGVMdIARWyYsHHI521Buey81C7hwr06MrfAsb99CYMWWBtd/4EDCGs04oYYTagonhE+/iltoWODbyIPEAWUAlaX+JRL4hEawUY31KvLL4ZOyD4YPHUiVo4jZobo4XIKg/4vIB9g6bANQjQl3uBsI18QfC4PXirCCpYJ1CW7Sa3GImWtyU/SGS1UYR/9u/CLHpeWKypltLX42Sr+BJH8f3P0/Id4Waf6NSOOnwLgy2V4eiqr93Lfxt+eD/qTzQf/4t/HjMQQ6afB+lRqF17JfTWyuLcuD4XhaHp7KKCHrPKii1TcOMH+ODjSzqIt4KuOJPjaZXJWaMepiZRJHTONTGQNmDsfAw4QaaORAGwgYAiomOjAt+VmL7nJmKqFalT2IKPJspydL4+VnDxLkSh7LAsHgIgG++QPPHri/WtABTDiX3xWoBjAD6b5/Rgkjgjcl1CXfwyLDFLqnQqauji4pFrgsOsJeQfxAkEMWErJcdqbibIgbHqbOIpDznbkAcYS/2wGiRy1iDYmVeMhIm1kSE7HdalH5vbEB57Qxs2ZoJGDiDE8FLGdoNbsbI8JgtrK+BHdGSb+TSGJbGASLd2U+2UQ6kdJkMYsn7KDqn1I7MvgbXwRYN8Mvy32e7edRtp9H+YFsavt5lO3nUbafR9l+HmX7eZTt51G2n0fZfh7lb/Z5FH8pDXWTlGrCNNlT+zZqc+w2trI59jkeG+PeGdz/8gW3e3G36CvelqiN2y3LjSC5+QId5Lav3J0Bo8PqUyXTWnchVwT9fcXNF6hwf0r1UFvJ32z7ObK9d36Gm+qxgf/Vl6naqXToHG7i/x/G7uBfuOAzVbLg4Wy8/yUW7PtDGzUu/vM/rWyhug==
|
|
sidebar_class_name: "post api-method"
|
|
info_path: docs/api/beta/identitynow-beta-api
|
|
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Set Identity's Password' (set-identity-password)"
|
|
---
|
|
|
|
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 Markdown from "@theme/Markdown";
|
|
import OperationTabs from "@theme/OperationTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
|
|
<h1 className={"openapi__heading"}>Set Identity's Password</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/set-password"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This API is used to set a password for an identity.
|
|
|
|
An identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their IDN user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or ["authorization_code" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow).
|
|
|
|
A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) can be used to change **any** identity's password or the password of any of the identity's accounts.
|
|
"API authority" refers to a token that only has the "client_credentials" grant type.
|
|
|
|
You can use this endpoint to generate an `encryptedPassword` (RSA encrypted using publicKey).
|
|
To do so, follow these steps:
|
|
|
|
1. Use [Query Password Info](https://developer.sailpoint.com/idn/api/v3/query-password-info) to get the following information: `identityId`, `sourceId`, `publicKeyId`, `publicKey`, `accounts`, and `policies`.
|
|
|
|
2. Choose an account from the previous response that you will provide as an `accountId` in your request to set an encrypted password.
|
|
|
|
3. Use [Set Identity's Password](https://developer.sailpoint.com/idn/api/v3/set-password) and provide the information you got from your earlier query. Then add this code to your request to get the encrypted password:
|
|
|
|
```java
|
|
import javax.crypto.Cipher;
|
|
import java.security.KeyFactory;
|
|
import java.security.PublicKey;
|
|
import java.security.spec.X509EncodedKeySpec;
|
|
import java util.Base64;
|
|
|
|
String encrypt(String publicKey, String toEncrypt) throws Exception {
|
|
byte[] publicKeyBytes = Base64.getDecoder().decode(publicKey);
|
|
byte[] encryptedBytes = encryptRsa(publicKeyBytes, toEncrypt.getBytes("UTF-8"));
|
|
return Base64.getEncoder().encodeToString(encryptedBytes);
|
|
}
|
|
|
|
private byte[] encryptRsa(byte[] publicKeyBytes, byte[] toEncryptBytes) throws Exception {
|
|
PublicKey key = KeyFactory.getInstance("RSA").generatePublic(new X509EncodedKeySpec(publicKeyBytes));
|
|
String transformation = "RSA/ECB/PKCS1Padding";
|
|
Cipher cipher = Cipher.getInstance(transformation);
|
|
cipher.init(1, key);
|
|
return cipher.doFinal(toEncryptBytes);
|
|
}
|
|
```
|
|
|
|
In this example, `toEncrypt` refers to the plain text password you are setting and then encrypting, and the `publicKey` refers to the publicKey you got from the first request you sent.
|
|
|
|
You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password.
|
|
|
|
|
|
## Request
|
|
|
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"identityId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The identity ID that requested the password change","example":"8a807d4c73c545510173c545f0a002ff"}}></SchemaItem><SchemaItem collapsible={false} name={"encryptedPassword"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The RSA encrypted password","example":"XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A=="}}></SchemaItem><SchemaItem collapsible={false} name={"publicKeyId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The encryption key ID","example":"YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2"}}></SchemaItem><SchemaItem collapsible={false} name={"accountId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Account ID of the account This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350","example":"CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the source for which identity is requesting the password change","example":"8a807d4c73c545510173c545d4b60246"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"202"} value={"202"}><div>
|
|
|
|
Reference to the password change.
|
|
|
|
</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={"requestId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The password change request ID","example":"089899f13a8f4da7824996191587bab9"}}></SchemaItem><SchemaItem collapsible={false} name={"state"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IN_PROGRESS`, `FINISHED`, `FAILED`]"} schema={{"type":"string","enum":["IN_PROGRESS","FINISHED","FAILED"],"description":"Password change state"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"requestId\": \"089899f13a8f4da7824996191587bab9\",\n \"state\": \"IN_PROGRESS\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Password change is in progress"} value={"Password change is in progress"}><ResponseSamples responseExample={"{\n \"state\": \"IN_PROGRESS\",\n \"requestId\": \"089899f13a8f4da7824996191587bab9\"\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"}><Markdown> An example of a 403 response object</Markdown><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={"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"}><Markdown> An example of a 500 response object</Markdown><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> |