CREATEWORKSPACEAPIKEY()`¶

About CreateWorkspaceApiKey¶

Creates a Grafana API key for the workspace. This key can be used to authenticate requests sent to the workspace's HTTP API. See https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html for available APIs and example requests.

In workspaces compatible with Grafana version 9 or above, use workspace service accounts instead of API keys. API keys will be removed in a future release.

Method Signature¶

METHODS /AWS1/IF_GRF~CREATEWORKSPACEAPIKEY
  IMPORTING
    !IV_KEYNAME TYPE /AWS1/GRFAPIKEYNAME OPTIONAL
    !IV_KEYROLE TYPE /AWS1/GRFSTRING OPTIONAL
    !IV_SECONDSTOLIVE TYPE /AWS1/GRFINTEGER OPTIONAL
    !IV_WORKSPACEID TYPE /AWS1/GRFWORKSPACEID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_grfcreworkspaceapik01
  RAISING
    /AWS1/CX_GRFACCESSDENIEDEX
    /AWS1/CX_GRFCONFLICTEXCEPTION
    /AWS1/CX_GRFINTERNALSERVEREX
    /AWS1/CX_GRFRESOURCENOTFOUNDEX
    /AWS1/CX_GRFSERVICEQUOTAEXCDEX
    /AWS1/CX_GRFTHROTTLINGEX
    /AWS1/CX_GRFVALIDATIONEX
    /AWS1/CX_GRFCLIENTEXC
    /AWS1/CX_GRFSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_keyname` `TYPE /AWS1/GRFAPIKEYNAME` `/AWS1/GRFAPIKEYNAME`¶

Specifies the name of the key. Keynames must be unique to the workspace.

`iv_keyrole` `TYPE /AWS1/GRFSTRING` `/AWS1/GRFSTRING`¶

Specifies the permission level of the key.

Valid values: ADMIN|EDITOR|VIEWER

`iv_secondstolive` `TYPE /AWS1/GRFINTEGER` `/AWS1/GRFINTEGER`¶

Specifies the time in seconds until the key expires. Keys can be valid for up to 30 days.

`iv_workspaceid` `TYPE /AWS1/GRFWORKSPACEID` `/AWS1/GRFWORKSPACEID`¶

The ID of the workspace to create an API key.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_grfcreworkspaceapik01` `/AWS1/CL_GRFCREWORKSPACEAPIK01`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->createworkspaceapikey(
  iv_keyname = |string|
  iv_keyrole = |string|
  iv_secondstolive = 123
  iv_workspaceid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_apikeyname = lo_result->get_keyname( ).
  lv_apikeytoken = lo_result->get_key( ).
  lv_workspaceid = lo_result->get_workspaceid( ).
ENDIF.

/AWS1/IF_GRF=>CREATEWORKSPACEAPIKEY()¶