Request payload for assuming user role.

This API allows a user to assume a role and get temporary security credentials for MQTT and other AWS services.

  • userRole is optional. If not provided or empty, it defaults to "mqtt". Can be either a string (for future flexibility) or ESPUserRole enum value. Only the values "mqtt" and "videostream" are supported. Any other value will result in an error.
  • videostream role requires nodeIds to generate credentials.
  • mqtt role works with groupIds and nodeIds.
  • groupIds and nodeIds are both optional arrays (max 5 each). Only one of them can be non-empty in a request. Cannot be provided together.
  • If both groupIds and nodeIds are empty or omitted, credentials will be granted for all groups the user has access to.
interface AssumeRoleRequest {
    groupIds?: string[];
    nodeIds?: string[];
    userRole?: string;
}

Properties

groupIds?: string[]
nodeIds?: string[]
userRole?: string