Contraforce

Contraforce Users API

The Users API from Contraforce — 7 operation(s) for users.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 10

GET /api/v2/users List users #
POST /api/v2/users Add user #
PUT /api/v2/users Update user #
GET /api/v2/users/{userId} Get user #
GET /api/v2/users/profile Get user profile #
PUT /api/v2/users/profile Update user profile #
POST /api/v2/users/workspace/users Get workspace users #
DELETE /api/v2/users/{id} Remove user #
POST /api/v2/users/workspace Add workspace users #
PUT /api/v2/users/organization/role Update org role #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/contraforce/openapi/contraforce-users-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/contraforce/json-schema/contraforce-api-response-of-ienumerable-of-user-schema.json
📊
JSONSchema
https://artifacts.apis.io/contraforce/json-schema/contraforce-api-response-of-user-schema.json
📊
JSONSchema
https://artifacts.apis.io/contraforce/json-schema/contraforce-submit-user-management-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/contraforce/json-schema/contraforce-submit-add-users-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/contraforce/json-schema/contraforce-api-response-of-ienumerable-of-workspace-user-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/contraforce/json-schema/contraforce-get-workspace-users-request-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/contraforce:contraforce-users-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

contraforce-users-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: ContraForce Users API
  description: ContraForce platform API for security operations management.
  version: '2.0'
