Multiplier

https://docs.multiplierhq.com/en/
Admin
Multiplier is a Jira Service Management plugin that helps organizations automate and streamline...
Tokens:26,625
Snippets:253
Trust Score:8.4
Update:1 day ago
Show doc for...
Tokens:
Raw
### Example response from command/get-access-types

Source: https://docs.multiplierhq.com/en/articles/10384701-multiplier-api-documentation

Example JSON response containing a list of access types for the application. Each access type includes a label and a key.

```json
[
  {
    "label": "Regular",
    "key": "b6e4620a-760e-4d99-bce2-a9fff22728d4"
  },
  {
    "label": "Admin",
    "key": "a42a063a-fde2-4b79-a342-2c4bdfffa746"
  }
]
```

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

### Example curl request to command/get-access-types

Source: https://docs.multiplierhq.com/en/articles/10384701-multiplier-api-documentation

Example curl command to retrieve access types for an application. Replace YOUR_API_TOKEN with your actual API token and provide the applicationKey and userEmail in the request body.

```bash
curl -X POST https://app.multiplierhq.com/command/get-access-types \
-H "Authorization: YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
  "applicationKey": "00000000-0000-0000-0000-000000031950",
  "userEmail": "[email protected]"
}'
```

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

### Example Response for list-applications

Source: https://docs.multiplierhq.com/en/articles/10384701-multiplier-api-documentation

A JSON array of approved applications, each with name, key, category, tags, owner, selfService flag, and accessTypes.

```json
[
  {
    "name": "Tableau Cloud US",
    "key": "7ab0f724-251b-499e-ad83-1f0e5394e5a1",
    "category": "Data Services",
    "tags": [
      {
        "label": "finance"
      }
    ],
    "owner": {
      "name": "Jane Doe",
      "email": "[email protected]",
      "accountId": "712020:a1b2c3d4..."
    },
    "selfService": false,
    "accessTypes": [
      {
        "label": "Viewer",
        "key": "11c1128a-e3e5-4f6e-8213-dea5df2c0f59",
        "approvers": [
          {
            "type": "owner",
            "name": "Jane Doe",
            "email": "[email protected]",
            "accountId": "712020:a1b2c3d4..."
          }
        ]
      }
    ]
  }
]
```

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

### curl example for POST /command/request-access

Source: https://docs.multiplierhq.com/en/articles/10384701-multiplier-api-documentation

Example curl command to request access. Replace YOUR_API_TOKEN with your token and adjust the applicationKey, accessTypeKey, and userEmail values. The response contains a URL and key for the created access request.

```bash
curl -X POST https://app.multiplierhq.com/command/request-access \
-H "Authorization: YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
  "applicationKey": "00000000-0000-0000-0000-000000031950",
  "accessTypeKey": "00000000-0000-0000-0000-000000064234",
  "userEmail": "[email protected]"
}'
```

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

### curl Request for list-applications

Source: https://docs.multiplierhq.com/en/articles/10384701-multiplier-api-documentation

Example curl command to POST to the list-applications endpoint with the authorization header and JSON body.

```bash
curl -X POST https://app.multiplierhq.com/command/list-applications \ -H "Authorization: YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "userEmail": "[email protected]" }'
```

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

### Example response from request-access endpoint

Source: https://docs.multiplierhq.com/en/articles/10384701-multiplier-api-documentation

Sample JSON response returned by the request-access endpoint, containing the service desk URL and the access request key.

```json
{
  "url": "https://your-instance.atlassian.net/servicedesk/customer/portal/1/YGA-235",
  "key": "YGA-235"
}
```

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

### POST /command/list-applications

Source: https://docs.multiplierhq.com/en/articles/10384701-multiplier-api-documentation

Retrieves a full catalog of configured applications, including UUID keys, categories, owners, and access types. Useful for programmatically referencing application keys.

```APIDOC
## POST /command/list-applications

### Description
Retrieves a full catalog of your configured applications, including their UUID keys, categories, owners, and access types.

### Method
POST

### Endpoint
`https://app.multiplierhq.com/command/list-applications`

### Parameters
#### Request Body
- **userEmail** (string) - Required - The email address of a valid Jira admin in your instance.

### Request Example
```
{
  "userEmail": "[email protected]"
}
```

### Response
#### Success Response (200)
A JSON array of all approved applications configured in your Multiplier catalog.

#### Response Example
```
[
  {
    "name": "Tableau Cloud US",
    "key": "7ab0f724-251b-499e-ad83-1f0e5394e5a1",
    "category": "Data Services",
    "tags": [
      {
        "label": "finance"
      }
    ],
    "owner": {
      "name": "Jane Doe",
      "email": "[email protected]",
      "accountId": "712020:a1b2c3d4..."
    },
    "selfService": false,
    "accessTypes": [
      {
        "label": "Viewer",
        "key": "11c1128a-e3e5-4f6e-8213-dea5df2c0f59",
        "approvers": [
          {
            "type": "owner",
            "name": "Jane Doe",
            "email": "[email protected]",
            "accountId": "712020:a1b2c3d4..."
          }
        ]
      }
    ]
  }
]
```

### Authentication
Requires a valid API token passed in the `authorization` header field.

### Notes
If your Jira instance is hosted in the EU or APAC, use `eu-central-1.app.multiplierhq.com` or `ap-southeast-2.app.multiplierhq.com` respectively.
```

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

### POST /command/get-access-types

Source: https://docs.multiplierhq.com/en/articles/10384701-multiplier-api-documentation

Retrieves a list of access types for a given application key and user email. Returns a 404 error if the application or user cannot be found.

```APIDOC
## POST /command/get-access-types

### Description
Retrieves a list of access types for a given application key and user email. Returns a 404 error if the application or user cannot be found.

### Method
POST

### Endpoint
https://app.multiplierhq.com/command/get-access-types

### Parameters
#### Request Body
- **applicationKey** (string) - Required - The unique identifier for the application.
- **userEmail** (string) - Required - The email address of the user for whom access will be requested.

### Request Example
```
curl -X POST https://app.multiplierhq.com/command/get-access-types \
-H "Authorization: YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
  "applicationKey": "00000000-0000-0000-0000-000000031950",
  "userEmail": "[email protected]"
}'
```

### Response
#### Success Response (200)
A list of access types for the given application key.

#### Response Example
```
[
  {
    "label": "Regular",
    "key": "b6e4620a-760e-4d99-bce2-a9fff22728d4"
  },
  {
    "label": "Admin",
    "key": "a42a063a-fde2-4b79-a342-2c4bdfffa746"
  }
]
```

### Error Handling
- **404** - Application or user not found.
```
Tokens:
Raw