Symphony Messaging API

https://rest-api.symphony.com
Admin
Symphony Messaging API is a comprehensive REST API reference for the Symphony messaging platform,...
Tokens:256,898
Snippets:892
Trust Score:10
Update:7 months ago
Show doc for...
Tokens:
Raw
### GET /agent/info

Source: https://rest-api.symphony.com/main/info-health-check

Gets configuration and deployment information about the Agent service.

```APIDOC
## GET /agent/info

### Description
Gets configuration and deployment information about the Agent service.

### Method
GET

### Endpoint
/agent/info

### Response
#### Success Response (200)
- **version** (string) - The version of the agent.
- **config** (object) - Configuration details.

#### Response Example
{
  "version": "3.0.1",
  "config": { "mode": "production" }
}
```

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

### API Response Example (200 OK)

Source: https://rest-api.symphony.com/main/streams-conversations/all-streams-endpoints/list-streams-for-enterprise-v2

This is an example of a successful response (HTTP 200 OK) from the /v2/admin/streams/list endpoint. It includes the total count of matching streams, pagination details, and a list of stream objects with their attributes.

```json
{
  "count": 4,
  "skip": 0,
  "limit": 50,
  "filter": {
    "streamTypes": [
      null
    ]
  },
  "streams": [
    {
      "id": "Q2KYGm7JkljrgymMajYTJ3___qcLPr1UdA",
      "isExternal": false,
      "isActive": true,
      "isPublic": false,
      "type": "ROOM",
      "attributes": {
        "roomName": "Active Internal Private Room",
        "roomDescription": "Active Internal Private Room",
        "createdByUserId": 8933531975689,
        "createdDate": 1481575056047,
        "lastModifiedDate": 1481575056047,
        "originCompany": "Symphony",
        "originCompanyId": 130,
        "membersCount": 1,
        "lastMessageDate": 1516699467959
      }
    },
    {
      "id": "_KnoYrMkhEn3H2_8vE0kl3___qb5SANQdA",
      "isExternal": true,
      "isActive": false,
      "isPublic": false,
      "type": "ROOM",
      "attributes": {
        "roomName": "Inactive External Room",
        "roomDescription": "Inactive External Room",
        "createdByUserId": 8933531975686,
        "createdDate": 1481876438194,
        "lastModifiedDate": 1481876438194,
        "originCompany": "Symphony",
        "originCompanyId": 130,
        "membersCount": 2,
        "lastMessageDate": 1516699467959
      }
    },
    {
      "id": "fBoaBSRUyb5Rq3YgeSqZvX___qbf5IAhdA",
      "isExternal": false,
      "isActive": true,
      "type": "IM",
      "attributes": {
        "members": [
          // ... more members data
        ]
      }
    }
    // ... more stream objects
  ]
}
```

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

### Get DLP Violations (cURL)

Source: https://rest-api.symphony.com/main/dlp-dictionary-and-policy-management/v3-violations-endpoints/v3-message-violations

Example of how to retrieve DLP message violations using cURL. This request requires a session token and specifies a start time for the violations.

```cURL
GET /agent/v3/dlp/violations/message?startTime=1 HTTP/1.1
Host: youragentURL.symphony.com
sessionToken: text
Accept: */*


```

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

### Create Basic Message with MessageML using multipart/form-data

Source: https://rest-api.symphony.com/main/messages/create-message-v4

This example shows how to send a simple text message using MessageML format with the `multipart/form-data` content type. It requires sessionToken and keyManagerToken for authentication.

```bash
curl -X POST \
  https://acme.symphony.com/agent/v4/stream/xFfPil_o26qXzGwWvcw5RH___qQr0W7EdA/message/create \
  -H 'Content-Type: multipart/form-data' \
  -H 'sessionToken: SESSION_TOKEN' \
	-H 'keyManagerToken: KEY_MANAGER_TOKEN' \
  --form-string 'message=<messageML>Hello world!</messageML>'
```

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

### POST /configuration

Source: https://rest-api.symphony.com/main/manage-apps/get-application

Creates or updates an application configuration property with specific validation constraints.

```APIDOC
## POST /configuration

### Description
Creates or updates an application configuration property. Keys must be unique, non-empty, and under 1024 characters. Values must be non-null and under 4096 characters.

### Method
POST

### Endpoint
/configuration

### Parameters
#### Request Body
- **key** (string) - Required - Unique identifier for the configuration property (max 1024 chars).
- **value** (string) - Required - The value of the configuration property (max 4096 chars).

### Request Example
{
  "key": "app.timeout",
  "value": "3000"
}

### Response
#### Success Response (200)
- **status** (string) - Confirmation of the update.

#### Error Handling
- **403 Forbidden**: Requires Super Administrator, Super Compliance Officer, User Provisioning, or Agent role.
- **400 Bad Request**: Invalid key or value format.
```

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

### GET /v1/info

Source: https://rest-api.symphony.com/main/info-health-check/agent-info-v1