tags:
- name: Users
paths:
  /api/v2/users:
    get:
      tags:
      - Users
      summary: List users
      operationId: v2-list-users
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseOfIEnumerableOfUser'
        '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'
    post:
      tags:
      - Users
      summary: Add user
      operationId: v2-add-user
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitAddUsersRequest'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseOfboolean'
        '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'
    put:
      tags:
      - Users
      summary: Update user
      operationId: v2-update-user
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitUserManagementRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseOfboolean'
        '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'
  /api/v2/users/{userId}:
    get:
      tags:
      - Users
      summary: Get user
      operationId: v2-get-user
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseOfUser'
        '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'
  /api/v2/users/profile:
    get:
      tags:
      - Users
      summary: Get user profile
      operationId: v2-get-user-profile
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseOfUserProfileDto'
        '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'
    put:
      tags:
      - Users
      summary: Update user profile
      operationId: v2-update-user-profile
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitUserManagementRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseOfboolean'
        '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'
  /api/v2/users/workspace/users:
    post:
      tags:
      - Users
      summary: Get workspace users
      operationId: v2-get-workspace-users
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetWorkspaceUsersRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseOfIEnumerableOfWorkspaceUserDto'
        '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'
  /api/v2/users/{id}:
    delete:
      tags:
      - Users
      summary: Remove user
      operationId: v2-remove-user
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseOfboolean'
        '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'
  /api/v2/users/workspace:
    post:
      tags:
      - Users
      summary: Add workspace users
      operationId: v2-add-workspace-users
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseOfboolean'
        '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'
  /api/v2/users/organization/role:
    put:
      tags:
      - Users
      summary: Update org role
      operationId: v2-update-org-role
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUserOrganizationalRoleRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseOfboolean'
        '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:
    ResponseMeta:
      type: object
      properties:
        requestId:
          type:
          - 'null'
          - string
        timestamp:
          type:
          - 'null'
          - string
    ApiResponseOfUserProfileDto:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/UserProfileDto'
        meta:
          $ref: '#/components/schemas/ResponseMeta'
      description: Standard v2 API response envelope for single-item responses.
    AppRole:
      enum:
      - DefaultAccess
      - Admin
      - User
      - Billing
      - IncidentAnalyst
      - IncidentResponder
      - DataSourceAdmin
    User:
      type: object
      properties:
        id:
          type:
          - 'null'
          - string
        displayName:
          type:
          - 'null'
          - string
        firstName:
          type:
          - 'null'
          - string
        lastName:
          type:
          - 'null'
          - string
        profilePictureUrl:
          type:
          - 'null'
          - string
        email:
          type:
          - 'null'
          - string
        username:
          type:
          - 'null'
          - string
        appRole:
          $ref: '#/components/schemas/AppRole'
        addedOn:
          type: string
          format: date-time
        hasLoggedIn:
          type: boolean
        isServiceAccount:
          type: boolean
        isAgentUser:
          type: boolean
        isScimManaged:
          type: boolean
          description: 'True when Microsoft Entra ID provisions the user through SCIM: their organizational role is derived from the

            default role for provisioned users and their groups, and cannot be set in the portal.'
        organizationRole:
          $ref: '#/components/schemas/OrganizationalRole'
        workspaceRole:
          $ref: '#/components/schemas/WorkspaceRole'
        groups:
          type:
          - 'null'
          - array
          items:
            $ref: '#/components/schemas/UserGroup'
        roleAssignments:
          type:
          - 'null'
          - array
          items:
            $ref: '#/components/schemas/UserRoleAssignment'
      description: Represents an employee or a user in ContraForce client's tenant and it's built on top of the Microsoft Graph user model and could be extended based on other provider needs
    SubmitUserManagementRequest:
      type: object
      properties:
        displayName:
          type:
          - 'null'
          - string
        tenantId:
          type:
          - 'null'
          - string
        userId:
          type:
          - 'null'
          - string
        organizationalRole:
          $ref: '#/components/schemas/OrganizationalRole'
        email:
          type:
          - 'null'
          - string
        isOwner:
          type: boolean
    ApiResponseOfUser:
      type: object
      properties:
        data:
          description: Represents an employee or a user in ContraForce client's tenant and it's built on top of the Microsoft Graph user model and could be extended based on other provider needs
          $ref: '#/components/schemas/User'
        meta:
          $ref: '#/components/schemas/ResponseMeta'
      description: Standard v2 API response envelope for single-item responses.
    UserGroup:
      type: object
      properties:
        id:
          type: string
          format: uuid
        accountId:
          type: string
          format: uuid
        accountName:
          type:
          - 'null'
          - string
        creationDate:
          type: string
          format: date-time
        lastModificationDate:
          type: string
          format: date-time
        groupOwner:
          type:
          - 'null'
          - string
        name:
          type:
          - 'null'
          - string
        description:
          type:
          - 'null'
          - string
        members:
          type:
          - 'null'
          - array
          items:
            description: Represents an employee or a user in ContraForce client's tenant and it's built on top of the Microsoft Graph user model and could be extended based on other provider needs
            $ref: '#/components/schemas/User'
        role:
          $ref: '#/components/schemas/WorkspaceRole'
        workspacesAssigned:
          type:
          - 'null'
          - array
          items:
            type: string
        isScimManaged:
          type: boolean
          description: 'True when Microsoft Entra ID provisions the group through SCIM: its name and members are managed in Entra and

            locked in the portal, while its description, workspace assignments and organizational role stay editable.'
        orgRole:
          oneOf:
          - type: 'null'
          - description: 'The organizational role members hold for as long as they belong to the group; null when the group grants none.

              Only SCIM-managed groups grant one.'
            $ref: '#/components/schemas/OrganizationalRole'
    UpdateUserOrganizationalRoleRequest:
      type: object
      properties:
        userId:
          type:
          - 'null'
          - string
        organizationalRole:
          $ref: '#/components/schemas/OrganizationalRole'
    UserRoleAssignment:
      type: object
      properties:
        userId:
          type:
          - 'null'
          - string
        workspaceId:
          type:
          - 'null'
          - string
        workspaceName:
          type:
          - 'null'
          - string
        assignmentType:
          type:
          - 'null'
          - string
        role:
          $ref: '#/components/schemas/WorkspaceRole'
    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.'
    SubmitAddUsersRequest:
      type: object
      properties:
        users:
          type:
          - 'null'
          - array
          items:
            $ref: '#/components/schemas/SubmitUserManagementRequest'
        assignToWorkspace:
          type: boolean
          description: Set to true if the user is needed to be assigned for the workspace by default
    ApiResponseOfIEnumerableOfWorkspaceUserDto:
      type: object
      properties:
        data:
          type:
          - 'null'
          - array
          items:
            $ref: '#/components/schemas/WorkspaceUserDto'
        meta:
          $ref: '#/components/schemas/ResponseMeta'
      description: Standard v2 API response envelope for single-item responses.
    OrganizationalRole:
      enum:
      - Admin
      - UserAdmin
      - WorkspaceAdmin
      - AgentAdmin
      - Member
      - OrgContentOperator
      - OrgContentAdmin
    ApiResponseOfIEnumerableOfUser:
      type: object
      properties:
        data:
          type:
          - 'null'
          - array
          items:
            description: Represents an employee or a user in ContraForce client's tenant and it's built on top of the Microsoft Graph user model and could be extended based on other provider needs
            $ref: '#/components/schemas/User'
        meta:
          $ref: '#/components/schemas/ResponseMeta'
      description: Standard v2 API response envelope for single-item responses.
    ApiResponseOfboolean:
      type: object
      properties:
        data:
          type: boolean
        meta:
          $ref: '#/components/schemas/ResponseMeta'
      description: Standard v2 API response envelope for single-item responses.
    WorkspaceUserDto:
      type: object
      properties:
        id:
          type:
          - 'null'
          - string
        displayName:
          type:
          - 'null'
          - string
        email:
          type:
          - 'null'
          - string
        workspaceId:
          type:
          - 'null'
          - string
        role:
          $ref: '#/components/schemas/WorkspaceRole'
        userId:
          type:
          - 'null'
          - string
        isAgentUser:
          type: boolean
          description: 'Whether the assignment belongs to an AI agent service identity. Agent assignments

            are immutable from IAM screens — agent requests authenticate through them.'
    WorkspaceRole:
      enum:
      - Owner
      - ContentAdmin
      - IncidentResponder
      - IncidentAnalyst
      - WorkspaceReader
    UserProfileDto:
      type: object
      properties:
        name:
          type:
          - 'null'
          - string
        email:
          type:
          - 'null'
          - string
        upn:
          type:
          - 'null'
          - string
        userId:
          type:
          - 'null'
          - string
        role:
          $ref: '#/components/schemas/OrganizationalRole'
        organization:
          type:
          - 'null'
          - string
        organizationId:
          type:
          - 'null'
          - string
        tenantId:
          type:
          - 'null'
          - string
        preferredTimeZoneId:
          type:
          - 'null'
          - string
        lastReleaseNotesSeenId:
          type:
          - 'null'
          - string
    GetWorkspaceUsersRequest:
      required:
      - accountId
      type: object
      properties:
        accountId:
          type: string
          format: uuid
        query:
          type:
          - 'null'
          - string
        role:
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/WorkspaceRole'