Approve a list of users

POST /apim/approve_users

Overview

This API approves the user ID or a list of user IDs that appear in the created status under Subscription Manager.

Note: The approval process is unsuccessful if the user is not registered in Developer Portal.

Prerequisites

Org admin (Environment admin) permissions
Developer portal login credentials
Specify the user ID or list of user IDs for approval

Request

POST https://{controlplane_path}/api/1/rest/public/apim/approve_users

Path parameters


Key	Description
`controlplane_path`	Required. The path to the SnapLogic control plane: `elastic.snaplogic.com` For the UAT or EMEA control plane, substitute the name for `elastic`. For example: `uat.elastic.snaplogic.com` `emea.snaplogic.com`

Query parameters

None.

Request header

Basic authentication

In the request header, specify Basic for authorization, add your credentials (Login and password of your SnapLogic user or service account), and specify application/json for content type. For more details on accounts refer to Manage accounts.


Authorization: Basic {base64_encoded <email>:<password>}
Content-Type: application/json

Example of Basic authenthication using Postman

Request body


{
  "org_name": "Automation2",
  "user_ids": [
    "[email protected]",
    "[email protected]",
    "[email protected]",
    "[email protected]"
  ]
}


Key	Type	Description
`org_name`	string	The name of the SnapLogic Environment/Org
`user_ids`	array/string	An array that contains the user ID or a list of user IDs

Response

Response body


{
  "response_map": {
    "successful approvals": [
      {
        "User IDs": [
          "[email protected]",
          "[email protected]"
        ]
      }
    ],
    "failed approvals": [
      {
        "User [email protected]": "User has not requested access to this org"
      },
      {
        "User [email protected]": "User has not requested access to this org"
      }
    ]
  }
}


Key	Type	Description
`{ "Successful Approvals" : <list of usernames> }`	array	The JSON object array contains the list of user IDs that are successfully approved.
`{ "Failed Approvals" : <list of username: error when approving> }`	array	The JSON object array contains the list of user IDs that failed the approval process.