Retrieves comprehensive information about the Agent, such as its IP address, hostname, version, and whether it's a cloud or on-prem installation.

```APIDOC
## GET /v1/info

### Description
Get information about the Agent.

### Method
GET

### Endpoint
/v1/info

### Parameters
#### Query Parameters
None

#### Path Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **ipAddress** (string) - The IP address of the Agent server.
- **hostname** (string) - The hostname of the Agent server.
- **serverFqdn** (string) - The fully-qualified domain name of the Agent server. Must be set by the user at startup.
- **version** (string) - The version of the Agent.
- **url** (string) - The URL under which the Agent is available.
- **onPrem** (boolean) - Whether this is an on-prem or cloud installation.
- **mt** (boolean) - Whether this is a multi tenant instance.
- **commitId** (string) - The Git commit ID of the running revision.

#### Error Responses
- **400** (object) - Client error, see response body for further details.
- **401** (object) - Unauthorized: Session tokens invalid.
- **403** (object) - Forbidden: Caller lacks necessary entitlement.
- **500** (object) - Server error, see response body for further details.

#### Response Example (200 OK)
```json
{
  "ipAddress": "192.168.1.100",
  "hostname": "agent-host",
  "serverFqdn": "agent.example.com",
  "version": "25.8.1",
  "url": "https://agent.example.com",
  "onPrem": true,
  "mt": false,
  "commitId": "a1b2c3d4e5f6"
}
```
```

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

### GET /agent/v1/audittrail/privilegeduser

Source: https://rest-api.symphony.com/main/user-management/list-audit-trail-v1

Retrieves a paginated list of audit trail events for privileged users. Supports filtering by start timestamp and navigating through results using 'before' and 'after' cursors.

```APIDOC
## GET /agent/v1/audittrail/privilegeduser

### Description
Retrieves audit logs for privileged user actions. The endpoint uses cursor-based pagination to handle large datasets efficiently.

### Method
GET

### Endpoint
/agent/v1/audittrail/privilegeduser

### Parameters
#### Query Parameters
- **startTimestamp** (long) - Required - The epoch timestamp in milliseconds to start the audit search.
- **limit** (integer) - Optional - The maximum number of records to return per page (default is 50).
- **after** (string) - Optional - Cursor string to fetch the next page of results.
- **before** (string) - Optional - Cursor string to fetch the previous page of results.

### Response
#### Success Response (200)
- **items** (array) - List of audit trail objects.
- **pagination** (object) - Contains cursors and links for 'next' and 'previous' pages.

#### Response Example
{
  "items": [
    {
      "action": "RSA Key Added",
      "actionName": "rsaKeyAdded",
      "initiatorId": 7215545057307,
      "timestamp": 1555510357831
    }
  ],
  "pagination": {
    "cursors": {
      "after": "1"
    },
    "next": "/agent/v1/audittrail/privilegeduser?&startTimestamp=1553264312000&limit=1&after=1"
  }
}
```

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

### POST /v3/room/create

Source: https://rest-api.symphony.com/main/streams-conversations

Creates a new chatroom with specified attributes.

```APIDOC
## POST /v3/room/create

### Description
Creates a new chatroom. See Room Attributes for room creation parameters.

### Method
POST

### Endpoint
/v3/room/create

### Request Body
- **name** (string) - Required - The name of the chatroom.
- **description** (string) - Optional - A brief description of the room purpose.
- **membersCanInvite** (boolean) - Optional - Whether members can invite others.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the new room.

#### Response Example
{
  "id": "room-987-xyz"
}
```

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

### Get Subscribers

Source: https://rest-api.symphony.com/main/signals

Gets the subscribers for the specified signal.

```APIDOC
## GET /main/signals/subscribers.md

### Description
Gets the subscribers for the specified signal.

### Method
GET

### Endpoint
/main/signals/subscribers.md

### Parameters
#### Query Parameters
- **signalId** (string) - Required - The ID of the signal whose subscribers are to be retrieved.

### Response
#### Success Response (200)
- **subscribers** (array) - A list of user objects who are subscribed to the signal.
  - **id** (string) - The unique identifier for the user.
  - **name** (string) - The name of the user.

#### Response Example
{
  "subscribers": [
    {
      "id": "user_abc",
      "name": "Alice"
    },
    {
      "id": "user_def",
      "name": "Bob"
    }
  ]
}
```

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

### Get Signal

Source: https://rest-api.symphony.com/main/signals

Gets details about the specified signal.

```APIDOC
## GET /main/signals/get-signal.md

### Description
Gets details about the specified signal.

### Method
GET

### Endpoint
/main/signals/get-signal.md

### Parameters
#### Query Parameters
- **signalId** (string) - Required - The ID of the signal to retrieve.

### Response
#### Success Response (200)
- **signal** (object) - The signal object containing its details.
  - **id** (string) - The unique identifier for the signal.
  - **name** (string) - The name of the signal.
  - **description** (string) - A description of the signal.
  - **isPublic** (boolean) - Indicates if the signal is public.
  - **createdAt** (string) - The timestamp when the signal was created.
  - **updatedAt** (string) - The timestamp when the signal was last updated.

#### Response Example
{
  "signal": {
    "id": "sig_123",
    "name": "Sales Leads",
    "description": "Leads generated from sales activities",
    "isPublic": false,
    "createdAt": "2023-10-27T10:00:00Z",
    "updatedAt": "2023-10-27T10:00:00Z"
  }
}
```

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

