mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-11 04:19:42 +00:00
49 lines
14 KiB
Plaintext
49 lines
14 KiB
Plaintext
---
|
|
id: patch-profile
|
|
sidebar_label: Update a profile by id
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztWNtu2zgQ/RWCT7uAFVvyJamBfXDbLNaLXoLE2ZeuYdASZbOVSS1JJTEM//vOkJJlxY7TFG2fmgapRA5nzgxnzpDaUJVzzaxQcpzQIc2ZjZdXWqUi47RFE25iLXKchsnbPGGWE0ZyL0DmayISELNsYejwEy3HDZ22QJNmK265xpkNlfACKpy4kN7S8sDC+C1RKbFLTtT8M48tsYpobrXgd7xFCme/RZQmCc9AN6zX/L9CaA7YrS54i5p4yVeMDjfUrnO0aGC1XIBkqvSKWRgpCoeCP7BVnqFIGPUGycW8G7A4ehX0OmE/uAj7vSDhrNfr9th5N2V0u516a9zY1ypZo4nHxmMlLZcWp1ieZyJ2gW1/Nujc5hCbdxKwQOBgG6yA0MFsGcbnBX1QH7u6bVUaZjgxA2+fDQesMZbZwhwT5bJY4faOYivuMOhjyarHj5K848w9TrheCQk7lNAp6BPJDGAADrmYPa875zLxIzkzBvExkTk9TMdLsLXvxFypjDPp0idlRQZupCwzHKUtaJ4Xlptj4WNJInBLWHbVCORBAHfJAXP8wc52amcYraELlogJziEKcPpApBO2w3476kQdWm+IgbyND9WVFUc+4Ia26ApcEmB+9oJlrRsO6ZeQxthkKXRziPosdWqUfkrxreH6AMxL1lVo6gEPpVa83UKYrbCuAkuEQReH3YzmJlfS+O2JOh38r8kVlw85QOAJqUSRLBi5Y5nAMVeo9OfX5NdUG7rHko8yW1fM0XRtsiNAQ8ZvG1zV7aad8yhJgrA77wW9kIfBBWedIBykEeu/mvfP4wtM4OI4DijQd1wugHqH3Qhe2cP+69ejun0EqwzPraeS47x0qE8YAr9I97iiov5S11nDQCOHv4XhTlmv207V2VBXY2DOMyUXIK6+aTu+K7mecsUbeuROA3Jp6Hsx9DNxrQwgsNO4Kv0ALIZEBE9nzJ7cV6TdwIrV4UkFU9WfVYCDUKKxl/fMkNJEAwFwdTcIwyAKJ2FvGHWH/d5Z1B8Enf4QCAiLyh1Afiiu0sTLcH2nptfEOtopBZDMlhWAJGtxi49V6a9m+TObZbRrlr1j/fE1S8i1b4MkIIVk88y1yFjhZlm3c1/dHJXkH1N3kH+cXRWqsXSd929cum09LfcPSjkzl1oruB1sp96J/jEnxoBPQ+aSG67vIBpuDbgDl4JCS2j+SoJrSyinDF74Q8zdSvMi5043dI4mD5GNyIobwxZQ0G58jiSH1ezl9+v3Rmm9JkbBdWiJUveAitxrhVVXbSHOqd0NzJEsdmXaru5U7Y1ItjBuXCD8parQGYgsrc3NsN3egLdMWkyY7ZmEHQPzas35Gex4m+UCFt8xLTAPfP3vxL135UmasngF+XjIXU7cd2poAGKB4cd8KowF1zT6MkV8caGFXTuAc84016MCXfk03Z++weh7HPtCu81Ap2h5nXNHficEI/7hz4prJ+oLlwAD/v6xVoX2jxRDiht9XV/YLmuW2jvMlffSHYkfnCsoXP4u+umgF/TPw/Og1x9EwbybxkEUvxp008GApWxA6w5fN/Jj7XWvi9b3Gnd3OWDxX0z6w5hUyFRhjLGQfHKHZ52zzh5Lfbi8fk9GV+OjHbyaJDGT0BZJYXwlsDgGSnC9faUSka4J1puCYw9cUSA3YZYISVyacnkngAFWQAXIVcBOHK4wexn5fjxxWZwrY1dM7s08+RmmgXRT89+JDze+2DCf2nnGhHSnHGSVTUlAex91WnQo3OlzCZBwZrOZM8Nvdbbd4jBUmsayn9Y840ggEQaf60R/Eudv1+UHld/Jy78EHfWlHGRy7dgvK/ANHr/wtf8atcVPDEu49wC5IFg/8cZDCia4vF540Eaw0fkVoxhbz0nZ6R7LX40mb/5CNiu/JEG+4CLN7vFyCH+H9F/4By/KNzT3uQnHNzRjclFA4wEZrxh//ge75dFy
|
|
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 a profile by id' (patch-profile)"
|
|
---
|
|
|
|
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 a profile by id</h1>
|
|
|
|
<MethodEndpoint method={"patch"} path={"/profiles/{id}"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Update a profile by id
|
|
|
|
## 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":"id","in":"path","description":"ID of the object to retrieve, update, or delete","required":true,"schema":{"type":"string","format":"uuid","example":"1246d8b3-ac29-4015-8154-dea4434a73fa"}}}></ParamsItem></ul></div></details><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"}>profile</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"profile_type_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`Active`, `Inactive`, `On Leave`, `Terminated`]"} schema={{"type":"string","enum":["Active","Inactive","On Leave","Terminated"]}}></SchemaItem><SchemaItem collapsible={false} name={"id_proofing_status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`pending`, `pass`, `fail`]"} schema={{"type":"string","enum":["pending","pass","fail"]}}></SchemaItem><SchemaItem collapsible={false} name={"archived"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","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"}>attributes</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem name={"property name*"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></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"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>profile</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","readOnly":true,"description":"The objects ID","example":"33f072dd-13b4-41e1-8ea0-16f2a59b57c8"}}></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,"description":"The objects UID","example":"profileUid"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"This is the name of the profile.","example":"Profile Name"}}></SchemaItem><SchemaItem collapsible={false} name={"profile_type_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","description":"This is the ID of the profile type the profile belongs to","example":"33f072dd-13b4-41e1-8ea0-16f2a59b57c8"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`Active`, `Inactive`, `On Leave`, `Terminated`]"} schema={{"type":"string","enum":["Active","Inactive","On Leave","Terminated"],"description":"This is the status of the profile","example":"Active"}}></SchemaItem><SchemaItem collapsible={false} name={"id_proofing_status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`pending`, `pass`, `fail`]"} schema={{"type":"string","enum":["pending","pass","fail"],"description":"This is the ID proofing staus of the profile","example":"pending"}}></SchemaItem><SchemaItem collapsible={false} name={"created_at"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The date and time the profile was created","example":"2023-11-21T14:23:54.256-05:00"}}></SchemaItem><SchemaItem collapsible={false} name={"updated_at"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The date and time the profile was updated","example":"2023-11-21T14:23:54.256-05:00"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attributes</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Attributes that belong to this profile.
|
|
|
|
</div><SchemaItem name={"property name*"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"profile\": {\n \"id\": \"33f072dd-13b4-41e1-8ea0-16f2a59b57c8\",\n \"uid\": \"profileUid\",\n \"name\": \"Profile Name\",\n \"profile_type_id\": \"33f072dd-13b4-41e1-8ea0-16f2a59b57c8\",\n \"status\": \"Active\",\n \"id_proofing_status\": \"pending\",\n \"created_at\": \"2023-11-21T14:23:54.256-05:00\",\n \"updated_at\": \"2023-11-21T14:23:54.256-05:00\",\n \"attributes\": {\n \"text_attribute_uid\": \"static text\",\n \"date_attribute_uid\": \"01/15/2020\",\n \"profile_select_attribute_uid\": \"Profile Name\",\n \"multiple_profile_select_attribute_uid\": \"Profile Name,Second Profile Name,Third Profile Name\",\n \"contributor_select_attribute_uid\": \"User Name\",\n \"multiple_contributor_select_attribute_uid\": \"User Name,Second User Name,Third User Name\"\n }\n }\n}"} 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> |