Application endpoints in the REST API






The following section provides a list of supported endpoints for applications (integrated products) and their associated resources and permissions and details about running these endpoints. 

Before you run an endpoint, you must authenticate yourself. For more information, see Access-and-authentication-for-the-REST-API.


Applications

You can perform the following operations related to applications: 

GET /ims/api/v1/applications
Get all applications under a tenant
Request URL
 https://<BMC Helix Portal URL>/ims/api/v1/applications
Request URL with optional parameters
 https://<BMC Helix Portal URL>/ims/api/v1/applications?size={records}&orderBy=created_date_time
Request header
Content-Type: application/json
Authorization: Bearer <JWT_token>
Parameters


Successful response
{
 "records": [
   {
     "application_id": "core",
     "name": "core",
     "application_display_name": "Core",
     "description": "core Service",
     "version": "20.08",
     "service_type": "GLOBAL"
   },
   {
     "application_id": "ims",
     "name": "ims",
     "application_display_name": "IAM Service",
     "description": "Identity Management Service",
     "version": "20.08",
     "config": {
       "ui_configurations": {
         "components": [
           {
             "icon_source_uri": "d-icon-user_star",
             "image_source_uri": "",
             "name": "Roles and Permissions",
             "link_route_path": "/admin/#/rolesPermissions",
             "description": "Roles and permissions",
             "product_services": false
           },
           {
             "icon_source_uri": "d-icon-user_circle",
             "image_source_uri": "",
             "name": "Users",
             "link_route_path": "/admin/#/users",
             "description": "Users",
             "product_services": false
           },
           {
             "icon_source_uri": "d-icon-users_circle",
             "image_source_uri": "",
             "name": "User Groups",
             "link_route_path": "/admin/#/groups",
             "description": "User Groups",
             "product_services": false
           }
          ]
       }
     },
     "service_type": "GLOBAL"
   },
   {
     "application_id": "reporting",
     "name": "dashboards",
     "description": "Reporting",
     "version": "20.08.00",
     "config": {
       "rsso_configurations": {
         "redirect_url_clients": [
           {
             "redirection_url_postfix": "/dashboards/auth/code/callback",
             "client_name": "ade-reporting"
           }
          ]
       },
       "ui_configurations": {
         "components": [
           {
             "icon_source_uri": "d-icon-chart_donut",
             "image_source_uri": "/dashboards/public/img/icon-helix-dashboards.svg",
             "name": "BMC Helix Dashboards",
             "description": "BMC Helix Dashboards, enable data-driven business decisions with enterprise-wide queries and visualizations.",
             "link_route_path": "/dashboards",
             "product_services": true
           }
          ]
       },
       "external_auth_mappings": {
         "itsm_mappings": {
           "mappings": [
             {
               "ade_mappings": [
                 {
                   "associations": [
                     {
                       "values": [
                         "Reporting Viewer"
                        ],
                       "ade_object_type": "roles"
                     }
                    ]
                 }
                ],
               "external_object_type": "groups",
               "external_object_name": "Licensed User"
             }
            ]
         }
       }
     },
     "service_type": "GLOBAL"
   },
   {
     "application_id": "ashdummyapril9",
     "name": "ashdummyapril9",
     "description": "Helix tmstest",
     "version": "20.08",
     "config": {},
     "service_type": "GLOBAL"
   },
   {
     "application_id": "testtestsvc1002tnt",
     "name": "tmstest1",
     "description": "Helix tmstest",
     "version": "21.02",
     "config": {
       "rsso_configurations": {
         "redirect_url_clients": [
           {
             "redirection_url_postfix": "/rsso/redirect",
             "client_name": "ade-oidc-client-1794682676"
           }
          ]
       },
       "ui_configurations": {
         "components": [
           {
             "icon_source_uri": "/services/tenants.png",
             "image_source_uri": "/itsm/icon-helix-ITSM.svg",
             "name": "Testservice",
             "description": "test Service Management",
             "link_route_path": "/tmp",
             "product_services": true
           }
          ]
       }
     },
     "service_type": "TENANT"
   },
   {
     "application_id": "monitor",
     "name": "monitor",
     "description": "BMC Helix Operations Management",
     "version": "20.08.00",
     "config": {
       "ui_configurations": {
         "components": [
           {
             "icon_source_uri": "/monitor/img/monitor.svg",
             "image_source_uri": "/monitor/img/monitor.svg",
             "name": "BMC Helix Operations Management",
             "description": "BMC Helix Operations Management",
             "link_route_path": "/monitor/#/",
             "product_services": true
           }
          ]
       }
     },
     "service_type": "TENANT"
   },
   {
     "application_id": "IS_CustomApp_DND",
     "name": "tmstest",
     "description": "Helix tmstest",
     "version": "20.08",
     "config": {
       "ui_configurations": {
         "components": [
           {
             "icon_source_uri": "/services/tenants.png",
             "image_source_uri": "",
             "name": "Tenants",
             "description": "Tenant management system",
             "link_route_path": "/tmp",
             "product_services": false
           }
          ]
       }
     },
     "service_type": "TENANT"
   },
   {
     "application_id": "tmstestsvc1002",
     "name": "tmstest",
     "description": "Helix tmstest",
     "version": "20.08",
     "config": {
       "ui_configurations": {
         "components": [
           {
             "icon_source_uri": "/services/tenants.png",
             "image_source_uri": "",
             "name": "Tenants",
             "description": "Tenant management system",
             "link_route_path": "/tmp",
             "product_services": false
           }
          ]
       }
     },
     "service_type": "TENANT"
   }
  ],
 "_metadata": {
   "page": 0,
   "records_per_page": 1000,
   "page_count": 1,
   "total_count": 8
 }
}

