---
id: get-application
sidebar_label: Returns an Application resource based on id or name.
hide_title: true
hide_table_of_contents: true
api: {"operationId":"getApplication","tags":["Applications"],"description":"The Application resource with matching id or name is returned. Attributes to include in the response can be specified with the 'attributes' query parameter. \nAttributes to exclude from the response can be specified with the 'excludedAttributes' query parameter. \nThe schema related to Application is: \n- **urn:ietf:params:scim:schemas:sailpoint:1.0:Application.**\n","parameters":[{"name":"applicationId","in":"path","schema":{"type":"string","example":"7f00000180281df7818028bfaae8035b"},"description":"id or name of Application resource.","required":true},{"in":"query","name":"attributes","schema":{"type":"string","example":"name,type,features"},"description":"The Application attributes to include in the response. The query parameter value is a comma-separated list of fields to be returned in the response for each Application. The attributes listed will be the only ones returned in the response, with the exception of id, schemas, and meta, which are always returned for an Application."},{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"features"},"description":"The Application attributes to exclude frome the response. The query parameter value is a comma-separated list of fields to be excluded from the response for each Application. The attributes listed will be the only ones excluded frome the response, with the exception of id, schemas, and meta, which are always returned for an Application."}],"responses":{"200":{"description":"Returns a single Application resource based on the id.","content":{"application/json":{"schema":{"properties":{"id":{"description":"IdentityIQ id of the Application.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"name":{"description":"Unique name for the Application. This name MUST be unique across the entire set of Applications.","type":"string","example":"Active Directory"},"descriptions":{"description":"A list of localized descriptions of the Application.","type":"array","example":[{"locale":"en_US","value":"The main Active_Directory domain data for the corporate network."}]},"type":{"description":"The type of the Application.","type":"string","example":"Active Directory - Direct"},"features":{"description":"A list of features of the Application.","type":"array","example":[["DIRECT_PERMISSIONS","NO_RANDOM_ACCESS","DISCOVER_SCHEMA"]]},"owner":{"description":"The owner of the Application.","type":"object","properties":{"displayName":{"description":"Display name of the application owner.","type":"string","example":"Joe Smith"},"value":{"description":"id of the application owner.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"$ref":{"description":"URI reference of the application owner resource.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b"}}},"applicationSchemas":{"description":"List of the Application Schemas.","type":"object","properties":{"value":{"description":"The urn of the Application Schema.","type":"string","example":"urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Active Directory:account"},"type":{"description":"The type of Application Schema (account, group, etc.).","type":"string","example":"account"},"$ref":{"description":"The URI of the SCIM resource representing the Entitlement.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Schemas/urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Active%20Directory:account"}}},"meta":{"description":"Metadata of the SCIM resource.","properties":{"created":{"description":"Datetime this Application was created.","type":"string","format":"date-time","example":"2022-02-11T01:34:04.074-05:00"},"location":{"description":"The location of the SCIM resource.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Applications/c0b4568a4fe7458c434ee77d1fbt156b"},"lastModified":{"description":"Datetime the Application was last modified.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"version":{"description":"The version of the SCIM resource.","type":"string","example":"W\"1644561244074\""},"resourceType":{"description":"The SCIM resource type.","type":"string","example":"Application"},"schemas":{"description":"The schemas involved in the SCIM resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:sailpoint:1.0:Application"]}}}}}}}}},"method":"get","path":"/Applications/{applicationId}","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 Application resource based on id or name.","description":{"content":"The Application resource with matching id or name is returned. Attributes to include in the response can be specified with the 'attributes' query parameter. \nAttributes to exclude from the response can be specified with the 'excludedAttributes' query parameter. \nThe schema related to Application is: \n- **urn:ietf:params:scim:schemas:sailpoint:1.0:Application.**\n","type":"text/plain"},"url":{"path":["Applications",":applicationId"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The Application attributes to include in the response. The query parameter value is a comma-separated list of fields to be returned in the response for each Application. The attributes listed will be the only ones returned in the response, with the exception of id, schemas, and meta, which are always returned for an Application.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"The Application attributes to exclude frome the response. The query parameter value is a comma-separated list of fields to be excluded from the response for each Application. The attributes listed will be the only ones excluded frome the response, with the exception of id, schemas, and meta, which are always returned for an Application.","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) id or name of Application resource.","type":"text/plain"},"type":"any","value":"","key":"applicationId"}]},"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 Application resource based on id or name.' (get-application)"
---

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 Application resource based on id or name.



