---
id: get-object-config-by-id
sidebar_label: Returns an ObjectConfig resource based on its name or id.
hide_title: true
hide_table_of_contents: true
api: {"operationId":"getObjectConfigById","tags":["ObjectConfig"],"description":"The ObjectConfig resource with matching name or id is returned. <br/>\n\nAttributes to include in the response can be specified with the 'attributes' query parameter. <br/>\n\nAttributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.\n\nThe schema related to ObjectConfig is:\n- **urn:ietf:params:scim:schemas:sailpoint:1.0:ObjectConfig**\n","parameters":[{"name":"objectConfigId","in":"path","schema":{"type":"string","example":"7f00000180281df7818028be62e500e8"},"description":"id of ObjectConfig resource.","required":true},{"in":"query","name":"attributes","schema":{"type":"string","example":"objectAttributes"},"description":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned."},{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"name"},"description":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**"}],"responses":{"200":{"description":"Returns a single ObjectConfig resource based on its name or id.","content":{"application/json":{"schema":{"properties":{"id":{"description":"Unique identifier of the ObjectConfig.","type":"string","example":"7f00000180281df7818028be63aa00ef"},"name":{"description":"Name of the ObjectConfig.","type":"string","example":"Bundle"},"objectAttributes":{"description":"A list of attributes of the ObjectConfig.","type":"array","items":{"properties":{"name":{"description":"The object attribute name.","type":"string","example":"StringAttr"},"displayName":{"description":"The display name of the object attribute.","type":"string","example":"attr_demoString"},"type":{"description":"The type of the object attribute.","type":"string","example":"string"},"multi":{"description":"A Boolean value indicating this is a multi-valued attribute.","type":"boolean","example":false},"defaultValue":{"description":"The default value of the object attribute.","type":"string","example":"None"},"system":{"description":"A Boolean value indicating this is a system attribute that does not have a source and is not configurable.","type":"boolean","example":false},"standard":{"description":"A Boolean value indicating this is a standard attribute (i.e. manager, email, firstname, lastname).","type":"boolean","example":false},"extendedNumber":{"description":"Integer value of the extended attribute column number in the database schema.","type":"integer","example":2},"namedColumn":{"description":"A Boolean value indicating this attribute has a named column in the database schema.","type":"boolean","example":false},"ruleName":{"description":"Rule used to derive the value. Usually specified when there are no attributeSources defined.","type":"string","example":"lastLoginToDate"},"groupFactory":{"description":"A Boolean value indicating this attribute can be used in a group factory. Identity attributes only.","type":"boolean","example":true},"editMode":{"description":"Enumeration indicating whether this attribute allows modification.","type":"string","enum":["READONLY","PERMANENT","UNTILFEEDVALUECHANGES"],"example":"READONLY"},"attributeSources":{"description":"Sources of values for this atribute. Identity attributes only.","type":"array","items":{"properties":{"name":{"description":"The name of the attribute on the application.","type":"string","example":"lastName"},"key":{"description":"Derived identifier for this source.","type":"string","example":"testInstancesApplication/inst2:lastName"},"instance":{"description":"Optional instance name for template applications.","type":"string","example":"inst2"},"ruleName":{"description":"Rule used to derive the value.","type":"string","example":"Identity Attribute Rule - Type"}}}},"attributeTargets":{"description":"Targets of this attribute that should receive the value upon attribute synchronization. Identity attributes only.","type":"array","items":{"properties":{"name":{"description":"The name of the attribute on the application.","type":"string","example":"app2_active"},"key":{"description":"Derived identifier for this target.","type":"string","example":"Composite_ERP_Global_Platform:app2_inactive"},"instance":{"description":"Optional instance name for template applications.","type":"string","example":"continuous-integration-environment1"},"ruleName":{"description":"Rule used to derive the value.","type":"string","example":"attributeTarget-aws-S3-rule"},"provisionAllAccount":{"description":"Return whether to provision all accounts if an identity has multiple accounts on the target application. Identity attributes only.","type":"boolean","example":false}}}}}}},"meta":{"description":"Metadata for the ObjectConfig","type":"array","items":{"properties":{"created":{"description":"Datetime when the ObjectConfig was created","type":"string","example":"2022-03-31T14:52:40.245-05:00"},"location":{"description":"URL to the ObjectConfig","type":"string","example":"http://localhost:8080/identityiq/scim/v2/ObjectConfig/7f00000180281df7818028be62ef00e9"},"lastModified":{"description":"Datetime of ObjectConfig last modification","type":"string","example":"2022-03-31T14:52:40.265-05:00"},"version":{"description":"ObjectConfig version","type":"string","example":"\"W\"1649951092552\""},"resourceType":{"description":"Resource type of the metadata subject","type":"string","example":"ObjectConfig"}}}}}}}}}},"method":"get","path":"/ObjectConfig/{objectConfigId}","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns an ObjectConfig resource based on its name or id.","description":{"content":"The ObjectConfig resource with matching name or id is returned. <br/>\n\nAttributes to include in the response can be specified with the 'attributes' query parameter. <br/>\n\nAttributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.\n\nThe schema related to ObjectConfig is:\n- **urn:ietf:params:scim:schemas:sailpoint:1.0:ObjectConfig**\n","type":"text/plain"},"url":{"path":["ObjectConfig",":objectConfigId"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) id of ObjectConfig resource.","type":"text/plain"},"type":"any","value":"","key":"objectConfigId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}}
sidebar_class_name: "get api-method"
info_path: iiq/api/identityiq-scim-rest-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 'Returns an ObjectConfig resource based on its name or id.' (get-object-config-by-id)"
---

