Deny a list of users

POST /apim/deny_users

Overview

This API denies access to the user ID or a list of user IDs that appear in 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 access denial

Request

POST https://{controlplane_path}/api/1/rest/public/apim/deny_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": [
    "test3@gmail.com",
    "test4@gmail.com",
    "test1@gmail.com",
    "test2@gmail.com"
  ]
}


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 denials": [
      {
        "User IDs": [
          "test3@gmail.com",
          "test4@gmail.com"
        ]
      }
    ],
    "failed denials": [
      {
        "User test1@gmail.com": "User is not registered"
      },
      {
        "User test2@gmail.com": "User is not registered"
      }
    ]
  }
}


Key	Type	Description
`{ "Successful Denials" : <list of usernames>(list of strings) }`	array	The JSON object array contains the list of user IDs that are successfully denied.
`{ "Failed denials" : < list of username: error when approving> }`	array	The JSON object array contains the list of user IDs that failed the denial process.