GET /ims/api/v1/applications/{id}
Get details of a specific application
Request URL
 https://<BMC Helix Portal URL>/ims/api/v1/applications/{id}
Request header
Content-Type: application/json
Authorization: Bearer <JWT_token>
Parameters


Successful response
{
 "application_id": "ims",
 "name": "ims",
 "application_display_name": "IAM Service",
 "description": "Identity Management Service",
 "version": "20.08",
 "resourceType": [
   {
     "id": "ims.users",
     "resourceType": "users",
     "resource_type_display_name": "Users"
   },
   {
     "id": "ims.permissions",
     "resourceType": "permissions",
     "resource_type_display_name": "Permissions"
   },
   {
     "id": "ims.roles",
     "resourceType": "roles",
     "resource_type_display_name": "Roles"
   },
   {
     "id": "ims.groups",
     "resourceType": "groups",
     "resource_type_display_name": "Groups"
   },
   {
     "id": "ims.agent",
     "resourceType": "agent",
     "resource_type_display_name": "Agent"
   },
   {
     "id": "ims.custom_ui_applications",
     "resourceType": "custom_ui_applications",
     "resource_type_display_name": "Custom UI App"
   },
   {
     "id": "ims.access_keys",
     "resourceType": "access_keys",
     "resource_type_display_name": "Access Keys"
   }
  ],
 "config": {
   "ui_configurations": {
     "components": [
       {
         "icon_source_uri": "d-icon-user_star",
         "image_source_uri": "",
         "name": "Roles and Permissions",
         "link_route_path": "/admin/#/rolesPermissions",
         "description": "Roles and permissions",
         "product_services": false
       },
       {
         "icon_source_uri": "d-icon-user_circle",
         "image_source_uri": "",
         "name": "Users",
         "link_route_path": "/admin/#/users",
         "description": "Users",
         "product_services": false
       },
       {
         "icon_source_uri": "d-icon-users_circle",
         "image_source_uri": "",
         "name": "User Groups",
         "link_route_path": "/admin/#/groups",
         "description": "User Groups",
         "product_services": false
       }
      ]
   }
 },
 "service_type": "GLOBAL"
}
Unsuccessful response
{
 "timestamp": "2020-10-07T15:25:54.447988Z",
 "code": 1500,
 "message": "Application not found.",
 "error": "Application with id:ims1 not found."
}


Resources

You can perform the following operations related to resources associated with applications: 

GET /ims/api/v1/applications/{application_id}/resource_types
Get all resources under an application
Request URL
 https://<BMC Helix Portal URL>/ims/api/v1/applications/{application_id}/resource_types
Request URL with optional parameters
 https://<BMC Helix Portal URL>/ims/api/v1/applications/{application_id}/resource_types?size={records}&orderBy=created_date_time
Request header
Content-Type: application/json
Authorization: Bearer <JWT_token>
Parameters