### Create Message with Attachments using multipart/form-data

Source: https://rest-api.symphony.com/main/messages/create-message-v4

This example demonstrates sending a message with multiple image attachments using `multipart/form-data`. It includes the message content and specifies image files as attachments. Session and key manager tokens are required.

```bash
curl -X POST \
  https://acme.symphony.com:443/agent/v4/stream/xFfPil_o26qXzGwWvcw5RH___qQr0W7EdA/message/create \
  -H 'content-type: multipart/form-data' \
  -H 'keyManagerToken: KEY_MANAGER_TOKEN' \
  -H 'sessionToken: SESSION_TOKEN' \
  --form-string 'message=<messageML>Hello world!</messageML>' \
  -F 'attachment=@image1.png' \
  -F 'attachment=@image2.png'
```

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

### Create User via Symphony REST API

Source: https://rest-api.symphony.com/main/user-management/create-user-v2

Demonstrates how to create a new user in the Symphony Pod using a POST request. The payload requires user attributes, security keys, and optionally password derivation or role assignments.

```bash
curl -X POST \
https://acme.symphony.com/pod/v2/admin/user/create \
-H "sessionToken: SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{
    "userAttributes": {
        "accountType": "NORMAL",
        "emailAddress": "janedoe@symphony.com",
        "firstName": "Jane",
        "lastName": "Doe",
        "userName": "janedoe",
        "displayName": "Jane Doe",
        "currentKey": {"key": "-----BEGIN PUBLIC KEY-----\nMIICIjAN...==\n-----END PUBLIC KEY-----"}
    },
    "password": {
        "hSalt": "password",
        "hPassword": "password",
        "khSalt": "password",
        "khPassword": "password"
    }
}'
```

```bash
curl -X POST \
https://acme.symphony.com/pod/v2/admin/user/create \
-H "sessionToken: SESSION_TOKEN" -H "Content-Type: application/json" \
-d '{
  "userAttributes": {
    "accountType": "SYSTEM",
    "emailAddress": "apiuser@symphony.com",
    "userName": "apiuser",
    "displayName": "API User",
    "currentKey": {
        "key": "-----BEGIN PUBLIC KEY-----MII...Q==-----END PUBLIC KEY-----"
    }
  },
  "roles": ["INDIVIDUAL", "USER_PROVISIONING", "SCOPE_MANAGEMENT"]
}'
```

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

### V2 Get Policy

Source: https://rest-api.symphony.com/deprecated-endpoints

Gets a policy. This endpoint is deprecated.

```APIDOC
## GET /deprecated-endpoints/dlp-dictionary-and-policy-management/v2-policy-management-endpoints/v2-get-policy.md

### Description
Gets a policy. This endpoint is deprecated.

### Method
GET

### Endpoint
/deprecated-endpoints/dlp-dictionary-and-policy-management/v2-policy-management-endpoints/v2-get-policy.md

### Parameters
#### Query Parameters
- **policyId** (string) - Required - The ID of the policy to retrieve.

### Response
#### Success Response (200)
- **id** (string) - The ID of the policy.
- **name** (string) - The name of the policy.
- **type** (string) - The type of the policy.
- **contentTypes** (array) - A list of content types the policy applies to.
- **scopes** (array) - A list of scopes for the policy.

#### Response Example
```json
{
  "id": "policy-123",
  "name": "Policy Name",
  "type": "Policy Type",
  "contentTypes": ["message"],
  "scopes": ["all"]
}
```
```

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

### POST /v2/admin/user/create

Source: https://rest-api.symphony.com/main/user-management/create-user-v2

Creates a new V2 User in the system. This endpoint allows for the initial creation of a user account with basic details.

