Versions Compared

Key

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

...

Info

Note: If the Zilla fields and the fields from the API response are the same then this configuration property can be left blank.

Required Fields

The following fields are required in the API Integration:

  • id: a unique identifier value assigned to an account. Example = 1234

  • username: a unique display name assigned to an account. Example = jsmith

  • email: a unique email addressed assigned to an account. Example = jsmith@yourcompany.com

  • status: a value that indicates if an account is Active or Inactive. Example = ‘Active’, ‘Inactive’, ‘Enabled’, ‘Disabled’

  • roles: the permissions associated with an account. Example = ‘Admin’, ‘Default’, ‘Standard’

  • Account Active Statuses: The status (active or inactive status) response from the API. Value could be true, enabled, active, provisioned, etc. Examples: For AHA we get true as active status so the value for this config would be true and for Okta, we get PROVISIONED so the value for this config would be PROVISIONED.

  • Authorization Url: The endpoint for the authorization server, used to get the authorization code. Example: For Okta it is https://{orgdomain}/oauth2/v1/authorize.

  • Token Url: The endpoint for the authentication server. This is used to exchange the authorization code for an access token. Example: For Okta it is https://{orgdomain}/oauth2/v1/token.

  • Client Id: The client Id issued to the client during the application registration process.

  • Client Secret: The client secret issued to the client during the application registration process.

  • Space separated scopes: The scope of the access request. It may have multiple space-delimited values.

...