Files
developer.sailpoint.com/docs/api/nerm/v1/get-user-profiles.api.mdx
2024-03-06 16:17:34 -05:00

45 lines
12 KiB
Plaintext

---
id: get-user-profiles
sidebar_label: Get user-profile contributor relationships
hide_title: true
hide_table_of_contents: true
api: eJy1V9tu4zYQ/RVCD32ybPkWJwaCIkXThYvuZpFk+xIEASWNbO7KpJakEhuG/r0zlC3LseNb2zwkkTjDOXM7M1p4KgPNrVByFHtDbwz2mwH9VatEpGC8hheDibTISALPP4FlOQr4WSnBIiWtFmFulWYaUneTmYiMVC0fG2/45JECy1ZXPje8jGs+BQuajheexAe8+2cOeo5qQtYeNs3fpKl6MyxBYxkfC+nMMS5jZpS2Qo6bqKLhZy40oDsJTw00PBNNYMq94cKz84wsqfA7RBZFERS6bwXCwtNUTIWtiQlpYQwa5WDGp1mK79pBUDQ8lSQGDkj2naCO8e1azmCs5Lgu5kUauIX4hVuvKGoHFRw0ubbYD6pL32saO3cXxgDZ3cpBmGWpivG11TkUjSrWlJIXEe+P9uME2Oh3phLGXdJd3DGJmLjSi8ORrhxG1SkCRcu5M7sOQBjyqygJO/7VRdT2ezwKfR4NrnzeaQ+6nX5n0Lnok4MVdgnocll0cNCHJX4skpXK/+NFt5sEg04c++1u2PN7bWj7l8ADv32RdHj/KuwPossNL5b9cNCBZStSIqxa4mbh/L/C3YPeZdDrYeD77djvDeIr/3IQYTJ4kAQJtLt9CDdw15v8xdnZX0MoQRlw9fMRWfwLz0DmU+IY9SZd/9VMENPU+qx2UPcHeYjH3PL9btyDzbU0LOQ2mqBltlJjQjKLfaLBZOgMHIU+VCoFLp2VhOeprUQrvK5fi2e6rbzYMVQnCOjPJrbbWYbNDnGFgcLJ2StPBb1Dh4xdRgakYy2eZamIXPhb3w1dsjiaJB1zVGS+Fudac8feFqbm8DVYhkfUKTJcfCfT+Yq/vHy33lTIv0CO7cQbdjv4yGf1x+1blux3EEHRqPfpMeLvyekYne2WOrXQif+tsK7Qa/Pb77jJ8FLV+NkjcN/QI9vK8nT3kYSZ3T8BWyDjTKHKr876dTv4pbR1fRGUGYBXoXJz7i29wKvH5/MqGIX7aXi9XU31G4/Zfdk7zGe55GHq+ipSZM9C85SOUhLuErfqvI/+CtRIunb9k1SJnD6S+5uknJlbrRXuT8Vz6UR/lxMjxKclT9kD6FckV6eD7mjHZsgYuDzlcoL7U4oPMIvAaZqTnNtfUEAmt5HdIIEaw8fAyvchcSrxaClfT+yD0nqO+x0WsWPeN0TF3rTC/BerFNKZWu6vBIFT63utTa5CInZhKJfOXGPBehNrMzNstRboK5f2C86EoikxX2hczQGamO8WzwQqv3ItqArKOqzES9+WLO7xaAqR2p6CTpzRyGHcGDGm4FM15caiYzSRiOsNRLkWdu4AhsA16JucXHl6rh8/UOxLHHWhKhXklLccO27cOCF8U/7zx4p/HtUPwOlFv6/nKtflv65ZhEwU3UjhKl1oN4NmUKvEL7f3n9nN19HOrXF1yCLcvEKg6e/85VGEaXcL+1TFIpkziir2Ns0uRICnNFAdGJCvArM8xXRTPWIFAs3XYTW5P48eHdZMGTvlsnZy0lfKBvrFuu5P/NYpQ2+R7VpZygW1cVlji2U5Pr0bnZjQCSKng8Ui5Aa+6bQo6HW5glANxMJQya1XiQ/BHtzVdwL8AfONjwEkoZykHAcdb/yIJXuP+e19/kwYH6/Ke6xv7OFnGj5ryd2DadeOfSa0UxbXPYhqW/IayPOaFB1FYUHjpkXfpli6pd5NRDOlprU1S+iWir4/3VJL/wMoXrcN
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 'Get user-profile contributor relationships' (get-user-profiles)"
---
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"}>Get user-profile contributor relationships</h1>
<MethodEndpoint method={"get"} path={"/user_profiles"}></MethodEndpoint>
Get user-profile contributor relationships
## Request
<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={{"name":"query","in":"query","description":"Allows for pagination and sorting.","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","example":100},"offset":{"type":"integer","example":50},"order":{"type":"string","example":"created_at"}},"example":{"limit":100,"offset":50,"order":"created_at"}},"style":"deepObject","explode":true}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"user_id","in":"query","description":"The ID of a user for filtering","required":false,"schema":{"type":"string","format":"uuid","example":"bba9cfb2-96c1-4acb-ac79-a21732527265"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"ne_attribute_id","in":"query","description":"ID of an attribute for filtering","required":false,"schema":{"type":"string","format":"uuid","example":"33f072dd-13b4-41e1-8ea0-16f2a59b57c8"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"profile_id","in":"query","description":"Profile ID to filter by","required":false,"schema":{"type":"string","format":"uuid","example":"4e480441-451d-47d9-87c2-9a0f0fe135eb"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"relationship_type","in":"query","description":"Type of user contributor relationship to filter by","required":false,"schema":{"type":"string","enum":["owner","contributor"],"example":"contributor"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"metadata","in":"query","description":"Returns batching metadata in the response","required":false,"schema":{"type":"boolean","default":false,"example":true}}}></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_profiles</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={"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><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"}>_metadata</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><SchemaItem collapsible={false} name={"offset"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><SchemaItem collapsible={false} name={"total"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><SchemaItem collapsible={false} name={"next"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/endpoint?limit=10&offset=60"}}></SchemaItem><SchemaItem collapsible={false} name={"previous"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/endpoint?limit=10&offset=40"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"user_profiles\": [\n {\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 ],\n \"_metadata\": {\n \"limit\": 0,\n \"offset\": 0,\n \"total\": 0,\n \"next\": \"/endpoint?limit=10&offset=60\",\n \"previous\": \"/endpoint?limit=10&offset=40\"\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>