```APIDOC
## POST /v2/admin/user/create

### Description
Create a new V2 User

### Method
POST

### Endpoint
/v2/admin/user/create

### Parameters
#### Header Parameters
- **sessionToken** (string) - Required - Session authentication token.

#### Request Body
- **userAttributes** (V2UserAttributes) - Required - User attributes for creation.
- **userSystemInfo** (UserSystemInfo) - Optional - System information for the user.
- **features** (IntegerList) - Optional - List of feature IDs.
- **apps** (IntegerList) - Optional - List of application IDs.
- **groups** (IntegerList) - Optional - List of group IDs.
- **roles** (StringList) - Optional - List of roles.
- **disclaimers** (IntegerList) - Optional - List of disclaimer IDs.
- **avatar** (Avatar) - Optional - User avatar information.

### Request Example
```json
{
  "userAttributes": {
    "emailAddress": "user@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "userName": "johndoe",
    "displayName": "John Doe",
    "companyName": "Example Corp",
    "department": "IT",
    "division": "Technology",
    "title": "Software Engineer",
    "workPhoneNumber": "123-456-7890",
    "mobilePhoneNumber": "987-654-3210",
    "twoFactorAuthPhone": "111-222-3333",
    "smsNumber": "444-555-6666",
    "accountType": "NORMAL",
    "location": "New York",
    "recommendedLanguage": "en-US",
    "jobFunction": "Developer",
    "assetClasses": ["Equities", "Fixed Income"],
    "industries": ["Technology", "Finance"],
    "marketCoverage": ["Global"],
    "responsibility": ["Development"],
    "function": ["Engineering"],
    "instrument": ["Stocks", "Bonds"],
    "currentKey": {
      "key": "-----BEGIN PUBLIC KEY-----\n...\n-----END PUBLIC KEY-----",
      "expirationDate": 1678886400000,
      "action": "SAVE"
    },
    "previousKey": {
      "key": "-----BEGIN PUBLIC KEY-----\n...\n-----END PUBLIC KEY-----",
      "expirationDate": 1647331200000,
      "action": "REVOKE"
    }
  }
}
```

### Response
#### Success Response (200)
- **userAttributes** (V2UserAttributes) - Details of the created V2 user.
- **userSystemInfo** (UserSystemInfo) - System information about the created user.
- **features** (IntegerList) - List of features assigned to the user.
- **apps** (IntegerList) - List of applications assigned to the user.
- **groups** (IntegerList) - List of groups the user belongs to.
- **roles** (StringList) - List of roles assigned to the user.
- **disclaimers** (IntegerList) - List of disclaimer IDs associated with the user.
- **avatar** (Avatar) - Information about the user's avatar.

#### Response Example
```json
{
  "userAttributes": {
    "emailAddress": "user@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "userName": "johndoe",
    "displayName": "John Doe",
    "companyName": "Example Corp",
    "department": "IT",
    "division": "Technology",
    "title": "Software Engineer",
    "workPhoneNumber": "123-456-7890",
    "mobilePhoneNumber": "987-654-3210",
    "twoFactorAuthPhone": "111-222-3333",
    "smsNumber": "444-555-6666",
    "accountType": "NORMAL",
    "location": "New York",
    "recommendedLanguage": "en-US",
    "jobFunction": "Developer",
    "assetClasses": ["Equities", "Fixed Income"],
    "industries": ["Technology", "Finance"],
    "marketCoverage": ["Global"],
    "responsibility": ["Development"],
    "function": ["Engineering"],
    "instrument": ["Stocks", "Bonds"],
    "currentKey": {
      "key": "-----BEGIN PUBLIC KEY-----\n...\n-----END PUBLIC KEY-----",
      "expirationDate": 1678886400000,
      "action": "SAVE"
    },
    "previousKey": {
      "key": "-----BEGIN PUBLIC KEY-----\n...\n-----END PUBLIC KEY-----",
      "expirationDate": 1647331200000,
      "action": "REVOKE"
    }
  },
  "userSystemInfo": {
    "id": 12345,
    "status": "ENABLED",
    "createdDate": 1678886400000,
    "createdBy": "admin",
    "lastUpdatedDate": 1678886400000,
    "lastLoginDate": 1678886400000,
    "lastPasswordReset": 1678886400000,
    "deactivatedDate": null
  },
  "features": [1, 2, 3],
  "apps": [10, 20],
  "groups": [100, 200],
  "roles": ["Admin", "User"],
  "disclaimers": [5, 6],
  "avatar": {
    "size": "LARGE",
    "url": "http://example.com/avatar.jpg"
  }
}
```

#### Error Response (400, 401, 403, 500)
- **code** (integer) - Error code.
- **message** (string) - Error message.

#### Error Response Example
```json
{
  "code": 400,
  "message": "Invalid input provided."
}
```
```

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

### OpenAPI Specification for Get Disclaimer

Source: https://rest-api.symphony.com/main/disclaimers/disclaimer

The OpenAPI 3.1.1 definition for the GET /v1/admin/disclaimer/{did} endpoint. It defines the required sessionToken header, the disclaimer ID path parameter, and the expected JSON response schema.

```json
{
  "openapi": "3.1.1",
  "info": {
    "title": "Pod API",
    "version": "20.17.1"
  },
  "paths": {
    "/v1/admin/disclaimer/{did}": {
      "get": {
        "summary": "Get a disclaimer by disclaimer id",
        "parameters": [
          {
            "name": "sessionToken",
            "in": "header",
            "required": true,
            "schema": { "type": "string" }
          },
          {
            "name": "did",
            "in": "path",
            "required": true,
            "schema": { "type": "string" }
          }
        ],
        "responses": {
          "200": { "description": "Success" },
          "401": { "description": "Unauthorized" }
        }
      }
    }
  }
}
```

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