Successful response
{
 "records": [
   {
     "id": "ims.access_keys",
     "resource_type": "access_keys",
     "resource_type_display_name": "Access Keys",
     "description": "access_keys resource",
     "application_id": "ims",
     "system_object": true
   },
   {
     "id": "ims.users",
     "resource_type": "users",
     "resource_type_display_name": "Users",
     "description": "users resource",
     "application_id": "ims",
     "system_object": true
   },
   {
     "id": "ims.permissions",
     "resource_type": "permissions",
     "resource_type_display_name": "Permissions",
     "description": "permissions resource",
     "application_id": "ims",
     "system_object": true
   },
   {
     "id": "ims.roles",
     "resource_type": "roles",
     "resource_type_display_name": "Roles",
     "description": "roles resource",
     "application_id": "ims",
     "system_object": true
   },
   {
     "id": "ims.groups",
     "resource_type": "groups",
     "resource_type_display_name": "Groups",
     "description": "groups resource",
     "application_id": "ims",
     "system_object": true
   },
   {
     "id": "ims.agent",
     "resource_type": "agent",
     "resource_type_display_name": "Agent",
     "description": "agent resource",
     "application_id": "ims",
     "system_object": true
   },
   {
     "id": "ims.custom_ui_applications",
     "resource_type": "custom_ui_applications",
     "resource_type_display_name": "Custom UI App",
     "description": "custom application resource",
     "application_id": "ims",
     "system_object": true
   }
  ],
 "_metadata": {
   "page": 0,
   "records_per_page": 1000,
   "page_count": 1,
   "total_count": 7
 }
}
GET /ims/api/v1/applications/{application_id}/resource_types/{resource_type_id}
Get details of a specific resource
Request URL
 https://<BMC Helix Portal URL>/ims/api/v1/applications/{application_id}/resource_types/{resource_type_id}
Request header
Content-Type: application/json
Authorization: Bearer <JWT_token>
Parameters


Successful response
{
 "id": "ims.users",
 "resource_type": "users",
 "resource_type_display_name": "Users",
 "description": "users resource",
 "application_id": "ims",
 "permissions": [
   "ims.users.access_keys_create",
   "ims.users.access_keys_modify",
   "ims.users.access_keys_delete",
   "ims.users.create",
   "ims.users.access_keys_list",
   "ims.users.access_keys_read",
   "ims.users.list",
   "ims.users.read",
   "ims.users.modify",
   "ims.users.delete"
  ],
 "system_object": true
}


Permissions

You can perform the following operations related to permissions associated with the application resources: 

GET /ims/api/v1/applications/{application_id}/resource_types/{resource_type_id}/permissions
Get all permissions of a specific application and resource
Request URL
 https://<BMC Helix Portal URL>/ims/api/v1/applications/{application_id}/resource_types/{resource_type_id}/permissions
Request URL with optional parameters
 https://<BMC Helix Portal URL>/ims/api/v1/applications/{application_id}/resource_types/{resource_type_id}/permissions?size={records}&orderBy={created_date_time}
Request header
Content-Type: application/json
Authorization: Bearer <JWT_token>
Parameters


Successful response
{
 "records": [
   {
     "permission_id": "ims.users.list",
     "name": "list",
     "permission_display_name": "List",
     "description": "View all the users.",
     "resource_type_id": "ims.users"
   },
   {
     "permission_id": "ims.users.read",
     "name": "read",
     "permission_display_name": "Read",
     "description": "Get details of a user.",
     "resource_type_id": "ims.users"
   },
   {
     "permission_id": "ims.users.modify",
     "name": "modify",
     "permission_display_name": "Modify",
     "description": "Update a user.",
     "resource_type_id": "ims.users"
   },
   {
     "permission_id": "ims.users.delete",
     "name": "delete",
     "permission_display_name": "Delete",
     "description": "Delete a user.",
     "resource_type_id": "ims.users"
   },
   {
     "permission_id": "ims.users.create",
     "name": "create",
     "permission_display_name": "Create",
     "description": "Create a user.",
     "resource_type_id": "ims.users"
   },
   {
     "permission_id": "ims.users.access_keys_list",
     "name": "access_keys_list",
     "permission_display_name": "Access Keys List",
     "description": "View all the user-level API keys.",
     "resource_type_id": "ims.users"
   },
   {
     "permission_id": "ims.users.access_keys_read",
     "name": "access_keys_read",
     "permission_display_name": "Access Keys Read",
     "description": "Get details of a user-level API key.",
     "resource_type_id": "ims.users"
   },
   {
     "permission_id": "ims.users.access_keys_create",
     "name": "access_keys_create",
     "permission_display_name": "Access Keys Create",
     "description": "Create a user-level API key.",
     "resource_type_id": "ims.users"
   },
   {
     "permission_id": "ims.users.access_keys_modify",
     "name": "access_keys_modify",
     "permission_display_name": "Access Keys Modify",
     "description": "Update a user-level API key.",
     "resource_type_id": "ims.users"
   },
   {
     "permission_id": "ims.users.access_keys_delete",
     "name": "access_keys_delete",
     "permission_display_name": "Access Keys Delete",
     "description": "Delete a user-level API key.",
     "resource_type_id": "ims.users"
   }
  ],
 "_metadata": {
   "page": 0,
   "records_per_page": 1000,
   "page_count": 1,
   "total_count": 10
 }
}
Unsuccessful response

