Open Context Protocol is live! 🚀 Read the launch post
bulkGetUsersMigration

bulkGetUsersMigration

Get account IDs for users

Details

  • Method: GET
  • Path: /rest/api/3/user/bulk/migration
  • Operation ID: bulkGetUsersMigration

Parameters

{
  "startAt": {
    "description": "The index of the first item to return in a page of results (page offset).",
    "required": false,
    "location": "query",
    "type": "integer",
    "format": "int64"
  },
  "maxResults": {
    "description": "The maximum number of items to return per page.",
    "required": false,
    "location": "query",
    "type": "integer",
    "format": "int32"
  },
  "username": {
    "description": "Username of a user. To specify multiple users, pass multiple copies of this parameter. For example, `username=fred&username=barney`. Required if `key` isn't provided. Cannot be provided if `key` is present.",
    "required": false,
    "location": "query",
    "type": "array"
  },
  "key": {
    "description": "Key of a user. To specify multiple users, pass multiple copies of this parameter. For example, `key=fred&key=barney`. Required if `username` isn't provided. Cannot be provided if `username` is present.",
    "required": false,
    "location": "query",
    "type": "array"
  }
}

Response Schema

{
  "items": {
    "additionalProperties": false,
    "properties": {
      "accountId": {
        "type": "string"
      },
      "key": {
        "type": "string"
      },
      "username": {
        "type": "string"
      }
    },
    "type": "object"
  },
  "type": "array"
}

Usage

from ocp_agent import OCPAgent

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

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