Skip to main content
A newer release of this product is available.

Retrieve the EMS role-based configuration for an access control role

Contributors
PDFs

GET /support/ems/role-configs/{access_control_role.name}

Introduced In: 9.13

Retrieves the EMS role-based configuration of the access control role.

  • event role-config show

Parameters

Name Type In Required Description

access_control_role.name

string

path

True

Access control role name

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

access_control_role

access_control_role

Access control role that the event filter is assigned to.

event_filter

event_filter

Event filter that is assigned to the access control role.

limit_access_to_global_configs

boolean

Indicates whether the access control has limited access to global EMS configurations.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "access_control_role": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "admin"
  },
  "event_filter": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "important-events"
  }
}

Error

Status: Default, Error
Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href

access_control_role

Access control role that the event filter is assigned to.

Name Type Description

_links

_links

name

string

Role name

event_filter

Event filter that is assigned to the access control role.

Name Type Description

_links

_links

name

string

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.