IBM Apptio Platform

https://www.ibm.com/docs/en/apptio-platform
Admin
IBM Apptio Platform is an enterprise software suite that provides business intelligence, data...
Tokens:6,060
Snippets:53
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Access Administration API: cURL Sample Commands

Source: https://www.ibm.com/docs/en/apptio-platform/access-administration/saas_topic=access-administration

Provides example cURL commands for interacting with the Access Administration API.

```APIDOC
## Access Administration API: cURL sample commands

### Description
This section provides practical cURL examples for common API operations.

### Method
Various (GET, POST, PUT, DELETE)

### Endpoint
Various

### Example Commands:

1.  **Create a user:**
    ```bash
    curl -X POST "https://api.ibm.com/apptio/v1/users" \
         -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
         -H "Content-Type: application/json" \
         -d '{
               "username": "sampleuser",
               "email": "sampleuser@example.com",
               "role": "viewer"
             }'
    ```

2.  **Get user information:**
    ```bash
    curl -X GET "https://api.ibm.com/apptio/v1/users/123e4567-e89b-12d3-a456-426614174000" \
         -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
    ```

3.  **Grant user access to an environment:**
    ```bash
    curl -X POST "https://api.ibm.com/apptio/v1/users/user123/environments/env-prod-1" \
         -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
    ```

4.  **Remove user access from an environment:**
    ```bash
    curl -X DELETE "https://api.ibm.com/apptio/v1/users/user123/environments/env-prod-1" \
         -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
    ```

*Note: Replace `YOUR_ACCESS_TOKEN` with a valid authentication token or API key.*
```

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

### Access Administration API - User Management

Source: https://www.ibm.com/docs/en/apptio-platform/access-administration/saas_topic=access-administration

This group of endpoints allows for the creation, retrieval, update, and deletion of users within the Access Administration system.