### Create Message with JSON Payload

Source: https://rest-api.symphony.com/main/messages/create-message-v4

This example shows how to send a message and associated data using a JSON payload with `application/json` content type. The message and data are included as key-value pairs within the JSON object. Session and key manager tokens are required.

```bash
curl -X POST \
  https://acme.symphony.com:443/agent/v4/stream/xFfPil_o26qXzGwWvcw5RH___qQr0W7EdA/message/create \

-H "sessionToken: SESSION_TOKEN" \
-H "keyManagerToken: KEY_MANAGER_TOKEN" \
-H "Content-Type: application/json" \
-d '{
        "message": "<messageML>Hello world</messageML>",
        "data": "{\"foo\":\"bar\"}"
    }'
```

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

### GET /v1/admin/app/{id}/get

Source: https://rest-api.symphony.com/main/manage-apps/get-application

Retrieves the detailed configuration and metadata for a specific application identified by its ID.

```APIDOC
## GET /v1/admin/app/{id}/get

### Description
Retrieves a detailed record of an application, including its authentication keys, permissions, and configuration properties.

### Method
GET

### Endpoint
/v1/admin/app/{id}/get

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

#### Header Parameters
- **sessionToken** (string) - Required - Session authentication token.

### Request Example
N/A (GET request)

### Response
#### Success Response (200)
- **applicationInfo** (object) - Basic application metadata (appId, name, appUrl, domain, publisher).
- **iconUrl** (string) - URL to the application icon.
- **description** (string) - Description of the application.
- **allowOrigins** (string) - Permitted domains for CORS.
- **permissions** (array) - List of provisioned application permissions.
- **cert** (string) - Public certificate in PEM format.
- **authenticationKeys** (object) - RSA key information.

#### Response Example
{
  "applicationInfo": {
    "appId": "example-app-id",
    "name": "Example App",
    "appUrl": "https://example.com",
    "domain": "example.com",
    "publisher": "Company Name"
  },
  "iconUrl": "https://example.com/icon.png",
  "description": "A sample application.",
  "permissions": ["SEND_MESSAGES", "GET_BASIC_USER_INFO"]
}
```

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

### GET /v2/user/presence

Source: https://rest-api.symphony.com/main/presence/get-presence

Retrieves the current presence information for the authenticated user.

```APIDOC
## GET /v2/user/presence

### Description
Get presence information about the requesting user. This endpoint returns the user's current status category and the timestamp of when the status was set.

### Method
GET

### Endpoint
/v2/user/presence

### Parameters
#### Header Parameters
- **sessionToken** (string) - Required - Session authentication token.

### Request Example
GET /v2/user/presence
Headers: {
  "sessionToken": "your-session-token"
}

### Response
#### Success Response (200)
- **userId** (integer) - The ID of the user.
- **category** (string) - Presence status (e.g., AVAILABLE, BUSY, OFFLINE).
- **timestamp** (integer) - The time, in milliseconds since Jan 1 1970, when the presence state was set.

#### Response Example
{
  "userId": 123456789,
  "category": "AVAILABLE",
  "timestamp": 1672531200000
}
```

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

### Create Room (v3)

Source: https://rest-api.symphony.com/main/apps-on-behalf-of-obo/obo-enabled-endpoints

Creates a new room with specified properties using the v3 API.

```APIDOC
## POST /pod/v3/room/create

### Description
Creates a new room with specified properties.

### Method
POST

### Endpoint
/pod/v3/room/create

### Request Body
- **title** (string) - Required - The title of the room.
- **description** (string) - Optional - A description for the room.
- **isPrivate** (boolean) - Optional - Whether the room is private (defaults to false).

### Request Example
```json
{
  "title": "Team Discussion",
  "description": "A room for team discussions.",
  "isPrivate": true
}
```

### Response
#### Success Response (200)
- **roomId** (string) - The ID of the newly created room.
- **roomDetails** (object) - Details of the created room.

#### Response Example
```json
{
  "roomId": "room_abcde",
  "roomDetails": {
    "title": "Team Discussion",
    "description": "A room for team discussions.",
    "isPrivate": true,
    "createdDate": "2023-10-27T10:00:00Z"
  }
}
```
```

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

### GET /v3/dlp/policies

Source: https://rest-api.symphony.com/main/dlp-dictionary-and-policy-management/v3-policy-management-endpoints/v3-all-policies

Retrieves a list of all DLP policies configured in the agent. Supports pagination and filtering.

