register_oauth_client

This API wraps supported GuardAPI functions in a REST API that uses JSON for input and output.

Note: The register_oauth_client API does not support the redirect_uris and scope parameters. These parameters are hard-coded for Guardium. If you make changes to redirect_uris or scope, the values are validated, but Guardium does not use them.

This API is available in Guardium V9.5 and later.

GuardAPI syntax

register_oauth_client parameter=value

Parameters

Parameter Value type Description
client_id String Required.
GetToken Boolean Valid values:
  • 0 (false)
  • 1 (true)

Default = 0 (false)
grant_types String For valid values, call register_oauth_client from the command line with --help=true.
password String The user password.
user String The username for the Guardium UI.
redirect_uris String Guardium does not support this parameter. Guardium suggests that you leave the redirect_uris parameter blank. If you must enter a value, the only valid value is https://someApp.
scope String Guardium does not support this parameter. Guardium suggests that you leave the scope parameter blank. If you must enter a value, you can enter one or more of the following comma-separated values, but Guardium ignores them:
  • read
  • write
  • delete

Example

grdapi register_oauth_client client_id="test12" grant_types="password" user="admin" password="password" GetToken=1