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 guide and Identity Management API guide guides for more information

/api Endpoints

Note

The following endpoints are prepended with the URL, https://<SecureAuth IdP Domain>/api/v2/realms/<realm ID>

Enable APIs /apisettings PATCH Endpoint

Notice

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/v2/realms/26/apisettings	v9.2 or later

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

Parameter	Success Response
{ "enableApi": true, "enableAuthenticationApi": true, "enableIdentityManagementUserProperties": true, "enableIdentityManagementAdminInitiatedPasswordReset": false, "enableIdentityManagementUserSelfServicePasswordChange": true, "enableIdentityManagementUserGroupAssociation": false, "enableSecureAuthCredentialProviderApi": false }	{ "status": "Success", "message": [] }

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

Notice

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/v2/realms/26/apigeneratecredentials	v9.2 or later

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

In this section:

API Realm Settings Endpoints

Introduction

Prerequisites

/api Endpoints

Note

Notice

Generate Application ID and Key /apigeneratecredentials POST Endpoint

Notice

Search results