For up-to-date product documentation, see the IBM MobileFirst Foundation Developer Center.

Confidential Clients (GET)

Retrieves the confidential clients list of a specific runtime.

Roles

Users in the following roles are authorized to perform this operation:

• mfpadmin
• mfpdeployer

Method

GET

Path

/management-apis/2.0/runtimes/runtime-name/confidentialclients

Example

https://www.example.com/mfpadmin/management-apis/2.0/runtimes/myruntime/confidentialclients?locale=de_DE

Path Parameters

runtime-name

The name of the runtime. This is the context root of the runtime web application, without the leading slash.

Query Parameters

Query parameters are optional.

locale

The locale used for error messages.

Produces

application/json, application/xml, text/xml

Response

The confidential clients list of the specified runtime.

JSON Example

{
  "clients" : [
    {
      "allowedScope" : "clients:read-public clients:read-protected update",
      "displayName" : "My Client",
      "id" : "ABC",
      "secret" : "12345",
    },
    ...
  ],
  "productVersion" : "8.0",
}

XML Example

<?xml version="1.0" encoding="UTF-8"?>
<confidential-clients productVersion="8.0">
  <clients>
    <client
      allowedScope="clients:read-public clients:read-protected update"
      displayName="My Client"
      id="ABC"
      secret="12345"/>
    ...
  </clients>
</confidential-clients>

Response Properties

The response has the following properties:

clients

The confidential clients of the runtime.

productVersion

The exact product version.

The confidential client has the following properties:

allowedScope

The allowed scope of the client.

displayName

The display name of the client.

id

The identifier of the client.

secret

The secret of the confidential client.

Errors

403

The user is not authorized to call this service.

404

The corresponding runtime is not found.

500

An internal error occurred.

Parent topic: REST API for the MobileFirst Server administration service