> ## Documentation Index
> Fetch the complete documentation index at: https://docs.m3ter.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Serviceusers

## Activate ServiceUser Credentials

**Function name:** `m3ter_ActivateServiceUserCredentials`
**Category:** WRITE
**HTTP method:** PUT
**Destination:** m3ter

Activate a credentials key pair for a service user.

### Parameters

| Name | Label | Type | Required | Description | Constraints |
| - | - | - | :-: | - | - |
| `integrationCredentialsId` | Credentials | M3terEntityParameter | Yes | The m3ter credentials to use. | authType: M3TER\_SIGNED\_REQUEST, m3terEntity: IntegrationCredentials |
| `id` | id | LookupParameter | Yes | UUID of the service user. | - |
| `apiKey` | apiKey | LookupParameter | Yes | API key for the service user credentials. | - |
| `statePath` | State Path | StateVariableParameter | No | State variable to store the response. | - |

### Exits

| Exit | Description |
| - | - |
| `NEXT` | The API call succeeded. |
| `ERROR` | The API call failed. Error details are stored in the `m3shError` state variable. |

## Retrieve ServiceUser Permissions

**Function name:** `m3ter_GetServiceUserPermissions`
**Category:** READ
**HTTP method:** GET
**Destination:** m3ter

Retrieve permission policies attached to a service user.

### Parameters

| Name | Label | Type | Required | Description | Constraints |
| - | - | - | :-: | - | - |
| `integrationCredentialsId` | Credentials | M3terEntityParameter | Yes | The m3ter credentials to use. | authType: M3TER\_SIGNED\_REQUEST, m3terEntity: IntegrationCredentials |
| `id` | id | LookupParameter | Yes | UUID of the service user. | - |
| `statePath` | State Path | StateVariableParameter | No | State variable to store the response. | - |

### Exits

| Exit | Description |
| - | - |
| `NEXT` | The API call succeeded. |
| `ERROR` | The API call failed. Error details are stored in the `m3shError` state variable. |

## List ServiceUser Credentials

**Function name:** `m3ter_ListServiceUserCredentials`
**Category:** READ
**HTTP method:** GET (paginated)
**Destination:** m3ter

Retrieve the credentials key pairs for a service user.

### Parameters

| Name | Label | Type | Required | Description | Constraints |
| - | - | - | :-: | - | - |
| `integrationCredentialsId` | Credentials | M3terEntityParameter | Yes | The m3ter credentials to use. | authType: M3TER\_SIGNED\_REQUEST, m3terEntity: IntegrationCredentials |
| `id` | id | LookupParameter | Yes | UUID of the service user. | - |
| `statePath` | State Path | StateVariableParameter | No | State variable to store the response. | - |

### Exits

| Exit | Description |
| - | - |
| `NEXT` | The API call succeeded. |
| `ERROR` | The API call failed. Error details are stored in the `m3shError` state variable. |

## Create ServiceUser Credentials

**Function name:** `m3ter_PostServiceUserCredentials`
**Category:** WRITE
**HTTP method:** POST
**Destination:** m3ter

Create a new credentials key pair for a service user.

### Parameters

| Name | Label | Type | Required | Description | Constraints |
| - | - | - | :-: | - | - |
| `integrationCredentialsId` | Credentials | M3terEntityParameter | Yes | The m3ter credentials to use. | authType: M3TER\_SIGNED\_REQUEST, m3terEntity: IntegrationCredentials |
| `id` | id | LookupParameter | Yes | UUID of the service user. | - |
| `statePath` | State Path | StateVariableParameter | No | State variable to store the response. | - |

### Exits

| Exit | Description |
| - | - |
| `NEXT` | The API call succeeded. |
| `ERROR` | The API call failed. Error details are stored in the `m3shError` state variable. |

## Deactivate ServiceUser Credentials

**Function name:** `m3ter_InactivateServiceUserCredentials`
**Category:** WRITE
**HTTP method:** PUT
**Destination:** m3ter

Deactivate a credentials key pair for a service user.

### Parameters

| Name | Label | Type | Required | Description | Constraints |
| - | - | - | :-: | - | - |
| `integrationCredentialsId` | Credentials | M3terEntityParameter | Yes | The m3ter credentials to use. | authType: M3TER\_SIGNED\_REQUEST, m3terEntity: IntegrationCredentials |
| `id` | id | LookupParameter | Yes | UUID of the service user. | - |
| `apiKey` | apiKey | LookupParameter | Yes | API key for the service user credentials. | - |
| `statePath` | State Path | StateVariableParameter | No | State variable to store the response. | - |

### Exits

| Exit | Description |
| - | - |
| `NEXT` | The API call succeeded. |
| `ERROR` | The API call failed. Error details are stored in the `m3shError` state variable. |

## Retrieve ServiceUser Credentials

**Function name:** `m3ter_GetServiceUserCredentials`
**Category:** READ
**HTTP method:** GET
**Destination:** m3ter

Retrieve a credentials key pair for a service user.

### Parameters

| Name | Label | Type | Required | Description | Constraints |
| - | - | - | :-: | - | - |
| `integrationCredentialsId` | Credentials | M3terEntityParameter | Yes | The m3ter credentials to use. | authType: M3TER\_SIGNED\_REQUEST, m3terEntity: IntegrationCredentials |
| `id` | id | LookupParameter | Yes | UUID of the service user. | - |
| `apiKey` | apiKey | LookupParameter | Yes | API key for the service user credentials. | - |
| `statePath` | State Path | StateVariableParameter | No | State variable to store the response. | - |

