mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-11 04:19:42 +00:00
45 lines
8.4 KiB
Plaintext
45 lines
8.4 KiB
Plaintext
---
|
|
id: get-user-profile
|
|
sidebar_label: Find user-profile contributor relationship by id
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJydVttu2zgQ/RWCT1vAtzjObtfAPqRoWnixvSBJ9yUwgrE0ttlKpMqLY0HQv+8MKTdKnW2T5iEROTPkOTNnhmmkqdCCV0YvcjmXG/SfHNqP1qxVgXIgc3SZVRU7kPmN0rkI5DCskofIjPZWrYI3Vlgs4kluqyqxqoXK6QAPGyfnN5KjRBfl5HIgK7BQokfL5kZqWtANMUbxXRX47RGAxWth1sJvUZjVZ8y88IauJQS4w4EIVQ6e/hKWHAs6m+Itfg3KIpHzNuBAumyLJch5I31d8Y2OovWGPNfGluBpJ4SIAvdQVgW7nExnv+cvV6dDyKZ/DmeTk7Phy5Oz2TBHmM1OZ/DH6Rpk2y75NldRAoghXTCdTPjPQwYX+4pwYy4OrkwBxA4KxXtfAzpPl3NeUXuOh6oqVBYzO/7s+JDmmEVKBwVSiqmiXiUInPXbLus/9ybaT8iLRcg/6KJOGW0HMjweVyr9D+oNVXF+OqUl7PvL41MY6lMQtBE2M3qqu8Zb8EmmT47pi/k2eR9HoQ4li9vcabRd1bpukMuWTvHKRwX1mmo4Janwz0DOHhPIK8jFZdKBGIqgYVVEjWSG1ehx9Bx1GI0f1rG/vq/8AdlCR+n9zaHt4P/9/mWveM2FtYaatl0mEmePkVgQPquhEFdod9T4MYboUK8Gq0n9RhO1Lei8oAXuM4yR7lnkfixm5CuPkZ2LEp2DDYq0v6JKxoGS/Pttf2WsrYUzNKW27HVHqMSdNVT69lBCtplucjIEHlpzOe73nRs3Km/J6GIu0rgLtiC/rfeVm4/HDREG7d/TDGxHmopGCEyNOKKij6FSFLwDq1gKkdu9eyK4hlCweCErMTNHU/M6ugsesQKcUxuuAEsqOE/sLNNZMr4sWOXrCHCFYNGeB+Zzs+ybr7gACUff6Vs9mJTsBi2vkxPtpI83h067Nl9QEwz6/Vdtgk2fkrOq9NrwiZyuROFkNBlNenJ8f3H5Tpx/XBxzpVIejCIDLVbIL1bkC1lGtRekOlGaXK1rwVk1wfEwJgRkFUqLCAb1TlGpS6o5i5JkiDSsGVT3Ur1bXEeslXG+BN2z/MIr+YBDc98Cv/TipjJ43PtxVYDivk56azp93jx4FxzFzCmSSrwlLmxumhU4/GSLtuVtGkaWVbG8l2HUSK4cf5P811A4/AGN3y67Z/iFeP4T/iihbhN0HZujCLyizy9Yp38jaD4RIXplSHsMNhnOMx41vZCjEcNS/9bVby+4yP8BqaMqjw==
|
|
sidebar_class_name: "get 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 'Find user-profile contributor relationship by id' (get-user-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"}>Find user-profile contributor relationship by id</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/user_profiles/{id}"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Find user-profile contributor relationship 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><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"}>user_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}}></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={"user_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid"}}></SchemaItem><SchemaItem collapsible={false} name={"profile_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid"}}></SchemaItem><SchemaItem collapsible={false} name={"ne_attribute_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid"}}></SchemaItem><SchemaItem collapsible={false} name={"relationship_type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`owner`, `contributor`]"} schema={{"type":"string","enum":["owner","contributor"]}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"user_profile\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"uid\": \"string\",\n \"user_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"profile_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"ne_attribute_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"relationship_type\": \"owner\"\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> |