```APIDOC
## Access Administration API: Create a user

### Description
Allows for the creation of a new user within the Access Administration system.

### Method
POST

### Endpoint
/api/users

### Parameters
#### Request Body
- **username** (string) - Required - The username for the new user.
- **email** (string) - Required - The email address of the new user.
- **role** (string) - Optional - The role to assign to the new user.

### Request Example
```json
{
  "username": "newuser",
  "email": "newuser@example.com",
  "role": "admin"
}
```

### Response
#### Success Response (201)
- **userId** (string) - The ID of the newly created user.

#### Response Example
```json
{
  "userId": "123e4567-e89b-12d3-a456-426614174000"
}
```

---

## Access Administration API: Get user information

### Description
Retrieves detailed information about a specific user.

### Method
GET

### Endpoint
/api/users/{userId}

### Parameters
#### Path Parameters
- **userId** (string) - Required - The ID of the user to retrieve.

### Response
#### Success Response (200)
- **userId** (string) - The ID of the user.
- **username** (string) - The username.
- **email** (string) - The user's email address.
- **role** (string) - The user's assigned role.

#### Response Example
```json
{
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "username": "existinguser",
  "email": "existinguser@example.com",
  "role": "user"
}
```

---

## Access Administration API: Update user

### Description
Updates the information for an existing user.

### Method
PUT

### Endpoint
/api/users/{userId}

### Parameters
#### Path Parameters
- **userId** (string) - Required - The ID of the user to update.
#### Request Body
- **email** (string) - Optional - The updated email address.
- **role** (string) - Optional - The updated role.

### Request Example
```json
{
  "role": "editor"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the user was updated.

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

---

## Access Administration API: Delete user

### Description
Deletes a user from the Access Administration system.

### Method
DELETE

### Endpoint
/api/users/{userId}

### Parameters
#### Path Parameters
- **userId** (string) - Required - The ID of the user to delete.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the user was deleted.

#### Response Example
```json
{
  "message": "User deleted successfully."
}
```

---

## Access Administration API: Get domain users

### Description
Retrieves a list of all users within a specified domain.

### Method
GET

### Endpoint
/api/domains/{domainId}/users

### Parameters
#### Path Parameters
- **domainId** (string) - Required - The ID of the domain.

### Response
#### Success Response (200)
- **users** (array) - A list of user objects.
  - **userId** (string) - The ID of the user.
  - **username** (string) - The username.
  - **email** (string) - The user's email address.

#### Response Example
```json
{
  "users": [
    {
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "username": "user1",
      "email": "user1@example.com"
    },
    {
      "userId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "username": "user2",
      "email": "user2@example.com"
    }
  ]
}
```
```

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

### Access Administration API - Environment Access Management

Source: https://www.ibm.com/docs/en/apptio-platform/access-administration/saas_topic=access-administration

Endpoints for managing user access to specific environments and retrieving environment-related user information.

```APIDOC
## Access Administration API: Grant a user access to an environment

### Description
Grants a user access to a specific environment.

### Method
POST

### Endpoint
/api/users/{userId}/environments/{environmentId}

### Parameters
#### Path Parameters
- **userId** (string) - Required - The ID of the user.
- **environmentId** (string) - Required - The ID of the environment.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating access was granted.

#### Response Example
```json
{
  "message": "User granted access to environment successfully."
}
```

---

## Access Administration API: Get user environment information

### Description
Retrieves information about a user's access to a specific environment.

### Method
GET

### Endpoint
/api/users/{userId}/environments/{environmentId}

### Parameters
#### Path Parameters
- **userId** (string) - Required - The ID of the user.
- **environmentId** (string) - Required - The ID of the environment.

### Response
#### Success Response (200)
- **environmentId** (string) - The ID of the environment.
- **accessLevel** (string) - The level of access the user has.

#### Response Example
```json
{
  "environmentId": "env-abc-123",
  "accessLevel": "read-only"
}
```

---

## Access Administration API: Update environment information for a user

### Description
Updates the environment access information for a user.

### Method
PUT

### Endpoint
/api/users/{userId}/environments/{environmentId}

### Parameters
#### Path Parameters
- **userId** (string) - Required - The ID of the user.
- **environmentId** (string) - Required - The ID of the environment.
#### Request Body
- **accessLevel** (string) - Required - The new access level for the user in the environment.

### Request Example
```json
{
  "accessLevel": "read-write"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the environment information was updated.

#### Response Example
```json
{
  "message": "User environment information updated successfully."
}
```

---

## Access Administration API: Get users for a specified environment

### Description
Retrieves a list of users who have access to a specific environment.

### Method
GET

### Endpoint
/api/environments/{environmentId}/users

### Parameters
#### Path Parameters
- **environmentId** (string) - Required - The ID of the environment.

### Response
#### Success Response (200)
- **users** (array) - A list of user objects with access to the environment.
  - **userId** (string) - The ID of the user.
  - **username** (string) - The username.

#### Response Example
```json
{
  "users": [
    {
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "username": "userA"
    },
    {
      "userId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "username": "userB"
    }
  ]
}
```

---

## Access Administration API: Remove a user's access to an environment

### Description
Removes a user's access to a specific environment.

### Method
DELETE

### Endpoint
/api/users/{userId}/environments/{environmentId}

### Parameters
#### Path Parameters
- **userId** (string) - Required - The ID of the user.
- **environmentId** (string) - Required - The ID of the environment.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating access was removed.

#### Response Example
```json
{
  "message": "User access to environment removed successfully."
}
```
```

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

### Access Administration API - Authentication and Reports

Source: https://www.ibm.com/docs/en/apptio-platform/access-administration/saas_topic=access-administration

Endpoints related to API authentication methods and generating reports.

```APIDOC
## Access Administration API: Basic authentication using a user name and password

### Description
Provides information on how to authenticate with the API using basic username and password credentials.

### Method
POST

### Endpoint
/api/auth/login

### Parameters
#### Request Body
- **username** (string) - Required - The user's username.
- **password** (string) - Required - The user's password.

### Request Example
```json
{
  "username": "apiuser",
  "password": "securepassword"
}
```

### Response
#### Success Response (200)
- **token** (string) - An authentication token for subsequent API requests.

#### Response Example
```json
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
```

---

## Access Administration API: Authentication via API keys

### Description
Details on how to authenticate API requests using API keys.

### Method
POST

### Endpoint
/api/auth/apikey

### Parameters
#### Request Body
- **apiKey** (string) - Required - The API key for authentication.

### Request Example
```json
{
  "apiKey": "your_api_key_here"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating successful authentication with API key.

#### Response Example
```json
{
  "message": "Authenticated successfully using API key."
}
```

---

## Access Administration API: Get authentication report for a domain

### Description
Generates a report detailing authentication activities for a given domain.

### Method
GET

### Endpoint
/api/reports/authentication/{domainId}

### Parameters
#### Path Parameters
- **domainId** (string) - Required - The ID of the domain for which to generate the report.

### Response
#### Success Response (200)
- **reportData** (array) - An array containing authentication event records.
  - **timestamp** (string) - The time of the authentication event.
  - **userId** (string) - The ID of the user.
  - **status** (string) - The status of the authentication (e.g., 'success', 'failure').

#### Response Example
```json
{
  "reportData": [
    {
      "timestamp": "2023-10-27T10:00:00Z",
      "userId": "user123",
      "status": "success"
    },
    {
      "timestamp": "2023-10-27T10:05:00Z",
      "userId": "user456",
      "status": "failure"
    }
  ]
}
```
```
Tokens:
Raw