get_identity
Return the authenticated agent's identity, registration kind, scope ceiling, and status.
# MCP tool reference
1 callable tools.
Use tools/call at https://mcp.schedulerzero.com/mcp with the exact tool name and arguments below. The /tools/ paths in this view are documentation identifiers, not HTTP endpoints. Request execution is disabled for this reference.
Inputs are shown for personal API keys (bound) and for OAuth/delegated agents. Output schemas describe MCP structuredContent: native objects pass through; arrays, scalars and null use a data wrapper. Text content retains the native JSON result.
[Connect a client](/mcp/connect) · [Authentication and authorization](/authentication) · [Generated auth guide](/auth.md) · [Download tool catalog](/mcp-catalog.json) · [Agent documentation](/llms.txt)
## get_identity
Return the authenticated agent's identity, registration kind, scope ceiling, and status.
Call first to learn which principal, organization, and scopes the credential holds before attempting work.
Do not call in a polling loop; identity changes only on credential or registration changes.
Scopes: agent:identity
Risk: read; confirmation: none; idempotency: none.
### Input schema (personal API key)
```json
{
"type": "object",
"patternProperties": {
"^[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"not": {}
}
}
```
### Input schema (OAuth / delegated agent)
```json
{
"type": "object",
"patternProperties": {
"^[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"not": {}
}
}
```
### Output schema (structuredContent)
```json
{
"type": "object",
"properties": {
"registrationId": {
"anyOf": [
{
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
{
"type": "null"
}
]
},
"grantId": {
"$ref": "#/$defs/OpaqueId"
},
"kind": {
"type": "string",
"enum": [
"service_auth",
"identity_assertion",
"organization_api_key",
"internal_workflow",
"mcp_client_grant"
]
},
"status": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"active",
"interaction_required",
"expired",
"revoked",
"suspended"
]
},
"reasonCode": {
"type": "string",
"enum": [
"actor_removed",
"credential_expired",
"link_required",
"provider_revoked",
"admin_revoked",
"policy_suspended"
]
}
},
"required": [
"status"
],
"patternProperties": {
"^(?!(?:status|reasonCode)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"status",
"reasonCode"
]
}
},
"actorUserId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"organization": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"name": {
"$ref": "#/$defs/ShortText"
},
"slug": {
"$ref": "#/$defs/ShortText"
}
},
"required": [
"id",
"name",
"slug"
],
"patternProperties": {
"^(?!(?:id|name|slug)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"name",
"slug"
]
}
},
"provider": {
"anyOf": [
{
"type": "object",
"properties": {
"issuer": {
"$ref": "#/$defs/ProviderId"
},
"displayName": {
"$ref": "#/$defs/ShortText"
}
},
"required": [
"issuer",
"displayName"
],
"patternProperties": {
"^(?!(?:issuer|displayName)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"issuer",
"displayName"
]
}
},
{
"type": "null"
}
]
},
"grantedScopes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"agent:capabilities",
"agent:identity",
"agent:operations:cancel",
"agent:operations:read",
"analytics:export",
"analytics:read",
"apiKey:create",
"apiKey:delete",
"apiKey:read",
"apiKey:update",
"audit:read",
"billing:manage",
"billing:read",
"blocklist:create",
"blocklist:delete",
"blocklist:read",
"campaign:archive",
"campaign:create",
"campaign:delete",
"campaign:launch",
"campaign:pause",
"campaign:read",
"campaign:update",
"dialer:assign_numbers",
"dialer:assign_seats",
"dialer:create",
"dialer:delete",
"dialer:dial",
"dialer:manage_billing",
"dialer:manage_number_health",
"dialer:manage_numbers",
"dialer:manage_numbers_self",
"dialer:manage_voicemails",
"dialer:read",
"dialer:read_analytics",
"dialer:read_numbers_all",
"dialer:release_numbers",
"dialer:update",
"domain:manage_dns",
"domain:purchase",
"domain:read",
"domain:transfer",
"emailVerification:manage_credits",
"emailVerification:manage_keys",
"emailVerification:manage_sharing",
"emailVerification:read",
"emailVerification:verify",
"inbox:connect",
"inbox:create",
"inbox:delete",
"inbox:read",
"inbox:update",
"inbox:warmup_manage",
"integration:create",
"integration:delete",
"integration:read",
"integration:update",
"lead:create",
"lead:delete",
"lead:export",
"lead:import",
"lead:read",
"lead:update",
"leadList:create",
"leadList:delete",
"leadList:read",
"leadList:update",
"org:delete",
"orgAnalytics:read",
"orgAnalytics:manage",
"org:read",
"org:update",
"orgApiKey:manage",
"orgMember:invite",
"orgMember:read",
"orgMember:remove",
"orgMember:update",
"phoneVerification:manage_keys",
"phoneVerification:read",
"phoneVerification:verify",
"platform:operate",
"replyLabel:create",
"replyLabel:delete",
"replyLabel:read",
"replyLabel:update",
"role:manage",
"role:read",
"sequence:create",
"sequence:delete",
"sequence:read",
"sequence:update",
"sql:manage_dashboards",
"sql:query",
"support:create",
"support:read",
"support:update",
"tag:create",
"tag:delete",
"tag:read",
"tag:update",
"task:create",
"task:delete",
"task:read",
"task:update",
"template:create",
"template:delete",
"template:read",
"template:update",
"unibox:archive",
"unibox:label",
"unibox:read",
"unibox:reply",
"usage:read",
"webhook:create",
"webhook:delete",
"webhook:read",
"webhook:update",
"whiteLabel:read",
"whiteLabel:update",
"workflow:create",
"workflow:delete",
"workflow:publish",
"workflow:read",
"workflow:run",
"workflow:update",
"workspace:create",
"workspace:delete",
"workspace:read",
"workspace:transfer",
"workspace:update",
"workspaceMember:invite",
"workspaceMember:read",
"workspaceMember:remove",
"workspaceMember:update"
]
}
},
"createdAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"lastUsedAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"expiresAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"registrationId",
"kind",
"status",
"actorUserId",
"organization",
"provider",
"grantedScopes",
"createdAt",
"lastUsedAt",
"expiresAt"
],
"patternProperties": {
"^(?!(?:registrationId|grantId|kind|status|actorUserId|organization|provider|grantedScopes|createdAt|lastUsedAt|expiresAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"registrationId",
"grantId",
"kind",
"status",
"actorUserId",
"organization",
"provider",
"grantedScopes",
"createdAt",
"lastUsedAt",
"expiresAt"
]
},
"$defs": {
"OpaqueId": {
"type": "string",
"minLength": 1,
"maxLength": 512
},
"ShortText": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"ProviderId": {
"type": "string",
"minLength": 1,
"maxLength": 512
},
"UtcDateTimeEncoded": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
}
}
}
```
### Underlying API operations
- `agent.getIdentity`: `GET /agent/identity`
Scheduler Zero