Scenario 1: You pass a resource ID that does not belong to the given application ID.

{
 "records": [],
 "_metadata": {
   "page": 0,
   "records_per_page": 1000,
   "page_count": 0,
   "total_count": 0
 }
}

Scenario 2: You specify a resource ID that does not exist.

{
 "timestamp": "2020-10-07T16:02:26.325109Z",
 "code": 1600,
 "message": "Resource not found.",
 "error": "Resource with Id: ims.groups1 not found."
}
GET /ims/api/v1/applications/{application_id}/resource_types/{resource_type_id}/permissions/{permission_id}
Get details of a specific permission
Request URL
 https://<BMC Helix Portal URL>/ims/api/v1/applications/{application_id}/resource_types/{resource_type_id}/permissions/{permission_id}
Request header
Content-Type: application/json
Authorization: Bearer <JWT_token>
Parameters


Successful response
{
 "permission_id": "ims.users.list",
 "name": "list",
 "permission_display_name": "List",
 "description": "View all the users.",
 "resource_type_id": "ims.users"
}
GET /ims/api/v1/permissions
Get all permissions under a tenant
Request URL
 https://<BMC Helix Portal URL>/ims/api/v1/permissions
Request URL with optional parameters
 https://<BMC Helix Portal URL>/ims/api/v1/permissions?size=1000&orderBy=created_date_time
Request header
Content-Type: application/json
Authorization: Bearer <JWT_token>
Parameters


