Create Client Application

Overview

Use this API to create a client application.

Permissions

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

  • User must have 'create' action on the 'integration' resource.
  • User must have 'Manage partition resources' privilege.
Request
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.

Request Body schema: application/json
name
required
string (name) [ 1 .. 120 ] characters

The display name for the client application.

description
string (description) <= 255 characters

Free text field to provide a description of the client application object to end users.

required
object (Platform)
  • Specifies settings for a single-page application or web application or installed clients such as desktop or mobile devices.
  • Platform type cannot be changed only redirect URIs can be modified.
object (APIPermission)
  • Specifies the set of delegated and application permissions of a resource, that client applcation needs to access.
  • A maximum of 30 total permissions may be added to an application.
Responses
201

When created successfully

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

post/clientapplication
Request samples
application/json
  • Create client application with required attributes.
  • POST /ws/v20/administration/integration/clientapplication
{}
Response samples
application/json
{
  • "code": "400-101",
  • "developerMessage": "Unsupported query parameter(s) supplied: '<query_parameter>'."
}