Authentication Type Commands

createoauthkey

To use BIRST REST APIs, the user must create a consumer key and secret. The secret and key are specific to the user and is used to authenticate the user. Authentication only ensures that the user utilizing these APIs is a valid Birst user. Other permissions may be required for the API specific context.

createoauthkey

Use createoauthkey to generate a key and a secret.

Note: This command should be done by your Account Administrator or by development only.

deleteoauthkey

Delete the key and secret if you must revoke access.

deleteoauthkey

Note: This command should be done by your Account Administrator or by development only.

getauthentication

Returns the authentication setting for the account. Use setauthentication to change the setting.

getauthentication {account_ID}

Example results:

Executing command: getauthenticationAuthentication settings: Birst Authentication (default)

For Account Administrators only.

There is no web service for this command.

setauthentication

Sets the authentication type for the account. The type is BIRST. Use getauthentication to see the current setting.

setauthentication BIRST {host_name} {secret}

Examples:

setauthentication BIRST

For Account Administrators only.

There is no web service for this command.