Successful response
{
 "records": [
   {
     "permission_id": "ims.access_keys.list",
     "name": "list",
     "permission_display_name": "List",
     "description": "View all the tenant-level API keys.",
     "resource_type_id": "ims.access_keys"
   },
   {
     "permission_id": "ims.access_keys.read",
     "name": "read",
     "permission_display_name": "Read",
     "description": "Get details of a tenant-level API key.",
     "resource_type_id": "ims.access_keys"
   },
   {
     "permission_id": "ims.access_keys.create",
     "name": "create",
     "permission_display_name": "Create",
     "description": "Create a tenant-level API key.",
     "resource_type_id": "ims.access_keys"
   },
   {
     "permission_id": "ims.access_keys.modify",
     "name": "modify",
     "permission_display_name": "Modify",
     "description": "Update a tenant-level API key.",
     "resource_type_id": "ims.access_keys"
   },
   {
     "permission_id": "ims.access_keys.delete",
     "name": "delete",
     "permission_display_name": "Delete",
     "description": "Delete a tenant-level API key.",
     "resource_type_id": "ims.access_keys"
   },
   {
     "permission_id": "ims.users.list",
     "name": "list",
     "permission_display_name": "List",
     "description": "View all the users.",
     "resource_type_id": "ims.users"
   },
   {
     "permission_id": "ims.users.read",
     "name": "read",
     "permission_display_name": "Read",
     "description": "Get details of a user.",
     "resource_type_id": "ims.users"
   },
   {
     "permission_id": "ims.users.modify",
     "name": "modify",
     "permission_display_name": "Modify",
     "description": "Update a user.",
     "resource_type_id": "ims.users"
   },
   {
     "permission_id": "ims.users.delete",
     "name": "delete",
     "permission_display_name": "Delete",
     "description": "Delete a user.",
     "resource_type_id": "ims.users"
   },
   {
     "permission_id": "ims.users.create",
     "name": "create",
     "permission_display_name": "Create",
     "description": "Create a user.",
     "resource_type_id": "ims.users"
   },
   {
     "permission_id": "ims.users.access_keys_list",
     "name": "access_keys_list",
     "permission_display_name": "Access Keys List",
     "description": "View all the user-level API keys.",
     "resource_type_id": "ims.users"
   },
   {
     "permission_id": "ims.users.access_keys_read",
     "name": "access_keys_read",
     "permission_display_name": "Access Keys Read",
     "description": "Get details of a user-level API key.",
     "resource_type_id": "ims.users"
   },
   {
     "permission_id": "ims.users.access_keys_create",
     "name": "access_keys_create",
     "permission_display_name": "Access Keys Create",
     "description": "Create a user-level API key.",
     "resource_type_id": "ims.users"
   },
   {
     "permission_id": "ims.users.access_keys_modify",
     "name": "access_keys_modify",
     "permission_display_name": "Access Keys Modify",
     "description": "Update a user-level API key.",
     "resource_type_id": "ims.users"
   },
   {
     "permission_id": "ims.users.access_keys_delete",
     "name": "access_keys_delete",
     "permission_display_name": "Access Keys Delete",
     "description": "Delete a user-level API key.",
     "resource_type_id": "ims.users"
   },
   {
     "permission_id": "ims.permissions.list",
     "name": "list",
     "permission_display_name": "List",
     "description": "View all the permissions.",
     "resource_type_id": "ims.permissions"
   },
   {
     "permission_id": "ims.permissions.read",
     "name": "read",
     "permission_display_name": "Read",
     "description": "Get details of a permission.",
     "resource_type_id": "ims.permissions"
   },
   {
     "permission_id": "ims.permissions.modify",
     "name": "modify",
     "permission_display_name": "Modify",
     "description": "Update a permission.",
     "resource_type_id": "ims.permissions"
   },
   {
     "permission_id": "ims.permissions.delete",
     "name": "delete",
     "permission_display_name": "Delete",
     "description": "Delete a permission.",
     "resource_type_id": "ims.permissions"
   },
   {
     "permission_id": "ims.permissions.create",
     "name": "create",
     "permission_display_name": "Create",
     "description": "create a permission.",
     "resource_type_id": "ims.permissions"
   },
   {
     "permission_id": "ims.roles.list",
     "name": "list",
     "permission_display_name": "List",
     "description": "View all the roles.",
     "resource_type_id": "ims.roles"
   },
   {
     "permission_id": "ims.roles.read",
     "name": "read",
     "permission_display_name": "Read",
     "description": "Get details of a role.",
     "resource_type_id": "ims.roles"
   },
   {
     "permission_id": "ims.roles.modify",
     "name": "modify",
     "permission_display_name": "Modify",
     "description": "Update a role.",
     "resource_type_id": "ims.roles"
   },
   {
     "permission_id": "ims.roles.delete",
     "name": "delete",
     "permission_display_name": "Delete",
     "description": "Delete a role.",
     "resource_type_id": "ims.roles"
   },
   {
     "permission_id": "ims.roles.create",
     "name": "create",
     "permission_display_name": "Create",
     "description": "Create a role.",
     "resource_type_id": "ims.roles"
   },
   {
     "permission_id": "ims.groups.list",
     "name": "list",
     "permission_display_name": "List",
     "description": "View all the groups.",
     "resource_type_id": "ims.groups"
   },
   {
     "permission_id": "ims.groups.read",
     "name": "read",
     "permission_display_name": "Read",
     "description": "Get details of a group.",
     "resource_type_id": "ims.groups"
   },
   {
     "permission_id": "ims.groups.modify",
     "name": "modify",
     "permission_display_name": "Modify",
     "description": "Update a group.",
     "resource_type_id": "ims.groups"
   },
   {
     "permission_id": "ims.groups.delete",
     "name": "delete",
     "permission_display_name": "Delete",
     "description": "Delete a group.",
     "resource_type_id": "ims.groups"
   },
   {
     "permission_id": "ims.groups.create",
     "name": "create",
     "permission_display_name": "Create",
     "description": "Create a group.",
     "resource_type_id": "ims.groups"
   },
   {
     "permission_id": "reporting.dashboards_permissions.admin",
     "name": "admin",
     "description": "reporting.dashboards_permissions.admin",
     "resource_type_id": "reporting.dashboards_permissions"
   },
   {
     "permission_id": "reporting.dashboards_permissions.editor",
     "name": "editor",
     "description": "reporting.dashboards_permissions.editor",
     "resource_type_id": "reporting.dashboards_permissions"
   },
   {
     "permission_id": "reporting.dashboards_permissions.viewer",
     "name": "viewer",
     "description": "reporting.dashboards_permissions.viewer",
     "resource_type_id": "reporting.dashboards_permissions"
   },
   {
     "permission_id": "core.devices.view",
     "name": "view",
     "description": "core.devices.view",
     "resource_type_id": "core.devices"
   },
   {
     "permission_id": "core.devices.manage",
     "name": "manage",
     "description": "core.devices.manage",
     "resource_type_id": "core.devices"
   },
   {
     "permission_id": "core.metrics.ingest",
     "name": "ingest",
     "description": "core.metrics.ingest",
     "resource_type_id": "core.metrics"
   },
   {
     "permission_id": "core.events.view",
     "name": "view",
     "description": "core.events.view",
     "resource_type_id": "core.events"
   },
   {
     "permission_id": "core.events.operations",
     "name": "operations",
     "description": "core.events.operations",
     "resource_type_id": "core.events"
   },
   {
     "permission_id": "core.events.assignee_operations",
     "name": "assignee_operations",
     "description": "core.events.assignee_operations",
     "resource_type_id": "core.events"
   },
   {
     "permission_id": "core.events.ingest",
     "name": "ingest",
     "description": "core.events.ingest",
     "resource_type_id": "core.events"
   },
   {
     "permission_id": "core.event_classes.view",
     "name": "view",
     "description": "core.event_classes.view",
     "resource_type_id": "core.event_classes"
   },
   {
     "permission_id": "core.event_classes.manage",
     "name": "manage",
     "description": "core.event_classes.manage",
     "resource_type_id": "core.event_classes"
   },
   {
     "permission_id": "core.algorithm_template.view",
     "name": "view",
     "description": "core.algorithm_template.view",
     "resource_type_id": "core.algorithm_template"
   },
   {
     "permission_id": "core.algorithm_template.manage",
     "name": "manage",
     "description": "core.algorithm_template.manage",
     "resource_type_id": "core.algorithm_template"
   },
   {
     "permission_id": "core.algorithm.view",
     "name": "view",
     "description": "core.algorithm.view",
     "resource_type_id": "core.algorithm"
   },
   {
     "permission_id": "core.algorithm.manage",
     "name": "manage",
     "description": "core,algorithm.manage",
     "resource_type_id": "core.algorithm"
   },
   {
     "permission_id": "core.algorithm_execution.view",
     "name": "view",
     "description": "core.algorithm_execution.view",
     "resource_type_id": "core.algorithm_execution"
   },
   {
     "permission_id": "core.algorithm_execution.manage",
     "name": "manage",
     "description": "core.algorithm_execution.manage",
     "resource_type_id": "core.algorithm_execution"
   },
   {
     "permission_id": "core.algorithm_execution_summary.view",
     "name": "view",
     "description": "core.algorithm_execution_summary.view",
     "resource_type_id": "core.algorithm_execution_summary"
   },
   {
     "permission_id": "core.algorithm_files.view",
     "name": "view",
     "description": "core.algorithm_files.view",
     "resource_type_id": "core.algorithm_files"
   },
   {
     "permission_id": "core.algorithm_files.manage",
     "name": "manage",
     "description": "core.algorithm_files.manage",
     "resource_type_id": "core.algorithm_files"
   },
   {
     "permission_id": "ashdummyapril9.tenants.view",
     "name": "view",
     "description": "tmstest.tenants.view",
     "resource_type_id": "ashdummyapril9.tenants"
   },
   {
     "permission_id": "ashdummyapril9.tenants.manage",
     "name": "manage",
     "description": "tmstest.tenants.manage",
     "resource_type_id": "ashdummyapril9.tenants"
   },
   {
     "permission_id": "ashdummyapril9.services.view",
     "name": "view",
     "description": "tmstest.services.view",
     "resource_type_id": "ashdummyapril9.services"
   },
   {
     "permission_id": "ashdummyapril9.services.manage",
     "name": "manage",
     "description": "tmstest.services.manage",
     "resource_type_id": "ashdummyapril9.services"
   },
   {
     "permission_id": "ashdummyapril9.tenantservices.view",
     "name": "view",
     "description": "tmstest.tenantservices.view",
     "resource_type_id": "ashdummyapril9.tenantservices"
   },
   {
     "permission_id": "ashdummyapril9.tenantservices.manage",
     "name": "manage",
     "description": "tmstest.tenantservices.manage",
     "resource_type_id": "ashdummyapril9.tenantservices"
   },
   {
     "permission_id": "ims.agent.manage",
     "name": "manage",
     "permission_display_name": "Manage",
     "description": "Manage Agent related operations.",
     "resource_type_id": "ims.agent"
   },
   {
     "permission_id": "testtestsvc1002tnt.tenants.view",
     "name": "view",
     "description": "tmstest.tenants.view",
     "resource_type_id": "testtestsvc1002tnt.tenants"
   },
   {
     "permission_id": "testtestsvc1002tnt.tenants.manage",
     "name": "manage",
     "description": "tmstest.tenants.manage",
     "resource_type_id": "testtestsvc1002tnt.tenants"
   },
   {
     "permission_id": "testtestsvc1002tnt.services.view",
     "name": "view",
     "description": "tmstest.services.view",
     "resource_type_id": "testtestsvc1002tnt.services"
   },
   {
     "permission_id": "testtestsvc1002tnt.services.manage",
     "name": "manage",
     "description": "tmstest.services.manage",
     "resource_type_id": "testtestsvc1002tnt.services"
   },
   {
     "permission_id": "testtestsvc1002tnt.tenantservices.view",
     "name": "view",
     "description": "tmstest.tenantservices.view",
     "resource_type_id": "testtestsvc1002tnt.tenantservices"
   },
   {
     "permission_id": "testtestsvc1002tnt.tenantservices.manage",
     "name": "manage",
     "description": "tmstest.tenantservices.manage",
     "resource_type_id": "testtestsvc1002tnt.tenantservices"
   },
   {
     "permission_id": "monitor.user_preferences.manage",
     "name": "manage",
     "description": "monitor.user_preferences.manage",
     "resource_type_id": "monitor.user_preferences"
   },
   {
     "permission_id": "monitor.alarm_policies.manage",
     "name": "manage",
     "description": "monitor.alarm_policies.manage",
     "resource_type_id": "monitor.alarm_policies"
   },
   {
     "permission_id": "monitor.infrastructure_policies.view",
     "name": "view",
     "description": "monitor.infrastructure_policies.view",
     "resource_type_id": "monitor.infrastructure_policies"
   },
   {
     "permission_id": "monitor.infrastructure_policies.manage",
     "name": "manage",
     "description": "monitor.infrastructure_policies.manage",
     "resource_type_id": "monitor.infrastructure_policies"
   },
   {
     "permission_id": "monitor.infrastructure_policies.manage_patrol_agent",
     "name": "manage_patrol_agent",
     "description": "monitor.infrastructure_policies.manage_patrol_agent",
     "resource_type_id": "monitor.infrastructure_policies"
   },
   {
     "permission_id": "monitor.infrastructure_policies.manage_repo",
     "name": "manage_repo",
     "description": "monitor.infrastructure_policies.manage_repo",
     "resource_type_id": "monitor.infrastructure_policies"
   },
   {
     "permission_id": "monitor.infrastructure_policies.manage_package",
     "name": "manage_package",
     "description": "monitor.infrastructure_policies.manage_package",
     "resource_type_id": "monitor.infrastructure_policies"
   },
   {
     "permission_id": "ims.custom_ui_applications.modify",
     "name": "modify",
     "permission_display_name": "Modify",
     "description": "Update a Custom UI  Application.",
     "resource_type_id": "ims.custom_ui_applications"
   },
   {
     "permission_id": "ims.custom_ui_applications.delete",
     "name": "delete",
     "permission_display_name": "Delete",
     "description": "Delete a Custom UI  Application.",
     "resource_type_id": "ims.custom_ui_applications"
   },
   {
     "permission_id": "ims.custom_ui_applications.create",
     "name": "create",
     "permission_display_name": "Create",
     "description": "Create a Custom UI Application.",
     "resource_type_id": "ims.custom_ui_applications"
   },
   {
     "permission_id": "IS_CustomApp_DND.tenants.view",
     "name": "view",
     "description": "tmstest.tenants.view",
     "resource_type_id": "IS_CustomApp_DND.tenants"
   },
   {
     "permission_id": "IS_CustomApp_DND.tenants.manage",
     "name": "manage",
     "description": "tmstest.tenants.manage",
     "resource_type_id": "IS_CustomApp_DND.tenants"
   },
   {
     "permission_id": "IS_CustomApp_DND.services.view",
     "name": "view",
     "description": "tmstest.services.view",
     "resource_type_id": "IS_CustomApp_DND.services"
   },
   {
     "permission_id": "IS_CustomApp_DND.services.manage",
     "name": "manage",
     "description": "tmstest.services.manage",
     "resource_type_id": "IS_CustomApp_DND.services"
   },
   {
     "permission_id": "IS_CustomApp_DND.tenantservices.view",
     "name": "view",
     "description": "tmstest.tenantservices.view",
     "resource_type_id": "IS_CustomApp_DND.tenantservices"
   },
   {
     "permission_id": "IS_CustomApp_DND.tenantservices.manage",
     "name": "manage",
     "description": "tmstest.tenantservices.manage",
     "resource_type_id": "IS_CustomApp_DND.tenantservices"
   },
   {
     "permission_id": "tmstestsvc1002.tenants.view",
     "name": "view",
     "description": "tmstest.tenants.view",
     "resource_type_id": "tmstestsvc1002.tenants"
   },
   {
     "permission_id": "tmstestsvc1002.tenants.manage",
     "name": "manage",
     "description": "tmstest.tenants.manage",
     "resource_type_id": "tmstestsvc1002.tenants"
   },
   {
     "permission_id": "tmstestsvc1002.services.view",
     "name": "view",
     "description": "tmstest.services.view",
     "resource_type_id": "tmstestsvc1002.services"
   },
   {
     "permission_id": "tmstestsvc1002.services.manage",
     "name": "manage",
     "description": "tmstest.services.manage",
     "resource_type_id": "tmstestsvc1002.services"
   },
   {
     "permission_id": "tmstestsvc1002.tenantservices.view",
     "name": "view",
     "description": "tmstest.tenantservices.view",
     "resource_type_id": "tmstestsvc1002.tenantservices"
   },
   {
     "permission_id": "tmstestsvc1002.tenantservices.manage",
     "name": "manage",
     "description": "tmstest.tenantservices.manage",
     "resource_type_id": "tmstestsvc1002.tenantservices"
   }
  ],
 "_metadata": {
   "page": 0,
   "records_per_page": 1000,
   "page_count": 1,
   "total_count": 86
 }
}
 
   
      