```APIDOC
## GET /v3/dlp/policies

### Description
Retrieves a list of all DLP policies. This endpoint allows for pagination using `page` and `limit` query parameters.

### Method
GET

### Endpoint
/v3/dlp/policies

### Parameters
#### Header Parameters
- **sessionToken** (string) - Required - Session authentication token.
- **keyManagerToken** (string) - Optional - Key Manager authentication token.

#### Query Parameters
- **page** (integer) - Optional - Specifies which page to return (default is 0).
- **limit** (integer) - Optional - Specifies the number of results to return per page (default is 50, maximum is 50).

### Request Example
```
GET /v3/dlp/policies?page=0&limit=50 HTTP/1.1
Host: youragentURL.symphony.com
Session-Token: YOUR_SESSION_TOKEN
```

### Response
#### Success Response (200)
- **policies** (array) - List of policies.
  - **id** (string) - Unique identifier for policy.
  - **policyId** (string) - Policy Id.
  - **version** (string) - The version of the policy.
  - **name** (string) - Unique name of policy.
  - **creatorId** (integer) - Numeric userId of the creator.
  - **scopes** (array) - List of communication scopes (e.g., "Internal", "External").
  - **appliesTo** (array) - Defines what the policy applies to, including data types and actions.
  - **active** (boolean) - Indicates whether the policy is active.
  - **deleted** (boolean) - Indicates whether the policy is deleted.
  - **creationDate** (integer) - Creation time of the policy in milliseconds.
  - **lastUpdatedDate** (integer) - Recent update time of the policy in milliseconds.
  - **lastDisabledDate** (integer) - Recent disable time of the policy in milliseconds.
  - **systemPolicy** (boolean) - Indicates if it's a system policy.
- **page** (integer) - The starting page for pagination.
- **size** (integer) - Size of policies displayed per page.
- **pageCount** (integer) - Total number of pages available.

#### Response Example (200 OK)
```json
{
  "policies": [
    {
      "id": "policy-123",
      "policyId": "policy-id-abc",
      "version": "3.0",
      "name": "Confidential Data Policy",
      "creatorId": 1001,
      "scopes": ["Internal"],
      "appliesTo": [
        {
          "dataType": "FileContent",
          "action": "Block",
          "rules": [
            {
              "id": "rule-456",
              "type": "TEXT_MATCH",
              "name": "Credit Card Number Pattern"
            }
          ]
        }
      ],
      "active": true,
      "deleted": false,
      "creationDate": 1678886400000,
      "lastUpdatedDate": 1678886400000,
      "lastDisabledDate": null,
      "systemPolicy": false
    }
  ],
  "page": 0,
  "size": 50,
  "pageCount": 1
}
```

#### Error Responses
- **400** (Bad Request): Client error, see response body for further details.
- **401** (Unauthorized): Session tokens invalid.
- **403** (Forbidden): Caller lacks necessary entitlement.
- **500** (Internal Server Error): Server error, see response body for further details.
```

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

### Get User Presence Information (OpenAPI)

Source: https://rest-api.symphony.com/main/presence/get-presence

This OpenAPI 3.1.1 specification defines the GET /v2/user/presence endpoint. It outlines the request method, parameters (sessionToken), response codes (200, 400, 401, 500), and the structure of the V2Presence schema. It also mentions OBO-enabled endpoint usage.

```json
{
  "openapi": "3.1.1",
  "info": {
    "title": "Pod API",
    "version": "20.17.1"
  },
  "servers": [
    {
      "url": "http://yourpodURL.symphony.com/pod"
    }
  ],
  "paths": {
    "/v2/user/presence": {
      "get": {
        "summary": "Get presence information about the requesting user.",
        "parameters": [
          {
            "schema": {
              "type": "string"
            },
            "name": "sessionToken",
            "description": "Session authentication token.",
            "in": "header",
            "required": true
          }
        ],
        "tags": [
          "Presence"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/V2Presence"
                }
              }
            }
          },
          "400": {
            "description": "Client error, see response body for further details.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized: Invalid session token.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Server error, see response body for further details.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "V2Presence": {
        "allOf": [
          {
            "$ref": "#/components/schemas/V2UserPresence"
          },
          {
            "type": "object",
            "properties": {
              "timestamp": {
                "type": "integer",
                "format": "int64",
                "description": "The time, in milliseconds since Jan 1 1970, when the presence state was set."
              }
            }
          }
        ]
      },
      "V2UserPresence": {
        "allOf": [
          {
            "$ref": "#/components/schemas/V2PresenceStatus"
          },
          {
            "type": "object",
            "properties": {
              "userId": {
                "type": "integer",
                "format": "int64",
                "description": "The ID of the user to whom the presence state relates."
              }
            }
          }
        ]
      },
      "V2PresenceStatus": {
        "type": "object",
        "properties": {
          "category": {
            "type": "string",
            "description": "Presence status. Possible values are:\n  - UNDEFINED\n  - AVAILABLE\n  - BUSY\n  - DO_NOT_DISTURB\n  - ON_THE_PHONE\n  - BE_RIGHT_BACK\n  - IN_A_MEETING\n  - AWAY\n  - OUT_OF_OFFICE\n  - OFF_WORK\n  - OFFLINE\n"
          }
        },
        "required": [
          "category"
        ]
      },
      "Error": {
        "type": "object",
        "properties": {
          "code": {
            "type": "integer",
            "format": "int32"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}

```

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