The Application resource with matching id or name is returned. Attributes to include in the response can be specified with the 'attributes' query parameter. 
Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter. 
The schema related to Application is: 
- **urn:ietf:params:scim:schemas:sailpoint:1.0:Application.**


<details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Path Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"applicationId","in":"path","schema":{"type":"string","example":"7f00000180281df7818028bfaae8035b"},"description":"id or name of Application 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":"name,type,features"},"description":"The Application attributes to include in the response. The query parameter value is a comma-separated list of fields to be returned in the response for each Application. The attributes listed will be the only ones returned in the response, with the exception of id, schemas, and meta, which are always returned for an Application."}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"features"},"description":"The Application attributes to exclude frome the response. The query parameter value is a comma-separated list of fields to be excluded from the response for each Application. The attributes listed will be the only ones excluded frome the response, with the exception of id, schemas, and meta, which are always returned for an Application."}}></ParamsItem></ul></div></details><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

Returns a single Application resource based on the 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={"IdentityIQ id of the Application."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} deprecated={undefined} schemaDescription={"Unique name for the Application. This name MUST be unique across the entire set of Applications."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"descriptions"} required={false} deprecated={undefined} schemaDescription={"A list of localized descriptions of the Application."} schemaName={"array"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} deprecated={undefined} schemaDescription={"The type of the Application."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"features"} required={false} deprecated={undefined} schemaDescription={"A list of features of the Application."} schemaName={"array"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>owner</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The owner of the Application.

</div><SchemaItem collapsible={false} name={"displayName"} required={false} deprecated={undefined} schemaDescription={"Display name of the application owner."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} deprecated={undefined} schemaDescription={"id of the application owner."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"$ref"} required={false} deprecated={undefined} schemaDescription={"URI reference of the application owner resource."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>applicationSchemas</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

List of the Application Schemas.

</div><SchemaItem collapsible={false} name={"value"} required={false} deprecated={undefined} schemaDescription={"The urn of the Application Schema."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} deprecated={undefined} schemaDescription={"The type of Application Schema (account, group, etc.)."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"$ref"} required={false} deprecated={undefined} schemaDescription={"The URI of the SCIM resource representing the Entitlement."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>meta</strong><span style={{"opacity":"0.6"}}> </span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Metadata of the SCIM resource.

</div><SchemaItem collapsible={false} name={"created"} required={false} deprecated={undefined} schemaDescription={"Datetime this Application was created."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"location"} required={false} deprecated={undefined} schemaDescription={"The location of the SCIM resource."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"lastModified"} required={false} deprecated={undefined} schemaDescription={"Datetime the Application was last modified."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} deprecated={undefined} schemaDescription={"The version of the SCIM resource."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"resourceType"} required={false} deprecated={undefined} schemaDescription={"The SCIM resource type."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"schemas"} required={false} deprecated={undefined} schemaDescription={"The schemas involved in the SCIM resource."} 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\": \"c0b4568a4fe7458c434ee77d1fbt156b\",\n  \"name\": \"Active Directory\",\n  \"descriptions\": [\n    {\n      \"locale\": \"en_US\",\n      \"value\": \"The main Active_Directory domain data for the corporate network.\"\n    }\n  ],\n  \"type\": \"Active Directory - Direct\",\n  \"features\": [\n    [\n      \"DIRECT_PERMISSIONS\",\n      \"NO_RANDOM_ACCESS\",\n      \"DISCOVER_SCHEMA\"\n    ]\n  ],\n  \"owner\": {\n    \"displayName\": \"Joe Smith\",\n    \"value\": \"c0b4568a4fe7458c434ee77d1fbt156b\",\n    \"$ref\": \"http://localhost:8080/identityiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b\"\n  },\n  \"applicationSchemas\": {\n    \"value\": \"urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Active Directory:account\",\n    \"type\": \"account\",\n    \"$ref\": \"http://localhost:8080/identityiq/scim/v2/Schemas/urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Active%20Directory:account\"\n  },\n  \"meta\": {\n    \"created\": \"2022-02-11T01:34:04.074-05:00\",\n    \"location\": \"http://localhost:8080/identityiq/scim/v2/Applications/c0b4568a4fe7458c434ee77d1fbt156b\",\n    \"lastModified\": \"2022-02-11T01:08:45.866-05:00\",\n    \"version\": \"W\\\"1644561244074\\\"\",\n    \"resourceType\": \"Application\",\n    \"schemas\": [\n      \"urn:ietf:params:scim:schemas:sailpoint:1.0:Application\"\n    ]\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div>