POST /ims/api/v1/permissions/search
Search for permissions
Request URL
https://<BMC Helix Portal URL>/ims/api/v1/permissions/search?page=0&size=1000&orderBy=created_date_time&sortOrder=asc
Request URL with optional parameters
https://<BMC Helix Portal URL>/ims/api/v1/permissions/search?page=0&size=1000&orderBy=created_date_time&sortOrder=asc
Request header
Content-Type: application/json
Authorization: Bearer <JWT_token>
Request body
{
 "filters": [
   {
     "field": "string",
     "values": [
       "string"
      ],
     "fieldType": "string"
   }
  ]
}
Example request body
{
 "filters": [
   {
     "field": "id",
     "values": [
       "ims.users.delete"
      ],
     "fieldType": "string"
   },
   {
     "field": "id",
     "values": [
       "ims.users.list"
      ],
     "fieldType": "string"
   }
  ]
}


Parameters


Successful response
{
 "records": [
   {
     "permission_id": "ims.users.delete",
     "name": "delete",
     "permission_display_name": "Delete",
     "description": "Delete a user.",
     "resource_type_id": "ims.users"
   }
  ],
 "_metadata": {
   "page": 0,
   "records_per_page": 1000,
   "page_count": 1,
   "total_count": 1
 }
}
Unsuccessful response

Scenario:

{
  "timestamp": "2021-10-04T10:55:17.214244Z",
  "code": 2300,
  "message": "BAD_REQUEST",
  "error": "Unsupported column for permission search. Search field allowed values are [*, id, display_name]"
}

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*