### Create Connection

Source: https://rest-api.symphony.com/main/apps-on-behalf-of-obo/obo-enabled-endpoints

Establishes a new connection request for a user.

```APIDOC
## POST /pod/v1/connection/create

### Description
Establishes a new connection request for a user.

### Method
POST

### Endpoint
/pod/v1/connection/create

### Request Body
- **userId** (string) - Required - The ID of the user to connect with.

### Request Example
```json
{
  "userId": "user_abcde"
}
```

### Response
#### Success Response (200)
- **connectionId** (string) - The ID of the created connection request.

#### Response Example
```json
{
  "connectionId": "conn_12345"
}
```
```

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

### GET /v1/admin/disclaimer/{did}

Source: https://rest-api.symphony.com/main/disclaimers/disclaimer

Retrieves a specific disclaimer entity by its ID. Requires a valid session token and specific administrative privileges.

```APIDOC
## GET /v1/admin/disclaimer/{did}

### Description
Retrieves the details of a specific disclaimer using its unique identifier. This endpoint requires the 'User Provisioning' role with 'ACCESS_USER_PROVISIONING_API' privilege.

### Method
GET

### Endpoint
/v1/admin/disclaimer/{did}

### Parameters
#### Path Parameters
- **did** (string) - Required - The ID of the disclaimer entity.

#### Header Parameters
- **sessionToken** (string) - Required - Session authentication token.

### Request Example
GET /v1/admin/disclaimer/12345
Header: sessionToken: <your_token>

### Response
#### Success Response (200)
- **id** (string) - The disclaimer ID
- **name** (string) - The name of the disclaimer
- **content** (string) - The disclaimer text content
- **frequencyInHours** (integer) - Display frequency in hours
- **isDefault** (boolean) - Whether this is the default disclaimer
- **isActive** (boolean) - Whether the disclaimer is currently active
- **createdDate** (integer) - Unix timestamp of creation
- **modifiedDate** (integer) - Unix timestamp of last modification
- **format** (string) - Format type (TEXT or XML)

#### Response Example
{
  "id": "12345",
  "name": "Standard Disclaimer",
  "content": "This is a sample disclaimer.",
  "frequencyInHours": 24,
  "isDefault": true,
  "isActive": true,
  "createdDate": 1672531200000,
  "modifiedDate": 1672531200000,
  "format": "TEXT"
}
```

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

### POST /v1/dlp/dictionaries

Source: https://rest-api.symphony.com/main/dlp-dictionary-and-policy-management/dictionary-management-endpoints/create-dictionary

Creates a new dictionary entry with basic metadata. This endpoint initializes the dictionary structure, which can subsequently be populated with content.

```APIDOC
## POST /v1/dlp/dictionaries

### Description
Creates a dictionary with basic metadata and no content. Only "name" and "type" fields are used to create a new dictionary entry.

### Method
POST

### Endpoint
/v1/dlp/dictionaries

### Parameters
#### Header Parameters
- **sessionToken** (string) - Required - Session authentication token.
- **keyManagerToken** (string) - Optional - Key Manager authentication token.

#### Request Body
- **name** (string) - Required - The name of the dictionary.
- **type** (string) - Required - The type of dictionary (Word or Regex). Defaults to "Word".

### Request Example
{
  "name": "my-custom-dictionary",
  "type": "Word"
}

### Response
#### Success Response (200)
- **data** (object) - Dictionary response containing dictionary metadata.

#### Response Example
{
  "data": {
    "dictRef": {
      "dictId": "12345",
      "name": "my-custom-dictionary",
      "version": "1.0"
    },
    "type": "Word",
    "creationDate": 1672531200000
  }
}
```

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

### GET /v1/user/manifest/own

Source: https://rest-api.symphony.com/main/user-management/user-manifest

Retrieves the manifest for the currently authenticated service account. The manifest contains information about the commands supported by the bot.

```APIDOC
## GET /v1/user/manifest/own

### Description
Get own service account manifest. This endpoint retrieves the manifest for the currently authenticated service account, which details the commands the bot supports.

### Method
GET

### Endpoint
/v1/user/manifest/own

### Parameters
#### Header Parameters
- **sessionToken** (string) - Required - Session authentication token.

### Response
#### Success Response (200)
- **manifest** (string) - The manifest containing commands supported by the service account. Must be valid JSON. Maximum length is 6144 characters.

#### Error Response
- **400**: Client error, see response body for further details.
- **401**: Unauthorized: Invalid session token.
- **403**: Forbidden: Caller lacks necessary entitlement.
- **500**: Server error, see response body for further details.

#### Response Example (Success)
```json
{
  "manifest": "{\"commands\": [\"help\", \"status\"]}"
}
```

#### Response Example (Error)
```json
{
  "code": 123,
  "message": "Error details"
}
```
```

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

### Generate PBKDF2 Password Hashes

Source: https://rest-api.symphony.com/main/user-management/create-user-v2

