Open Context Protocol is live! 🚀 Read the launch post

checkAccessByEmail

Check site access for a list of emails

Details

  • Method: POST
  • Path: /user/access/check-access-by-email
  • Operation ID: checkAccessByEmail

Parameters

{}

Response Schema

{
  "type": "object",
  "properties": {
    "emailsWithoutAccess": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of emails that do not have access to site."
    },
    "invalidEmails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of invalid emails provided in the request."
    }
  }
}

Usage

from ocp_agent import OCPAgent

agent = OCPAgent()
await agent.register_api('confluence')

# Call this tool
result = await agent.call_tool('checkAccessByEmail', {
    # Add required parameters here
})