Skip to content

Main Navigation Learn Resources Official Apps API Reference Release Notes

Appearance

Sidebar Navigation

API Reference

HTTP Overview

WebSocket

Actors

POST Send message(s) to actor

Apps

GET Get all apps

PUT Install app version

GET Get app details

POST Activate or deactivate an app

GET Get all files provided by app

GET Get a file from an app

GET Get app settings

PATCH Update app settings

GET Connect to app development WebSocket

Audit

GET Query audit logs

GET Get audit log entry

Clients

GET List OAuth clients

GET Get OAuth client

PUT Create or update an OAuth client

DELETE Delete OAuth client

PATCH Update client properties

PUT Update client ACL

PUT Update client roles

DELETE Remove client role

GET Get client sessions

DELETE Revoke client session

GET List secrets

POST Create a new secret

DELETE Revoke a secret

Components

GET Get all components

GET Get a component

POST Create or update a component

DELETE Delete a component

Events

GET GET /events

Files

GET Download a file

PUT Create or update a file

DELETE Delete a file

Graph

GET Get graph metadata

POST Query the graph

GET Get node type metadata

Ingress

GET Get all ingresses

GET Get an ingress

PUT Create or update an ingress

DELETE Delete an ingress

JobDefinitions

GET Get a job definition

PUT Create a new job

DELETE Delete a job definition

GET Get all job definitions

Jobs

POST Schedule a new job

GET Get job status

DELETE Delete a job

GET Get job statistics

POST Schedule jobs in batch

Me

GET Get user profile

POST Update user profile

POST Change user password

POST Request email change

POST Validate email verification

GET Get user settings

POST Update user settings

GET List personal access tokens

POST Create personal access token

DELETE Revoke personal access token

Principals

GET List principals

GET Get a principal

PUT Create or update a principal

DELETE Delete a principal

PATCH Update principal properties

POST Reset principal password

POST Suspend a principal

POST Reactivate principal

DELETE Remove principal role

GET Get principal sessions

DELETE Revoke principal session

PUT Update principal ACL

PUT Update principal roles

Registry

GET Get all registry values

POST Set multiple values at once

GET Get registry value

POST Set registry value

DELETE Delete registry value

Roles

GET List roles

GET Get role

PUT Create or update a role

DELETE Delete a role

PATCH Update role

PUT Update role ACL

Rules

GET Get all rules

GET Get rule

PUT Create or update a rule

DELETE Delete a rule

Sendings

POST Queue an email for delivery

GET Get sending status and details

DELETE Cancel a pending sending

Get role

GET

/resources/iam/roles/{roleKey}

Parameters

Path Parameters

roleKey*

Type

string

Required

Responses

OK

GET

/resources/iam/roles/{roleKey}

Samples

Pager

Previous page GET List roles

Next page PUT Create or update a role

© 2024 Hantera AB. All rights reserved.

Org. no.: 559242-9582 | VAT no.: SE559242958201