API Realm Settings Endpoints

Introduction

Use the /api PATCH and POST endpoints to generate app keys and IDs used for application - SecureAuth IdP communication and to enable the various APIs in a realm.

Prerequisites

1. Complete the Enablement and Header Steps in the Admin API Guide

2. Have access to the application code that calls to the API endpoint(s)

3. Integrate a membership and profile directory(s) with SecureAuth IdP (Data Realm Settings Endpoint)

4. Refer to the Authentication API and Identity Management API guides for more information

/api Endpoints

The following endpoints are prepended with the URL, https://<SecureAuth IdP Domain>/api/v1/realms/<realm ID>, if running SecureAuth IdP v9.1 – in which realm ID is the ID number of the realm to configure –

or https://<SecureAuth IdP Domain>/api/v2/realms/<realm ID>, if running SecureAuth IdP v9.2 or later

Enable APIs /apisettings PATCH Endpoint

Use this endpoint to enable SecureAuth IdP APIs in the realm, including Authentication APIs and Identity Management APIs.

HTTP Method	Endpoint	Example	SecureAuth IdP version
PATCH	/apisettings	https://secureauth.company.com/api/v1/realms/26/apisettings	v9.1
PATCH	/apisettings	https://secureauth.company.com/api/v2/realms/26/apisettings	v9.2 or later

Field Definitions and Accepted Values for Configuration

Field	Description	Accepted Values	Note
enableApi	Enable API communication in realm	true false	Set to true to enable other APIs
enableAuthenticationApi	Enable Authentication API	true false
enableIdentityManagementUserProperties	Enable user profile management API	true false
enableIdentityManagementAdminInitiatedPasswordReset	Enable administrative password reset API	true false
enableIdentityManagementUserSelfServicePasswordChange	Enable self-service password change API	true false
enableIdentityManagementUserGroupAssociation	Enable directory group management API	true false
enableSecureAuthCredentialProviderApi	Enable Credential Provider API	true false	Required for Login for Endpoint use

Parameters and Response Examples

Parameter

Success Response

{
	"enableApi": true,
	"enableAuthenticationApi": true,
	"enableIdentityManagementUserProperties": true,
	"enableIdentityManagementAdminInitiatedPasswordReset": false,
	"enableIdentityManagementUserSelfServicePasswordChange": true,
	"enableIdentityManagementUserGroupAssociation": false,
	"enableSecureAuthCredentialProviderApi": false
}

{
  "status": "Success",
  "message": []
}

Generate Application ID and Key /apigeneratecredentials POST Endpoint

Use this endpoint to generate and application ID and key in the realm that is used for communication between the application and the SecureAuth IdP APIs. No modifications can be made at this endpoint.

HTTP Method	Endpoint	Example	SecureAuth IdP version
POST	/apigeneratecredentials	https://secureauth.company.com/api/v1/realms/26/apigeneratecredentials	v9.1
POST	/apigeneratecredentials	https://secureauth.company.com/api/v2/realms/26/apigeneratecredentials	v9.2 or later

Definitions

apiSetting: List of configured API enablements, set in the /apisettings endpoint
applicationId: Generated App ID value used for API connection
applicationKey: Generated App Key value used for API connection
status: Result of endpoint call
message: Additional information regarding result of endpoint call (empty unless error)

Response Example

{
	"apiSetting": {
		"enableApi": true,
		"applicationId": "7ee7544a80c646149XXXXXXXXXXXXXXXX",
		"applicationKey": "ac5ded85e42ec5633bee6d7c56bb51eXXXXXXXXXXXXXXXXXX",
		"enableAuthenticationApi": true,
		"enableIdentityManagementUserProperties": true,
		"enableIdentityManagementAdminInitiatedPasswordReset": false,
		"enableIdentityManagementUserSelfServicePasswordChange": true,
		"enableIdentityManagementUserGroupAssociation": false,
		"enableSecureAuthCredentialProviderApi": false
	},
	"status": "Success",
	"message": []
}

Related Documentation

API Tab Configuration

Content

Space Tools

Generate Application ID and Key /apigeneratecredentials POST Endpoint

Content

Space Tools

Breadcrumbs

API Realm Settings Endpoints

Generate Application ID and Key /apigeneratecredentials POST Endpoint