> ## Documentation Index
> Fetch the complete documentation index at: https://docs.contraforce.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Agent tool get user details



## OpenAPI

````yaml /api-reference/openapi.json get /api/v2/workspaces/{workspaceId}/agent/tools/users/{userId}
openapi: 3.1.1
info:
  title: ContraForce API
  description: ContraForce platform API for security operations management.
  version: '2.0'
servers: []
security: []
tags:
  - name: Incidents
  - name: Gamebooks
  - name: Data sources
  - name: Service tickets
  - name: Investigation
  - name: agent-tools
  - name: Cross-workspace incidents
  - name: Cross-workspace gamebooks
  - name: Cross-workspace data sources
  - name: Webhooks
  - name: Service accounts
  - name: Users
  - name: Azure resources
paths:
  /api/v2/workspaces/{workspaceId}/agent/tools/users/{userId}:
    get:
      tags:
        - agent-tools
      summary: Agent tool get user details
      operationId: v2-agent-tool-get-user-details
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: userId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseOfAgentToolUserDetailsResult'
        '400':
          description: Bad request — validation or parameter binding failed.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemDetails'
        '401':
          description: Unauthorized — missing or invalid Bearer token.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemDetails'
        '403':
          description: Forbidden — insufficient scope or workspace access.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemDetails'
        '404':
          description: Not found — workspace or resource is missing.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemDetails'
        '500':
          description: Internal server error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemDetails'
components:
  schemas:
    ApiResponseOfAgentToolUserDetailsResult:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AgentToolUserDetailsResult'
        meta:
          $ref: '#/components/schemas/ResponseMeta'
      description: Standard v2 API response envelope for single-item responses.
    ApiProblemDetails:
      type: object
      properties:
        type:
          type:
            - 'null'
            - string
        title:
          type:
            - 'null'
            - string
        status:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - 'null'
            - integer
            - string
          format: int32
        detail:
          type:
            - 'null'
            - string
        instance:
          type:
            - 'null'
            - string
        code:
          type:
            - 'null'
            - string
        requestId:
          type:
            - 'null'
            - string
        timestamp:
          type:
            - 'null'
            - string
        target:
          type:
            - 'null'
            - string
        errors:
          type:
            - 'null'
            - object
          additionalProperties:
            type: array
            items:
              type: string
      description: >-
        API extension of ProblemDetails that surfaces the stable error code,

        trace identifier, timestamp, optional target, and optional field-keyed
        validation

        error map alongside the RFC 7807 members.
    AgentToolUserDetailsResult:
      type: object
      properties:
        success:
          type: boolean
          description: >-
            True when the user was found in Microsoft Graph. False when the user
            does not exist, when the Gamebooks-for-Identity module is disabled
            for the workspace, or when Graph returned an error — reason in
            `summary`.
        summary:
          type:
            - 'null'
            - string
          description: >-
            Compact one-line human-readable digest: '{DisplayName}, {JobTitle}
            in {Department} ({OfficeLocation}). UPN: {UPN}.' — fields omitted
            when null.
        user_id:
          type:
            - 'null'
            - string
          description: >-
            Azure AD object ID of the resolved user. Echoes the request input —
            useful for chained calls.
        display_name:
          type:
            - 'null'
            - string
          description: Display name (first + last) of the user.
        user_principal_name:
          type:
            - 'null'
            - string
          description: >-
            User Principal Name (UPN), typically the user's email-like sign-in
            name (e.g. alice@contoso.com).
        mail:
          type:
            - 'null'
            - string
          description: Primary SMTP email address. May differ from the UPN.
        job_title:
          type:
            - 'null'
            - string
          description: >-
            Job title from the user's directory profile. Useful for assessing
            whether the account is privileged (e.g. 'Domain Admin', 'CFO').
        department:
          type:
            - 'null'
            - string
          description: Department from the user's directory profile.
        office_location:
          type:
            - 'null'
            - string
          description: >-
            Office location from the user's directory profile. Useful when
            correlating sign-in geolocation against expected location.
        mobile_phone:
          type:
            - 'null'
            - string
          description: Mobile phone number from the user's directory profile.
      description: >-
        Result of an agent user-lookup tool call. Returns a token-efficient view
        of a Microsoft

        Graph user with only the fields that have proven useful in incident
        analysis — full

        Graph payloads include large arrays of identities, business phones, and
        password change

        metadata that bloat LLM context without changing decisions.
    ResponseMeta:
      type: object
      properties:
        requestId:
          type:
            - 'null'
            - string
        timestamp:
          type:
            - 'null'
            - string

````