IBM Cloud Identity Service

https://www.ibm.com/docs/en/cip
Admin
IBM Cloud Identity Service is a platform for managing user identities, access control, policies, and...
Tokens:178,018
Snippets:1,064
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Start Web Session cURL Example

Source: https://www.ibm.com/docs/en/cip/index_topic=operations-start-web-session

This cURL command demonstrates how to initiate a web session using the '/EAI/api/me/startWebSession' endpoint. It requires an Authorization header with an access token and a JSON payload containing the tokenId.

```shell
curl -H "Authorization: Bearer access_token" -d "tokenId=1234-abcd" https://gateway.domain.com/EAI/api/me/startWebSession
```

--------------------------------

### System Configuration and Setup API

Source: https://www.ibm.com/docs/en/cip/index_topic=reporting-audit-events

Endpoints for updating various system configurations and self-service setups.

```APIDOC
## UPDATE_SELF_CARE_SETUP

### Description
Updates the self-care setup configuration.

### Method
PUT

### Endpoint
/configuration/self-care

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

### Response Example
```json
{
  "message": "Self-care setup updated successfully."
}
```
```

```APIDOC
## UPDATE_TRANSLATIONS

### Description
Updates the system's translation strings.

### Method
PUT

### Endpoint
/configuration/translations

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

### Response Example
```json
{
  "message": "Translations updated successfully."
}
```
```

```APIDOC
## UPDATE_KBA_CONFIGURATION

### Description
Updates the knowledge-based authentication (KBA) configuration.

### Method
PUT

### Endpoint
/configuration/kba

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

### Response Example
```json
{
  "message": "KBA configuration updated successfully."
}
```
```

--------------------------------

### Example cURL Request with Authorization Header

Source: https://www.ibm.com/docs/en/cip/index_topic=authentication-send-access-token

Demonstrates how to make a GET request using cURL with an Authorization header. This header is crucial for authenticating API requests and must be included for all calls except for obtaining the initial access token. The format includes the token type (e.g., Bearer) and the token value.

```shell
# curl -v -X GET -H "Authorization: Bearer 644d0ac0-908f-485a-ac8d-b5bb99f200d7" https://hostname/GmaApi/users/ggonzalez
```

--------------------------------

### Retrieve Application Setup Information

Source: https://www.ibm.com/docs/en/cip/index_topic=methods-update-self-service-options

Retrieves setup information for a specific application within the Self Service portal.

```APIDOC
## GET /GmaApi/ss/retrieveApplicationSetupInfo/{applicationId}

### Description
Retrieves setup information for a specific application within the Self Service portal.

### Method
GET

### Endpoint
/GmaApi/ss/retrieveApplicationSetupInfo/{applicationId}

### Parameters
#### Path Parameters
- **applicationId** (string) - Required - The unique identifier of the application.

### Request Example
```bash
curl -X GET 'https://hostname/GmaApi/ss/retrieveApplicationSetupInfo/app123'
```

### Response
#### Success Response (200)
- **setupInfo** (object) - An object containing application setup details.

#### Response Example
```json
{
  "setupInfo": {
    "appName": "My App",
    "loginUrl": "https://myapp.com/login"
  }
}
```
```

--------------------------------

### Start Web Session API Response Example

Source: https://www.ibm.com/docs/en/cip/index_topic=operations-start-web-session

This JSON object represents a successful response from the '/EAI/api/me/startWebSession' API. It indicates the status of the operation and provides an entry identifier for the created session.

```json
{
"status":"success",
"entry" : "74018cff-724d-4c37-b0a5-1aff422afb4f",
"totalCount" : 1
}
```

--------------------------------

### Example Response for Get User Roles

Source: https://www.ibm.com/docs/en/cip/index_topic=operations-get-roles

Illustrates a successful response from the 'Get User Roles' API endpoint. The response is in JSON format and indicates the status of the request, a list of roles assigned to the user, and the total number of roles.

```json
{
"status" : "success",
"entry" : [ "Help Desk", "Manager", "Default" ],
"totalCount" : 3
}
```

--------------------------------

### Update Security Questions Setup

Source: https://www.ibm.com/docs/en/cip/index_topic=methods-update-security-question-options

Updates the security questions setup for a specific instance. This endpoint allows modification of various security question parameters and the questions themselves.

