Get client application by id

Overview

Use this API to retrieve configured client application by Id.

Permissions

The logged-in user must be a global user and one of the below is required:

User must have 'view' action on the 'integration' resource.
User must have one of following privileges: 'View partition resources', 'Manage partition resources'.

Request

path Parameters

required

integer

id of object

Example: 1001

header Parameters

Accept-Language required	string Default: en-US Language locale accepted by client (used for locale specific fields in resource representation and in error responses). Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
X-egain-session required	string Session ID obtained from Login API response header.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not Acceptable

500

Internal server error

get/clientapplication/{id}

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

Retrieving the client application by Id
GET /ws/v20/administration/integration/clientapplication/1001

{"clientApplication": [{"id": 1001,
"name": "Test_Web",
"appId": "3d0152e5-3c70-4513-bfef-cebe52dd6b05",
"link": [{"rel": "self",
"href": "/system/ws/v20/administration/integration/clientapplication/1001"
}
],
"description": "Web application",
"lastModified": {"date": "2022-01-04T07:05:19.000Z"
},
"platform": {"webApplication": {"redirectUris": {"redirectUri": ["https://oauth.pstmn.io/v1/browser-callback"
]
}
}
},
"passwordCredentials": {"passwordCredential": [{"name": "Access Key 1",
"endDateTime": "2023-02-02T18:30:00.000Z",
"keyId": "516ee110-3440-4fed-b8cb-f30b54534259",
"hint": "tKx"
},
{"name": "Access Key 2",
"endDateTime": "2022-10-27T11:18:56.000Z",
"keyId": "9bfaca9e-70bc-435c-8946-c2151697f10f",
"hint": "cUk"
}
]
},
"apiPermission": {"delegatedPermissions": {"delegatedPermission": [{"value": "core.casemgr.read",
"displayName": "Provides Read Access to Core Case Manager",
"description": "Provides Read Access to Core Case Manager"
},
{"value": "core.usermgr.read",
"displayName": "Provides Read Access to Core User Manager",
"description": "Provides Read Access to Core User Manager"
}
]
},
"applicationPermissions": {"applicationPermission": [{"value": "app.core.casemgr.read",
"displayName": "Provides Read Access to Core Case Manager",
"description": "Provides Read Access to Core Case Manager"
},
{"value": "app.core.usermgr.read",
"displayName": "Provides Read Access to Core User Manager",
"description": "Provides Read Access to Core User Manager"
}
]
}
}
}
]
}