import ApiTabs from "@theme/ApiTabs";
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 DiscriminatorTabs from "@theme/DiscriminatorTabs";
import TabItem from "@theme/TabItem";

## Returns an ObjectConfig resource based on its name or id.



The ObjectConfig resource with matching name or id is returned. <br/>

Attributes to include in the response can be specified with the 'attributes' query parameter. <br/>

Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.

The schema related to ObjectConfig is:
- **urn:ietf:params:scim:schemas:sailpoint:1.0:ObjectConfig**


<details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Path Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"objectConfigId","in":"path","schema":{"type":"string","example":"7f00000180281df7818028be62e500e8"},"description":"id of ObjectConfig resource.","required":true}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Query Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"attributes","schema":{"type":"string","example":"objectAttributes"},"description":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned."}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"name"},"description":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**"}}></ParamsItem></ul></div></details><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

Returns a single ObjectConfig resource based on its name or id.

</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} deprecated={undefined} schemaDescription={"Unique identifier of the ObjectConfig."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} deprecated={undefined} schemaDescription={"Name of the ObjectConfig."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>objectAttributes</strong><span style={{"opacity":"0.6"}}> undefined[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A list of attributes of the ObjectConfig.

</div><SchemaItem collapsible={false} name={"name"} required={false} deprecated={undefined} schemaDescription={"The object attribute name."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} deprecated={undefined} schemaDescription={"The display name of the object attribute."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} deprecated={undefined} schemaDescription={"The type of the object attribute."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"multi"} required={false} deprecated={undefined} schemaDescription={"A Boolean value indicating this is a multi-valued attribute."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"defaultValue"} required={false} deprecated={undefined} schemaDescription={"The default value of the object attribute."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"system"} required={false} deprecated={undefined} schemaDescription={"A Boolean value indicating this is a system attribute that does not have a source and is not configurable."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"standard"} required={false} deprecated={undefined} schemaDescription={"A Boolean value indicating this is a standard attribute (i.e. manager, email, firstname, lastname)."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"extendedNumber"} required={false} deprecated={undefined} schemaDescription={"Integer value of the extended attribute column number in the database schema."} schemaName={"integer"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"namedColumn"} required={false} deprecated={undefined} schemaDescription={"A Boolean value indicating this attribute has a named column in the database schema."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"ruleName"} required={false} deprecated={undefined} schemaDescription={"Rule used to derive the value. Usually specified when there are no attributeSources defined."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"groupFactory"} required={false} deprecated={undefined} schemaDescription={"A Boolean value indicating this attribute can be used in a group factory. Identity attributes only."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"editMode"} required={false} deprecated={undefined} schemaDescription={"Enumeration indicating whether this attribute allows modification."} schemaName={"string"} qualifierMessage={"**Possible values:** [`READONLY`, `PERMANENT`, `UNTILFEEDVALUECHANGES`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>attributeSources</strong><span style={{"opacity":"0.6"}}> undefined[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Sources of values for this atribute. Identity attributes only.

</div><SchemaItem collapsible={false} name={"name"} required={false} deprecated={undefined} schemaDescription={"The name of the attribute on the application."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"key"} required={false} deprecated={undefined} schemaDescription={"Derived identifier for this source."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"instance"} required={false} deprecated={undefined} schemaDescription={"Optional instance name for template applications."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"ruleName"} required={false} deprecated={undefined} schemaDescription={"Rule used to derive the value."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>attributeTargets</strong><span style={{"opacity":"0.6"}}> undefined[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Targets of this attribute that should receive the value upon attribute synchronization. Identity attributes only.

</div><SchemaItem collapsible={false} name={"name"} required={false} deprecated={undefined} schemaDescription={"The name of the attribute on the application."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"key"} required={false} deprecated={undefined} schemaDescription={"Derived identifier for this target."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"instance"} required={false} deprecated={undefined} schemaDescription={"Optional instance name for template applications."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"ruleName"} required={false} deprecated={undefined} schemaDescription={"Rule used to derive the value."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"provisionAllAccount"} required={false} deprecated={undefined} schemaDescription={"Return whether to provision all accounts if an identity has multiple accounts on the target application. Identity attributes only."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>meta</strong><span style={{"opacity":"0.6"}}> undefined[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Metadata for the ObjectConfig

</div><SchemaItem collapsible={false} name={"created"} required={false} deprecated={undefined} schemaDescription={"Datetime when the ObjectConfig was created"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"location"} required={false} deprecated={undefined} schemaDescription={"URL to the ObjectConfig"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"lastModified"} required={false} deprecated={undefined} schemaDescription={"Datetime of ObjectConfig last modification"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} deprecated={undefined} schemaDescription={"ObjectConfig version"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"resourceType"} required={false} deprecated={undefined} schemaDescription={"Resource type of the metadata subject"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"id\": \"7f00000180281df7818028be63aa00ef\",\n  \"name\": \"Bundle\",\n  \"objectAttributes\": [\n    {\n      \"name\": \"StringAttr\",\n      \"displayName\": \"attr_demoString\",\n      \"type\": \"string\",\n      \"multi\": false,\n      \"defaultValue\": \"None\",\n      \"system\": false,\n      \"standard\": false,\n      \"extendedNumber\": 2,\n      \"namedColumn\": false,\n      \"ruleName\": \"lastLoginToDate\",\n      \"groupFactory\": true,\n      \"editMode\": \"READONLY\",\n      \"attributeSources\": [\n        {\n          \"name\": \"lastName\",\n          \"key\": \"testInstancesApplication/inst2:lastName\",\n          \"instance\": \"inst2\",\n          \"ruleName\": \"Identity Attribute Rule - Type\"\n        }\n      ],\n      \"attributeTargets\": [\n        {\n          \"name\": \"app2_active\",\n          \"key\": \"Composite_ERP_Global_Platform:app2_inactive\",\n          \"instance\": \"continuous-integration-environment1\",\n          \"ruleName\": \"attributeTarget-aws-S3-rule\",\n          \"provisionAllAccount\": false\n        }\n      ]\n    }\n  ],\n  \"meta\": [\n    {\n      \"created\": \"2022-03-31T14:52:40.245-05:00\",\n      \"location\": \"http://localhost:8080/identityiq/scim/v2/ObjectConfig/7f00000180281df7818028be62ef00e9\",\n      \"lastModified\": \"2022-03-31T14:52:40.265-05:00\",\n      \"version\": \"\\\"W\\\"1649951092552\\\"\",\n      \"resourceType\": \"ObjectConfig\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div>