### Exits

| Exit | Description |
| - | - |
| `NEXT` | The API call succeeded. |
| `ERROR` | The API call failed. Error details are stored in the `m3shError` state variable. |

## Delete ServiceUser Credentials

**Function name:** `m3ter_DeleteServiceUserCredentials`
**Category:** WRITE
**HTTP method:** DELETE
**Destination:** m3ter

Delete a deactivated credentials key pair for a service user.

### Parameters

| Name | Label | Type | Required | Description | Constraints |
| - | - | - | :-: | - | - |
| `integrationCredentialsId` | Credentials | M3terEntityParameter | Yes | The m3ter credentials to use. | authType: M3TER\_SIGNED\_REQUEST, m3terEntity: IntegrationCredentials |
| `id` | id | LookupParameter | Yes | UUID of the service user. | - |
| `apiKey` | apiKey | LookupParameter | Yes | API key for the service user credentials. | - |
| `statePath` | State Path | StateVariableParameter | No | State variable to store the response. | - |

### Exits

| Exit | Description |
| - | - |
| `NEXT` | The API call succeeded. |
| `ERROR` | The API call failed. Error details are stored in the `m3shError` state variable. |

## Retrieve ServiceUser

**Function name:** `m3ter_GetServiceUser`
**Category:** READ
**HTTP method:** GET
**Destination:** m3ter

Retrieve the service user for the UUID.

### Parameters

| Name | Label | Type | Required | Description | Constraints |
| - | - | - | :-: | - | - |
| `integrationCredentialsId` | Credentials | M3terEntityParameter | Yes | The m3ter credentials to use. | authType: M3TER\_SIGNED\_REQUEST, m3terEntity: IntegrationCredentials |
| `id` | id | LookupParameter | Yes | UUID of the service user to retrieve. | - |
| `statePath` | State Path | StateVariableParameter | No | State variable to store the response. | - |

### Exits

| Exit | Description |
| - | - |
| `NEXT` | The API call succeeded. |
| `ERROR` | The API call failed. Error details are stored in the `m3shError` state variable. |

## Update ServiceUser

**Function name:** `m3ter_PutServiceUser`
**Category:** WRITE
**HTTP method:** PUT
**Destination:** m3ter

Update the service user for the UUID.

### Parameters

| Name | Label | Type | Required | Description | Constraints |
| - | - | - | :-: | - | - |
| `integrationCredentialsId` | Credentials | M3terEntityParameter | Yes | The m3ter credentials to use. | authType: M3TER\_SIGNED\_REQUEST, m3terEntity: IntegrationCredentials |
| `id` | id | LookupParameter | Yes | UUID of the service user to update. | - |
| `requestPath` | Request Path | StateVariableParameter | Yes | State variable containing the request. | - |
| `statePath` | State Path | StateVariableParameter | No | State variable to store the response. | - |

### Exits

| Exit | Description |
| - | - |
| `NEXT` | The API call succeeded. |
| `ERROR` | The API call failed. Error details are stored in the `m3shError` state variable. |

## Delete ServiceUser

**Function name:** `m3ter_DeleteServiceUser`
**Category:** WRITE
**HTTP method:** DELETE
**Destination:** m3ter

Delete the service user for the UUID.

### Parameters

| Name | Label | Type | Required | Description | Constraints |
| - | - | - | :-: | - | - |
| `integrationCredentialsId` | Credentials | M3terEntityParameter | Yes | The m3ter credentials to use. | authType: M3TER\_SIGNED\_REQUEST, m3terEntity: IntegrationCredentials |
| `id` | id | LookupParameter | Yes | UUID of the service user to delete. | - |
| `statePath` | State Path | StateVariableParameter | No | State variable to store the response. | - |

### Exits

| Exit | Description |
| - | - |
| `NEXT` | The API call succeeded. |
| `ERROR` | The API call failed. Error details are stored in the `m3shError` state variable. |

## List ServiceUsers

**Function name:** `m3ter_ListServiceUsers`
**Category:** READ
**HTTP method:** GET (paginated)
**Destination:** m3ter

Retrieve a list of service users.

### Parameters

| Name | Label | Type | Required | Description | Constraints |
| - | - | - | :-: | - | - |
| `integrationCredentialsId` | Credentials | M3terEntityParameter | Yes | The m3ter credentials to use. | authType: M3TER\_SIGNED\_REQUEST, m3terEntity: IntegrationCredentials |
| `statePath` | State Path | StateVariableParameter | No | State variable to store the response. | - |

### Exits

| Exit | Description |
| - | - |
| `NEXT` | The API call succeeded. |
| `ERROR` | The API call failed. Error details are stored in the `m3shError` state variable. |

## Create ServiceUser

**Function name:** `m3ter_PostServiceUser`
**Category:** WRITE
**HTTP method:** POST
**Destination:** m3ter

Create a new service user.

### Parameters

| Name | Label | Type | Required | Description | Constraints |
| - | - | - | :-: | - | - |
| `integrationCredentialsId` | Credentials | M3terEntityParameter | Yes | The m3ter credentials to use. | authType: M3TER\_SIGNED\_REQUEST, m3terEntity: IntegrationCredentials |
| `requestPath` | Request Path | StateVariableParameter | Yes | State variable containing the request. | - |
| `statePath` | State Path | StateVariableParameter | No | State variable to store the response. | - |

### Exits

| Exit | Description |
| - | - |
| `NEXT` | The API call succeeded. |
| `ERROR` | The API call failed. Error details are stored in the `m3shError` state variable. |