```APIDOC
## POST /GmaApi/ss/updateKba/ss/updateSelfRegistrationOptions

### Description
Updates the security questions setup for a specific instance. This endpoint allows modification of various security question parameters and the questions themselves.

### Method
POST

### Endpoint
https://hostname/GmaApi/ss/updateKba/ss/updateSelfRegistrationOptions

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **instanceId** (String) - Required - ID of the instance to update.
- **data** (Object) - Required - Object containing parameter and parameter values for security question options.
  - **minRequired** (Integer) - Required - Specifies the minimum number of security questions that a user must provide answers for when they register.
  - **maxRequired** (Integer) - Optional - Specifies the maximum number of security questions that a user can provide answers for when they register.
  - **minCharacterLength** (Integer) - Required - Specifies the minimum number of characters that must be entered as an answer.
  - **uniqueAnswers** (Boolean) - Required - Specifies whether answers to different questions must be unique. A value of `true` specifies that answers must be unique.
  - **questions** (Object) - Required - Object containing parameter and parameter values for one or more security questions.
    - **en-us** (Array) - Required - An array of security question objects for the `en-us` locale.
      - **id** (Integer) - Required - The question number.
      - **deprecated** (Boolean) - Required - Specifies whether the question is obsolete or in use. A value of `true` specifies that the question is in use.
      - **question** (String) - Required - Specifies the text of the question.

### Request Example
```json
{
  "instanceId": "your_instance_id",
  "data": {
    "minRequired": 3,
    "maxRequired": 5,
    "minCharacterLength": 10,
    "uniqueAnswers": true,
    "questions": {
      "en-us": [
        {
          "id": 1,
          "deprecated": false,
          "question": "What was the name of your first pet?"
        },
        {
          "id": 2,
          "deprecated": false,
          "question": "In what city were you born?"
        }
      ]
    }
  }
}
```

### Response
#### Success Response (200)
- **status** (Object) - Contains the status of the API call.
  - **success** (Boolean) - Indicates if the operation was successful.
  - **apiError** (Boolean) - Indicates if an API error occurred.
  - **message** (String) - A message describing the result of the operation.
  - **errors** (Object) - An object containing any errors that occurred.

#### Response Example
```json
{
  "status": {
    "success": true,
    "apiError": false,
    "message": "Success",
    "errors": {}
  }
}
```
```

--------------------------------

### Example JSON Response for Get KBA Questions

Source: https://www.ibm.com/docs/en/cip/index_topic=operations-get-kba-questions

This JSON structure represents a successful response from the 'Get KBA questions' API endpoint. It includes the status of the operation, an array of KBA entries (each with a question number and optionally an answer), and the total count of questions returned. This format is used for retrieving user-defined security questions.

```json
{
"status" : "success",
"entry" : [
{
"questionNumber" : 1,
"answer" : "1952"
},
{
"questionNumber" : 2,
"answer" : "1950"
},
{
"questionNumber" : 5,
"answer" : "smith"
}
],
"totalCount" : 3
}
```

--------------------------------

### Application Section Code String Example

Source: https://www.ibm.com/docs/en/cip/index_topic=methods-add-new-role

Provides an example of the `appSectionCode` string parameter, which specifies the application section for the Self Service profile application. Valid values include 'reports', 'requests', 'services', and 'users'.

```javascript
const appSectionCode = "reports"; // or "requests", "services", "users"
```

--------------------------------

### Example KBA API Response

Source: https://www.ibm.com/docs/en/cip/index_topic=methods-retrieve-kba-security-question-options

This is an example of a successful response from the KBA security questions API. It indicates success and returns an empty kba array, suggesting no questions were found or are applicable.

```json
{
  "status": {
    "success": true,
    "apiError": false,
    "message": "Success",
    "errors": {}
  },
  "kba": [
  ]
}
```

--------------------------------

### Self-Registration and Password Reset Setup API

Source: https://www.ibm.com/docs/en/cip/index_topic=reporting-audit-events

API endpoints for managing self-registration and password reset configurations.

```APIDOC
## DELETE_SELF_REGISTRATION_SETUP

### Description
Deletes the self-registration setup for a specific language.

### Method
DELETE

### Endpoint
/setup/self-registration/{self_service_alias_key}/{language_id_key}

### Parameters
#### Path Parameters
- **SELF_SERVICE_ALIAS_KEY** (string) - Required - The alias associated with the self-registration setup.
- **LANGUAGE_ID_KEY** (string) - Required - The language ID for which to delete the setup.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

### Response Example
```json
{
  "message": "Self-registration setup deleted successfully."
}
```
```

