mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-11 04:19:42 +00:00
45 lines
13 KiB
Plaintext
45 lines
13 KiB
Plaintext
---
|
|
id: patch-users
|
|
sidebar_label: Update multiple users
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJytVm1vIjcQ/iuWP/PWa3K9IFUqd0lVTr3cKS/9kqLI6x3Ad7v21i8kK8R/74zNwhIIJVKJRLA9nnnm7RkvuanACq+MHud8yCvh5fzegXW8w3Nw0qqKDvHovsqFB1aGwquqABbWUl7MHB8+8LSedLiFfwI4/9HkNR8u41JZQO3eBuhwabQH7elIVFWhZLTe/+7IypI7OYdS0C9fV4B2TfYdpEdDlSWsXoGj02RuKyasFTVKKQ+l++/rKm/JOG+VnqHM1NhSIDQeAgp09rA/WVT/VRd1swHPosRg4I08ez/9AB+y7vtz+a579kt+3hWDPOteDDIpz+Ain17AXkzHl8xMmZ8DSzCZN8wCooEFblkWYsz5qsO1KOEQ4l19d6gpSraRlTXFKm6jIgyuKo76niQOqW5Otro9Jvo3h7uVUdr3pCnJRlK9bwJ0KKlUrgGTMVUFUKXh/jUIKcG5uJyQ5anAMsOrLyVfYEL9FMCQDrewdq+tYvJp+Xha2l9L0loLf3PeKSbKFydmMIm2jVxiEUpvoivOCx/csfCOpFcLUnCpnMgKLN/JSzO3UUnj11781hrQWmFmSp8GO4nuVt6fcQ/1zKwJ1WO6fRD8vr54hTVXduDlpdIKTwTG5DHKdS6xZQrq8LTmq23MOVVB92fcih9qa1cZ7RITvBsM6N+u/avnCgMOOWtEqTMFW4hC0V4kOP4GLjMavk4xN/u01MboMFKvS3w2GV9Nkgdnh0B/FDm7SdhYlwVNuSfc2JUYNw+9/xfxWMdwfKarx3D/RVLRzJW1hpxcO3F+yIkx4kOyKtgt2AVYFu+gO0iLwWrMiNHo2lzoHAubwbOEeNO9ybnjswHI5D6yESuRo8QMWNrPsC5j+yT5doHeGmtr5kwJfk5ST4iKPVmDlb4pQjozm5lLIISf47LfDFYXA+BiDoJFzuZz7ys37PeX6KXQ/hopfdXTmCk0a2oA4t++qBReXgirKP+p1zbiyauGXYUsQZr95ovicZAw4ZyaUdipjoLz6JIlHyaETwach3UEmIGwYEeBXHiYtI9vKeoJR1tokwRyiryNYrhOQriTfvzecPOd+QEaYeD3r7UJNv2MfU4Jvtm+Oq6aPGxeCQ9p4J86pNOwbQ/Ozdw8NPGagbc3rdpT51TbTddsKH/L+FtiX7PyhmD3+PU0ipxg7JSeGooUlVpK/0+9QW/QQnJ9dfOFjb6ND5J0c8ik0CyLoyTWShroDNuUlSZX05pRRRqcOciomD08ZUqzmEjQC4W9UWKTUBdj3wIyLoFaJ+LL+C7muTLOl0K3Tl57lO4AXW6J4fVXbMqgh2ffrwqRhlbsuuW6MVsv3DnioI3lMhMO7m2xWtE2FqClbphs2y82A14AkWNFUB3+ABThnxKgLr1gYrcWIT5iX7IW8Wq6MZLEdEdlJy1S+Ta6+/QHNdH6FY5JoEtWPNGzFr+H/G/8w4VJ/Bmf6rS/5IXQs4A8hzJJMX3+BYwWL1I=
|
|
sidebar_class_name: "patch api-method"
|
|
info_path: docs/api/nerm/v1/nerm-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 'Update multiple users' (patch-users)"
|
|
---
|
|
|
|
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"}>Update multiple users</h1>
|
|
|
|
<MethodEndpoint method={"patch"} path={"/users"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Update multiple users
|
|
|
|
## 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={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>users</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","required":true,"writeOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","description":"ID of the object to retrieve or update"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name","example":"myusername"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"email"} qualifierMessage={undefined} schema={{"type":"string","format":"email","description":"The email","example":"test@sailpoint.com"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`NeprofileUser`, `NeaccessUser`]"} schema={{"type":"string","enum":["NeprofileUser","NeaccessUser"],"default":"NeprofileUser","description":"Type of user","example":"NeprofileUser"}}></SchemaItem><SchemaItem collapsible={false} name={"profile_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","description":"ID of the profile","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}></SchemaItem><SchemaItem collapsible={false} name={"title"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The title","example":"Director"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`Active`, `Disabled`]"} schema={{"type":"string","enum":["Active","Disabled"],"description":"Status of the user","example":"Active"}}></SchemaItem><SchemaItem collapsible={false} name={"login"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The login","example":"myLogin"}}></SchemaItem><SchemaItem collapsible={false} name={"group_strings"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The group strings","example":"Administrator_group,Developer_group"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
Expected response to a valid request
|
|
|
|
</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"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Users"} value={"0-item-properties"}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>users</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","readonly":true}}></SchemaItem><SchemaItem collapsible={false} name={"uid"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `>= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readonly":true}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"email"} qualifierMessage={undefined} schema={{"type":"string","format":"email"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`NeprofileUser`, `NeaccessUser`]"} schema={{"type":"string","enum":["NeprofileUser","NeaccessUser"],"default":"NeprofileUser"}}></SchemaItem><SchemaItem collapsible={false} name={"title"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`Active`, `Disabled`]"} schema={{"type":"string","enum":["Active","Disabled"]}}></SchemaItem><SchemaItem collapsible={false} name={"login"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"last_login"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"cookies_accepted_at"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"preferred_language"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></TabItem><TabItem label={"Job"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"info"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"job has started"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>job_status</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"job_id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"3ce88e47ad6dba2ddf349d21"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"queued"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"int"} qualifierMessage={undefined} schema={{"type":"int","example":200}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
|
|
|
Bad Request - unable to complete.
|
|
|
|
</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"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"InvalidJson"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"example":"Invalid JSON syntax. Please check your syntax and try again."}}></SchemaItem></TabItem><TabItem label={"ValidationErrors"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"example":"The <object> failed to create/update"}}></SchemaItem><SchemaItem collapsible={false} name={"errors"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"example":{"attribute":"can't be blank"}}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
|
|
|
Internal Server Error - returned on unhandled exceptions.
|
|
|
|
</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":"Sorry something went wrong"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"Sorry something went wrong\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div> |