Demonstrates how to generate a secure PBKDF2 hash with a random salt. The Java implementation uses PBEKeySpec and PKCS5S2ParametersGenerator, while the Postman script utilizes CryptoJS to derive keys for environment variables.

```java
@Test
public void test() throws NoSuchAlgorithmException, InvalidKeySpecException {
  String password = "ARandomPassword";
  SecureRandom sr = new SecureRandom();
  byte[] salt = new byte[16];
  sr.nextBytes(salt);
  assertTrue(Arrays.equals(generateStrongPasswordHash(password, salt), getSaltedPassword(password, salt)));
}

private static byte[] generateStrongPasswordHash(String password, byte[] salt)
throws NoSuchAlgorithmException, InvalidKeySpecException {
  int iterations = 10000;
  char[] pb = password.toCharArray();
  PBEKeySpec spec = new PBEKeySpec(pb, salt, iterations, 256);
  SecretKeyFactory skf = SecretKeyFactory.getInstance("PBKDF2WithHmacSHA256");
  byte[] hash = skf.generateSecret(spec).getEncoded();
  return hash;
}

public static byte[] getSaltedPassword(String password, byte[] salt) {
  PKCS5S2ParametersGenerator gen = new PKCS5S2ParametersGenerator(new SHA256Digest());
  byte[] bytes = password.getBytes(StandardCharsets.UTF_8);
  gen.init(bytes, salt, 10000);
  byte[] newPasswordGen = ((KeyParameter) gen.generateDerivedParameters(256)).getKey();
  return newPasswordGen;
}
```

```javascript
// Example with Postman, as a Pre-Request script.

const password = 'SymphonyRocks123456789!'; // Replace with your password

// Generate a random salt of specified length
function generateSalt(length) {
    return CryptoJS.lib.WordArray.random(128 / 8);
}

// PBKDF2 function using CryptoJS
function derivePBKDF2(password, salt, iterations, keyLength) {
    return CryptoJS.PBKDF2(password, salt, {
        keySize: keyLength / 32, // Key size in words (32-bit units)
        iterations: iterations,
        hasher: CryptoJS.algo.SHA256
    });
}

// Parameters
const iterations = 10000;           // Number of iterations
const keyLength = 256;              // Key length in bits (256 = 32 bytes)
const saltLength = 16;              // Salt length in characters

// Generate random salts
const hSalt = generateSalt(saltLength);
const khSalt = generateSalt(saltLength);

// Derive PBKDF2 hashes
const hPassword = derivePBKDF2(password, hSalt, iterations, keyLength);
const khPassword = derivePBKDF2(password, khSalt, iterations, keyLength);

// Convert salts and hashes to B64 strings
const hSaltB64 = CryptoJS.enc.Base64.stringify(hSalt);
const khSaltB64 = CryptoJS.enc.Base64.stringify(khSalt);
const hPasswordB64 = CryptoJS.enc.Base64.stringify(hPassword);
const khPasswordB64 = CryptoJS.enc.Base64.stringify(khPassword);

// Set Postman environment variables for use in the request
pm.environment.set('hSalt', hSaltB64);
pm.environment.set('hPassword', hPasswordB64);
pm.environment.set('khSalt', khSaltB64);
pm.environment.set('khPassword', khPasswordB64);
```

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

### GET /api/v1/resources (Query Parameters)

Source: https://rest-api.symphony.com/main/compliance-barrier-groups/compliance-group-memberships/list-compliance-group-memberships

Standard query parameter implementation for filtering, limiting, and sorting resource collections.

```APIDOC
## GET /api/v1/resources

### Description
Retrieves a list of resources with support for pagination via limit and field-based sorting.

### Method
GET

### Endpoint
/api/v1/resources

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of results to return. Note: The API may return fewer results than the limit due to privacy filtering.
- **sort** (string) - Optional - Field to sort by. Prefix with '-' for descending order (e.g., '-lastAddedDate'). Available fields: 'lastAddedDate', 'lastRemovedDate'.

### Request Example
GET /api/v1/resources?limit=10&sort=-lastAddedDate

### Response
#### Success Response (200)
- **data** (array) - List of requested resources.
- **next** (string) - Cursor or link to the next page of results. Use this to determine if more data is available.

#### Response Example
{
  "data": [...],
  "next": "/api/v1/resources?cursor=abc123"
}
```

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

### Send Message with Structured Objects (Python)

Source: https://rest-api.symphony.com/main/messages/create-message-v4

Shows how to send a message with structured objects using Python and Apache FreeMarker templates for dynamic content generation.

```python
from symphony.bdk.core.service.message import MessageTemplate

# Assuming bdk is an authenticated instance of SymphonyBdk
stream_id = "your_stream_id"
template_id = "myTemplate"  # Name of the FreeMarker template

template_data = {
    "userName": "Jane Smith",
    "product": "Widget"
}

message_template = MessageTemplate(template_id, template_data)
bdk.messages().send_message(stream_id, message_template=message_template)

```
Tokens:
Raw