```APIDOC
## DELETE_PWD_RESET_SETUP

### Description
Deletes the password reset setup for a specific language.

### Method
DELETE

### Endpoint
/setup/password-reset/{self_service_alias_key}/{language_id_key}

### Parameters
#### Path Parameters
- **SELF_SERVICE_ALIAS_KEY** (string) - Required - The alias associated with the password reset setup.
- **LANGUAGE_ID_KEY** (string) - Required - The language ID for which to delete the setup.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

### Response Example
```json
{
  "message": "Password reset setup deleted successfully."
}
```
```

--------------------------------

### Start a web session

Source: https://www.ibm.com/docs/en/cip/index_topic=operations-start-web-session

Initiates a web session by setting a sessionVerificationToken. This token can then be used with the /api/session/createSessionFromToken API at another location to establish a user's web session.

```APIDOC
## POST /EAI/api/me/startWebSession

### Description
Sets a sessionVerificationToken, allowing the user to create a web session at another location that uses the EAI's /api/session/createSessionFromToken API.

### Method
POST

### Endpoint
/EAI/api/me/startWebSession

### Parameters
#### Request Body
- **tokenId** (string) - Required - The identifier of the token to be set in a web session environment. The tokenId is the value of the user_session_id sent to a protected resource by WebSEAL. Otherwise, tokenId can be an arbitrary value.

### Request Example
```json
{
  "tokenId": "1234-abcd"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success status of the operation. Expected value: "success".
- **entry** (string) - A unique identifier for the created session or token.
- **totalCount** (integer) - The total number of entries processed or created.

#### Response Example
```json
{
  "status": "success",
  "entry": "74018cff-724d-4c37-b0a5-1aff422afb4f",
  "totalCount": 1
}
```
```

--------------------------------

### Example IBM Cloud Instance Creation Response

Source: https://www.ibm.com/docs/en/cip/index_topic=methods-create-instance

This is an example of a successful response from the IBM Cloud instance creation API. It includes a status object indicating success and an instance object with the newly created instance's ID and name. The 'apiError' field being false signifies no API-level errors occurred.

```json
{"status":{"success":true,"apiError":false,"message":"Success","errors":{}},
"instance":{"id":1,"name":"foo"}}
```

--------------------------------

### Example Response for Retrieving Notice Types

Source: https://www.ibm.com/docs/en/cip/index_topic=ssm-retrieve-all-notice-types

This example shows the expected JSON response when successfully retrieving a list of notice types from the IBM Cloud Identity Service API. The response is an array of strings, each representing a distinct notice type.

```json
[
    "USER_SELF_DELETE",
    "USER_CONSENT",
    "USER_PRIVACY"
]
```

--------------------------------

### Example IBM Notice API Response (JSON)

Source: https://www.ibm.com/docs/en/cip/index_topic=methods-retrieve-list-all-notices

This JSON structure represents an example response from the IBM Notice API. It includes details such as notice ID, version, language code, body content, and creation timestamp.

```json
[
    {
        "id": 1848,
        "version": 2,
        "langCode": "de-de",
        "body": "m",
        "createTimestamp": "2019-07-18T08:32:17.615Z"
    },
    {
        "id": 1828,
        "version": 1,
        "langCode": "de-de",
        "body": "jkhkjhjkhkj",
        "createTimestamp": "2019-07-08T06:04:05.757Z"
    }
]
```

--------------------------------

### Example Response for Retrieving Service Members

Source: https://www.ibm.com/docs/en/cip/index_topic=methods-retrieve-members-service

This is an example JSON response when successfully retrieving members of a service. It indicates the success status, the total number of members found, and provides a list of their unique identifiers (gtwayUUIDs).

```json
{
"status":"success",
"total_count": 3,
"entries": ["0a577a49-c211-4b69-a81f-01537a302c0b", "f3acac82-30c7-4c92-afb6-22eb6e46234d", "224187d8-6aee-42e8-826d-4384a5459efd"]
}
```

--------------------------------

### GET /websites/ibm_en_cip/branding/files

Source: https://www.ibm.com/docs/en/cip/index_topic=methods-retrieve-branding-file

Retrieves a specified branding file from the Cloud Identity Service.

```APIDOC
## GET /websites/ibm_en_cip/branding/files

### Description
Retrieves a specified branding file from the Cloud Identity Service. You can specify the file type by its ID and optionally choose to download the original version.

### Method
GET

### Endpoint
/websites/ibm_en_cip/branding/files

### Parameters
#### Query Parameters
- **instanceId** (Integer) - Required - The Cloud Identity Service instance ID.
- **fileId** (Integer) - Required - The ID of the branding file. Accepted values include:
  * `2`: Logo image. Header logo.
  * `3`: Error icon. Header logo.
  * `4`: Favorites icon. Favorites icon displayed in the browser.
  * `5`: Form elements. Check box and radio button images.
  * `7`: Page background. Tiled background image for profile management.
  * `8`: Data loading indicator. Data loading image.
  * `10`: Preloader image. Section is loading image.
  * `11`: Search field icon. Autocomplete or search enabled input field image.
  * `12`: Searching icon. Search being performed image.
  * `13`: Success icon. Successful operation icon.
  * `14`: Pages icon. Page icons on Self Service screens.
- **downloadOriginal** (Boolean) - Optional - Specify whether to download the currently used file.
```

--------------------------------

### Instance Management APIs

Source: https://www.ibm.com/docs/en/cip/index_topic=reporting-audit-events

APIs for creating and managing instances.

```APIDOC
## POST /instances

### Description
APIs for creating new instances.

### Method
POST

### Endpoint
/instances

### Parameters
#### Request Body
- **OAUTH_CLIENT_ID** (string) - Required - The OAuth client ID for authentication.
- **INSTANCE_NAME_KEY** (string) - Required - The name of the instance.
- **FAILURE_REASON_KEY** (string) - Optional - The reason for failure in case of an error.

### Request Example
```json
{
  "OAUTH_CLIENT_ID": "your_client_id",
  "INSTANCE_NAME_KEY": "my-new-instance"
}
```

### Response
#### Success Response (200)
- **message** (string) - Success message.

#### Response Example
```json
{
  "message": "Instance creation successful."
}
```
```

--------------------------------

### GET /websites/ibm_en_cip/security_questions

Source: https://www.ibm.com/docs/en/cip/index_topic=methods-retrieve-all-kba-security-questions

Retrieves a list of security questions available for IBM users. This endpoint can be used to fetch questions for user authentication or profile setup.

```APIDOC
## GET /websites/ibm_en_cip/security_questions

### Description
Retrieves a list of security questions available for IBM users. This endpoint can be used to fetch questions for user authentication or profile setup.

### Method
GET

### Endpoint
/websites/ibm_en_cip/security_questions

### Parameters
#### Query Parameters
* **language** (string) - Optional - Specifies the desired language for the question text. Example: `en-us`.

### Request Example
```json
{
  "language": "en-us"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates if the request was successful. Returns an error if unsuccessful.
- **total_count** (integer) - The total number of available security questions.
- **entries** (array) - A list of security question objects.
  - **questionNumber** (integer) - A unique number identifying the question.
  - **questionTextByLanguage** (object) - A mapping of language codes to question text.
  - **roleMappings** (object) - Roles to which the question applies (can be ignored if not using role-specific questions).
  - **deprecated** (boolean) - Indicates if the question is deprecated (false means active).

#### Response Example
```json
{
  "status": "success",
  "total_count": 10,
  "entries": [
    {
      "questionNumber": 1,
      "questionTextByLanguage": {
        "en-us": "What was your first pet's name?",
        "fr-fr": "Quel était le nom de votre premier animal de compagnie ?"
      },
      "roleMappings": {},
      "deprecated": false
    }
  ]
}
```

#### Error Handling
- Any LDAP query that exceeds a size limitation returns an error.
```

--------------------------------

### Example KBA Question Options API Response

Source: https://www.ibm.com/docs/en/cip/index_topic=methods-retrieve-options-kba-security-questions

This snippet shows a successful response from the KBA question options API. It includes status information and an empty KBA array, indicating no questions were found or returned for the given instance.

```json
{
  "status":{
    "success":true,
    "apiError":false,
    "message":"Success",
    "errors":{}
  },
  "kba":[
  ]
}
```

--------------------------------

### Show Parameter Boolean Example

Source: https://www.ibm.com/docs/en/cip/index_topic=methods-add-new-role

Demonstrates the use of the `show` boolean parameter, which controls access to a Self Service profile application section. Setting it to `true` grants access.

```javascript
const show = true; // Set to true to grant access to the section
```

--------------------------------

### WebSEAL Logout for Session Termination (cURL)

Source: https://www.ibm.com/docs/en/cip/index_topic=termination-webseal-logout

This cURL request demonstrates how to terminate a user's session using the WebSEAL logout endpoint. It includes the 'redirect' parameter to specify the landing page after session termination and shows an example of the GET request to the /pkmslogout endpoint.

```bash
curl https://gateway.domain.com/pkmslogout?redirect=http://gateway.domain.com
```

--------------------------------

### Retrieve a list of branding files - cURL Example

Source: https://www.ibm.com/docs/en/cip/index_topic=methods-retrieve-list-branding-files

This cURL request demonstrates how to retrieve a list of branding files from the IBM Cloud Identity Service. It specifies the HTTP GET method, the resource URI, and includes necessary headers for authentication and content type.

```Shell
curl -X GET 'http://hostname/GmaApi/ss/getBrandingFiles?instanceId=1' -H 'accept: application/json' -H 'authorization: Bearer b43ac32a-9f03-435a-8045-8718c390c46c' -H 'cache-control: no-cache' -H 'content-type: application/json'
```

--------------------------------

### GET /GmaApi/ss/initAppManagementSetup

Source: https://www.ibm.com/docs/en/cip/index_topic=methods-retrieve-application-setup-information

Retrieves a map of the data that is used when Cloud Identity Portal administration is initialized.

```APIDOC
## GET /GmaApi/ss/initAppManagementSetup

### Description
Retrieves a map of the data that is used when Cloud Identity Portal administration is initialized.

### Method
GET

### Endpoint
/GmaApi/ss/initAppManagementSetup

### Parameters
#### Query Parameters
None

#### Path Parameters
None

#### Request Body
None

### Request Example
```bash
curl -v -i -X GET -H "Authorization: Bearer 73d2039d-7767-495f-b40c-f766fcf8f0e2" -H "Accept: application/json,application/xml,text/html,application/atom+xml,text/xhtml" http://hostname/GmaApi/ss/initAppManagementSetup
```

### Response
#### Success Response (200)
- **data** (object) - A map of initialization data for Cloud Identity Portal administration.

#### Response Example
```json
{
  "example": "{\"key1\": \"value1\", \"key2\": \"value2\"}"
}
```

### Authorization header
For information about obtaining an access token, see Request an access token.
```

--------------------------------

### Retrieve Application Setup Information (REST API)

Source: https://www.ibm.com/docs/en/cip/index_topic=methods-retrieve-application-setup-information

Retrieves a map of data used for initializing Cloud Identity Portal administration. This REST API call requires an Authorization header with a Bearer token. The response can be in JSON, XML, or other specified formats.

```cURL
curl -v -i -X GET -H "Authorization: Bearer 73d2039d-7767-495f-b40c-f766fcf8f0e2" -H "Accept: application/json,application/xml,text/html,application/atom+xml,text/xhtml" http://hostname/GmaApi/ss/initAppManagementSetup
```

--------------------------------

### Get KBA Questions using cURL

Source: https://www.ibm.com/docs/en/cip/index_topic=operations-get-kba-questions

This snippet demonstrates how to retrieve Knowledge Based Authentication (KBA) questions using a cURL request to the IBM Cloud Identity Service API. It includes an example of how to optionally show answers and specifies the endpoint and required authorization header. The output is a JSON object containing question numbers and optionally answers.

```bash
curl -H "Authorization: Bearer access_token" https://gateway.domain.com/EAI/api/me/kba?showAnswers=true
```

--------------------------------

### Retrieve Classification Details - REST API

Source: https://www.ibm.com/docs/en/cip/index_topic=methods-retrieve-classification-details

This snippet demonstrates how to retrieve details for all classifiers using the IBM Cloud Identity Service REST API. It specifies the HTTP GET method and the endpoint '/GmaApi/classifications'. The example includes an authorization header for authentication and shows a sample JSON response containing classifier information such as ID, name, and various configuration flags.

```curl
curl -k -X GET "https://hostname/GmaApi/classifications" -v -H "Authorization: Bearer 84bca438-ec3b-4403-a36a-ae9142559611"
```

```json
[
    {
        "id": 880,
        "classificationName": "testAutomation",
        "allowDataExport": false,
        "allowUserAlertOnModification": false,
        "canStopUserCare": false,
        "allowUserToStopClientProcessing": false,
        "allowDelete": false,
        "cisDefault": false,
        "canBeDelete": false,
        "userDataProcessList": []
    },
    {
        "id": 952,
        "classificationName": "AutomationClass222a",
        "allowDataExport": false,
        "allowUserAlertOnModification": false,
        "canStopUserCare": false,
        "allowUserToStopClientProcessing": false,
        "allowDelete": false,
        "cisDefault": false,
        "canBeDelete": true,
        "userDataProcessList": []
    },
    {
        "id": 953,
        "classificationName": "AutomationClass333a",
        "allowDataExport": true,
        "allowUserAlertOnModification": true,
        "canStopUserCare": true,
        "allowUserToStopClientProcessing": true,
        "allowDelete": false,
        "cisDefault": false,
        "canBeDelete": true,
        "userDataProcessList": [
            "null"
        ]
    }
]
```

--------------------------------

### POST /websites/ibm_en_cip

Source: https://www.ibm.com/docs/en/cip/index_topic=methods-create-instance

Creates a new instance with the specified name and configuration. It can optionally copy settings from an existing instance.

```APIDOC
## POST /websites/ibm_en_cip

### Description
Creates a new instance with the specified name and configuration. It can optionally copy settings from an existing instance.

### Method
POST

### Endpoint
/websites/ibm_en_cip

### Parameters
#### Request Body
- **instanceName** (String) - Required - The name of the new instance.
- **copyFrom** (String) - Required - The ID of the instance to copy from. The instance is based on the configuration options of the copied from instance.

### Request Example
```json
{
  "instanceName": "",
  "copyFrom": ""
}
```

### Response
#### Success Response (200)
- **status** (Object) - Returns whether the request was successful. Returns an error when the request is unsuccessful. For more information about errors, see Errors.
  - **success** (Boolean) - Indicates if the operation was successful.
  - **apiError** (Boolean) - Indicates if an API error occurred.
  - **message** (String) - A message describing the outcome of the operation.
  - **errors** (Object) - An object containing any errors encountered.
- **instance** (Object) - The instance that is created.
  - **id** (Number) - The ID of the instance.
  - **name** (String) - The name of the instance.

#### Response Example
```json
{
  "status": {
    "success": true,
    "apiError": false,
    "message": "Success",
    "errors": {}
  },
  "instance": {
    "id": 1,
    "name": "foo"
  }
}
```
```

--------------------------------

### GET /EAI/api/me - Get User Details

Source: https://www.ibm.com/docs/en/cip/index_topic=operations-get-user-details

Retrieves the user details of the authenticated user. Returns all available attributes.

```APIDOC
## GET /EAI/api/me

### Description
Retrieves the user details of the authenticated user. Returns all available attributes.

### Method
GET

### Endpoint
/EAI/api/me

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl -H "Authorization: Bearer access_token" https://gateway.domain.com/EAI/api/me
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the request.
- **entry** (object) - Contains the user details.
  - **status** (string) - User status.
  - **gtwayUUID** (string) - Gateway UUID of the user.
  - **uid** (string) - User ID.
  - **gma_isAccount** (boolean) - Indicates if it's a GMA account.
  - **mail** (string) - User's email address.
  - **gtwayPrincipalName** (string) - Gateway principal name.
  - **sn** (string) - User's surname.
  - **gtwayPrefLanguage** (string) - User's preferred language.
  - **c** (string) - User's country.
  - **cn** (string) - User's common name.
  - **gtwayIsManager** (string) - Indicates if the user is a manager.
  - **givenName** (string) - User's given name.
  - **employeeNumber** (string) - User's employee number.
- **totalCount** (integer) - Total count of entries returned.

#### Response Example
```json
{
  "status" : "success",
  "entry" : {
    "status" : null,
    "gtwayUUID" : "323966f1-0780-4fb4-928b-8fe3d4f19b94",
    "uid" : "test",
    "gma_isAccount" : true,
    "mail" : "test@us.ibm.com",
    "gtwayPrincipalName" : "test",
    "sn" : "testing",
    "gtwayPrefLanguage" : "en-us",
    "c" : "usa",
    "cn" : "test testing",
    "gtwayIsManager" : "true",
    "givenName" : "Test",
    "employeeNumber" : "1234567890"
  },
  "totalCount" : 1
}
```
```

--------------------------------

### Security Questions Setup JSON Structure

Source: https://www.ibm.com/docs/en/cip/index_topic=methods-update-security-question-options

This JSON object defines the structure for configuring security questions during user registration. It includes parameters for the number of required answers, minimum answer length, uniqueness of answers, and the questions themselves in various languages. Dependencies include the instance ID and data object.

```json
{
  "instanceId":"",
  "data":{
    "maxRequired": "",
    "minRequired":"",
    "minCharacterLength":"",
    "uniqueAnswers":"",
    "questions":{
      "en-us":[
        {
          "id":,
          "deprecated":,
          "question":""
        }
      ]
    }
  }
}
```

--------------------------------

### Delete User Response Example

Source: https://www.ibm.com/docs/en/cip/index_topic=methods-delete-user-specified-uuid

Example of a successful response when deleting a user. It indicates the operation's success and provides an empty error object.

```json
{
  "status": {
    "success": true,
    "apiError": false,
    "message": "Success",
    "errors": {}
  }
}
```

--------------------------------

### Retrieve Parent Service - Response Example

Source: https://www.ibm.com/docs/en/cip/index_topic=methods-retrieve-parent-service

Example JSON response when successfully retrieving the parent service. It indicates the status of the operation and the name of the parent service.

```json
{
"status":"success",
"entry": "Service1"
}
```

--------------------------------

### Launchpad Section Object Configuration

Source: https://www.ibm.com/docs/en/cip/index_topic=methods-add-new-role

Defines the parameters for the launchpad section of the Self Service profile application. It requires an object containing parameter and parameter values, with one value in the decapsulation set to `true`.

```javascript
const launchpad = {
  // Parameter and parameter values for the launchpad section
  // Example: "parameterName": "parameterValue"
  // Note: One value in the decapsulation should be `true`.
  "someParameter": true
};
```

--------------------------------

### Create Instance

Source: https://www.ibm.com/docs/en/cip/index_topic=methods-update-self-service-options

Creates a new instance, potentially for a service or a resource within the Self Service context.

```APIDOC
## POST /GmaApi/ss/createInstance

### Description
Creates a new instance, potentially for a service or a resource within the Self Service context.

### Method
POST

### Endpoint
/GmaApi/ss/createInstance

### Parameters
#### Request Body
- **instanceDetails** (object) - Required - Details required to create the instance.

### Request Example
```json
{
  "instanceDetails": {
    "name": "New Service Instance",
    "type": "service"
  }
}
```

### Response
#### Success Response (200)
- **instanceId** (string) - The ID of the newly created instance.

#### Response Example
```json
{
  "instanceId": "inst456"
}
```
```

--------------------------------

### SCIM User Data JSON Example

Source: https://www.ibm.com/docs/en/cip/index_topic=users-scim-files

This JSON structure demonstrates a SCIM file containing an array of operations for bulk user creation. Each operation specifies the HTTP method, API path, a unique bulk ID, and the 'data' object containing user attributes. This format is used to interact with the Cloud Identity Portal administration REST API.

```json
{
	"operations": [
		{
			"method": "POST",
			"path": "/Users",
			"bulkId": "importtest1",
			"data": {
				"userName": "userimporttest1",
				"active": true,
				"password": "core1234",
				"emails": [{
					"value": "nomail@gmail.com",
					"type": "",
					"primary": "true"
				}],
				"name": {
					"familyName": "import",
					"middleName": "mid",
					"givenName": "ctest1"
				},
				"addresses": [{
					"streetAddress": "123 oak st",
					"locality": "fort worth",
					"region": "texas",
					"postalCode": "77077",
					"country": "USA",
					"type": "home",
					"primary": "true"
				}],
				"title": "title",
				"preferredLanguage": "en-US",
				"userType": "Contractor"
			}
		},
			{
			"method": "POST",
			"path": "/Users",
			"bulkId": "importtest1",
			"data": {
				"userName": "userimporttest2",
				"active": true,
				"password": "core1234",
				"emails": [{
					"value": "nomail2@gmail.com",
					"type": "",
					"primary": "true"
				}],
				"name": {
					"familyName": "import",
					"middleName": "mid",
					"givenName": "ctest2"
				},
				"addresses": [{
					"streetAddress": "123 oak st",
					"locality": "fort worth",
					"region": "texas",
					"postalCode": "77077",
					"country": "USA",
					"type": "home",
					"primary": "true"
				}],
				"title": "title",
				"preferredLanguage": "en-US",
				"userType": "Contractor"
			}
		}
	]
}
```

--------------------------------

### Example API Response JSON

Source: https://www.ibm.com/docs/en/cip/index_topic=methods-retrieve-self-service-portal-options

This is an example of a successful response from the IBM Cloud Identity Service API. It includes a status object indicating success and an empty options array.

```json
{
  "status": {
    "success": true,
    "apiError": false,
    "message": "Success",
    "errors": {}
  },
  "options": []
}
```

--------------------------------

### JSON Example with Multiple Languages

Source: https://www.ibm.com/docs/en/cip/index_topic=methods-update-email-template

This JSON example illustrates how to provide multiple language translations for a single email template. It shows an 'emailTypeID' with two language entries: one for 'en-us' and another for 'fr', each with distinct body, reply-to, and subject content.

```json
{
 "instanceId":"",
 "updatedData":[
   {
    "emailTypeID":"1",
    "languages":[
      {
      "body":"<html>Approval needed</html>",
      "langCode":"en-us",
      "replyTo":"",
      "subject":"Awaiting approval"
      },
      {
      "body":"<html>Approbation nécessaire</html>",
      "langCode":"fr",
      "replyTo":"",
      "subject":"En attente d’approbation"
      }
     ]
   }
 ]
}
```

--------------------------------

### Upload Branding Image (cURL Example)

Source: https://www.ibm.com/docs/en/cip/index_topic=methods-upload-new-branding-image-file

This snippet demonstrates how to upload a local file, such as a JPG image, to replace a specific branding image using cURL. It requires the local file path and the branding image file ID.

```bash
curl -X POST \
  -F "file=@/Users/srinivasakancharla/Downloads/test.jpg" \
  "https://<your-instance-id>.identity.cloud.ibm.com/branding/images/<file-id>?instanceId=<instance-id>"
```

--------------------------------

### Change User Attributes - Example Response JSON

Source: https://www.ibm.com/docs/en/cip/index_topic=methods-change-attributes-user

Example JSON response from the IBM Cloud Identity Service API after attempting to change user attributes. It indicates the success status of the operation.

```json
{"status":{"success":true,"apiError":false,"message":"Success","errors":{}}}
```

--------------------------------

### Query Parameters Reference

Source: https://www.ibm.com/docs/en/cip/index_topic=methods-create-service-category

This section details the query parameters available for requests within the /websites/ibm_en_cip project. It explains the purpose of each parameter and potential return values.

```APIDOC
## GET /websites/ibm_en_cip

### Description
This endpoint allows retrieval of information related to the /websites/ibm_en_cip project, with options to filter results based on status.

### Method
GET

### Endpoint
/websites/ibm_en_cip

### Parameters
#### Query Parameters
- **status** (string) - Required - Returns whether the request was successful. Returns an error when the request is unsuccessful. For more information about errors, see Errors.

### Response
#### Success Response (200)
- **status** (string) - Indicates the success or failure of the request. May contain error details if unsuccessful.

#### Response Example
```json
{
  "status": "success"
}
```

#### Error Response (e.g., 400, 500)
- **error** (object) - Contains details about the error.

#### Error Response Example
```json
{
  "error": {
    "code": "INVALID_STATUS",
    "message": "The provided status parameter is invalid."
  }
}
```
```

--------------------------------

### Retrieve All Group Names - Response Example

Source: https://www.ibm.com/docs/en/cip/index_topic=methods-retrieve-all-group-names

An example JSON response for the 'Retrieve all group names' API call. It indicates a successful retrieval with the total number of groups found and a list of their names.

```json
{
"status":"success",
"total_count": 3,
"entries": ["Group1", "TestGroup", "MyGroup"]
}
```

--------------------------------

### Response Parameters Table Documentation

Source: https://www.ibm.com/docs/en/cip/index_topic=methods-add-new-role

This table provides a detailed explanation of each response parameter, including its name and a description of its purpose. It covers parameters like status, clientRolePriority, clientId, roleName, uuid, description, and defaultRole.

```markdown
## Response parameters

Parameter name| Description  
---|---  
status| Returns whether the request was successful. Returns an error when the request is unsuccessful. For more information about errors, see Errors.  
clientRolePriority| The priority of the role.  
clientId| The id of the client.  
roleName| Name of the role.  
uuid| The uuid of the user.  
description| Description of the role.  
defaultRole| Specifies whether the role is the default role for the instance. A value of `true` indicates it is the default role.
```

--------------------------------

### GET /GmaApi/verificationToken/tokenTypes

Source: https://www.ibm.com/docs/en/cip/index_topic=methods-retrieve-token-type-names

Retrieves the names of all available verification token types.

```APIDOC
## GET /GmaApi/verificationToken/tokenTypes

### Description
Retrieves the names of all token types.

### Method
GET

### Endpoint
/GmaApi/verificationToken/tokenTypes

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl -v -X GET -H "Authorization: Bearer 644d0ac0-908f-485a-ac8d-b5bb99f200d7" https://hostname/GmaApi/verificationToken/tokenTypes
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.
- **entries** (array) - A list of token type names.
- **totalCount** (integer) - The total number of token types available.

#### Response Example
```json
{
  "status": "success",
  "entries": [
    "passwordResetToken",
    "accountClaimingToken",
    "sessionVerificationToken",
    "federationContextToken"
  ],
  "totalCount": 4
}
```
```

--------------------------------

### Example Access Token Response

Source: https://www.ibm.com/docs/en/cip/index_topic=authentication-request-access-token

Illustrates the JSON response format when successfully requesting an access token. The response includes the access token, token type (bearer), and expiration time in seconds.

```json
{
  "access_token": "644d0ac0-908f-485a-ac8d-b5bb99f200d7",
  "token_type": "bearer",
  "expires_in": 3599
}
```
Tokens:
Raw