Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Query Parameters are as follows:

Name

Description

Sample Values

action

String indicating the action to be executed. GENERATE_TOKEN is the default action value for generating tokens.

GENERATE_TOKEN

authType

Generating access token method.

APIKEY

clientId

Client ID shared by the team.

8HIG1002H6

clitentToken

clientToken

Client Token provided by the team for report generation.

sample72695bf9-3932-4f60-88b5-2f-2hjd

Response Parameters are as follows:

Parameter

Type

Description

replyType

string

For reply type, the report status will be returned as 'SUCCESS' if generating token is successful or 'FAILURE' if generating token is a failure.

accessToken

string

Access token for using Sigma Report APIs.

Sample Response

Code Block
{
"headerMap": {
"replyType": "success",
"success": "true",
"accessToken": " sample61d74837-2e77-4ede-a967-2c84b30-dws-b3b4f 7"
}
}

2. Generating access tokens – BASIC method

...

Query Parameters are as follows:

Name

Description

Sample Values

action

String indicating the action to be executed. GENERATE_TOKEN is the default action value for generating tokens.

GENERATE_TOKEN

authType

Generating access token method.

BASIC

username

Provided user name.

terrim

password

Provided password.

canvas

Response Parameters are as follows:

Parameter

Type

Description

replyType

string

For reply type, the report status will be returned as 'SUCCESS' if generating token is successful or 'FAILURE' if generating token is a failure.

accessToken

string

Access token for using Sigma Report APIs.

Sample Response

Code Block
{
"headerMap": {
"replyType": "success",
"success": "true",
"accessToken": " sample61d74837-2e77-4ede-a967-2c84b30-dws-b3b4f 7"
}
}