Dome9

Dome9 Auth API

The Auth API from Dome9 — 7 operation(s) for auth.

GitHub OpenAPI

Operations 7

POST /v2/auth/assume-role/jwt Auth post assume role for api #
POST /v2/auth/assume-role/web Auth post assume role for web #
POST /v2/auth/reset-password-request Auth post reset password request async #
POST /v2/auth/reset-password-request-by-email request to reset password to a user without reCaptcha - ONLY to SuperUser #
GET /v2/auth/reset-password/{requestId} Auth get reset password #
POST /v2/auth/reset-password Auth post reset password #
POST /v2/auth/change-password Auth post change password #

Documentation

📖
Documentation
https://docs.cgn.portal.checkpoint.com/
📖
APIReference
https://docs.cgn.portal.checkpoint.com/reference/introduction
📖
GettingStarted
https://docs.cgn.portal.checkpoint.com/docs
📖
Authentication
https://docs.cgn.portal.checkpoint.com/reference/authentication

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/dome9/refs/heads/main/openapi/dome9-auth-api-openapi.yml

Other Resources

🔗
PostmanCollection
https://www.postman.com/dome9-security/workspace/dome9-api

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/dome9-auth-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

dome9-auth-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: v2
  title: Dome9. Auth API
servers:
- url: https://api.dome9.com
tags:
- name: Auth
  type: Unclassified
paths:
  /v2/auth/assume-role/jwt:
    post:
      tags:
      - Auth
      operationId: Auth_PostAssumeRoleForApi
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
            text/json:
              schema:
                type: object
            text/html:
              schema:
                type: object
            application/xml:
              schema:
                type: object
            text/xml:
              schema:
                type: object
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.AssumeRoleViewModel'
          text/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.AssumeRoleViewModel'
          text/html:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.AssumeRoleViewModel'
          application/xml:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.AssumeRoleViewModel'
          text/xml:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.AssumeRoleViewModel'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.AssumeRoleViewModel'
        required: true
      summary: Auth post assume role for api
      x-summary-source: derived
  /v2/auth/assume-role/web:
    post:
      tags:
      - Auth
      operationId: Auth_PostAssumeRoleForWeb
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
            text/json:
              schema:
                type: object
            text/html:
              schema:
                type: object
            application/xml:
              schema:
                type: object
            text/xml:
              schema:
                type: object
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.AssumeRoleViewModel'
          text/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.AssumeRoleViewModel'
          text/html:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.AssumeRoleViewModel'
          application/xml:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.AssumeRoleViewModel'
          text/xml:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.AssumeRoleViewModel'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.AssumeRoleViewModel'
        required: true
      summary: Auth post assume role for web
      x-summary-source: derived
  /v2/auth/reset-password-request:
    post:
      tags:
      - Auth
      operationId: Auth_PostResetPasswordRequestAsync
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
            text/json:
              schema:
                type: object
            text/html:
              schema:
                type: object
            application/xml:
              schema:
                type: object
            text/xml:
              schema:
                type: object
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.ResetPasswordRequestViewModel'
          text/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.ResetPasswordRequestViewModel'
          text/html:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.ResetPasswordRequestViewModel'
          application/xml:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.ResetPasswordRequestViewModel'
          text/xml:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.ResetPasswordRequestViewModel'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.ResetPasswordRequestViewModel'
        required: true
      summary: Auth post reset password request async
      x-summary-source: derived
  /v2/auth/reset-password-request-by-email:
    post:
      tags:
      - Auth
      summary: request to reset password to a user without reCaptcha - ONLY to SuperUser
      operationId: Auth_PostResetPasswordRequestByEmailAsync
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
            text/json:
              schema:
                type: object
            text/html:
              schema:
                type: object
            application/xml:
              schema:
                type: object
            text/xml:
              schema:
                type: object
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.ResetPasswordByEmailRequestViewModel'
          text/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.ResetPasswordByEmailRequestViewModel'
          text/html:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.ResetPasswordByEmailRequestViewModel'
          application/xml:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.ResetPasswordByEmailRequestViewModel'
          text/xml:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.ResetPasswordByEmailRequestViewModel'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.ResetPasswordByEmailRequestViewModel'
        required: true
  /v2/auth/reset-password/{requestId}:
    get:
      tags:
      - Auth
      operationId: Auth_GetResetPassword
      parameters:
      - name: requestId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.Auth.ResetPasswordGetViewModel'
            text/json:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.Auth.ResetPasswordGetViewModel'
            text/html:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.Auth.ResetPasswordGetViewModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.Auth.ResetPasswordGetViewModel'
            text/xml:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.Auth.ResetPasswordGetViewModel'
      summary: Auth get reset password
      x-summary-source: derived
  /v2/auth/reset-password:
    post:
      tags:
      - Auth
      operationId: Auth_PostResetPassword
      responses:
        '204':
          description: No Content
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.ResetPasswordPostViewModel'
          text/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.ResetPasswordPostViewModel'
          text/html:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.ResetPasswordPostViewModel'
          application/xml:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.ResetPasswordPostViewModel'
          text/xml:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.ResetPasswordPostViewModel'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.ResetPasswordPostViewModel'
        required: true
      summary: Auth post reset password
      x-summary-source: derived
  /v2/auth/change-password:
    post:
      tags:
      - Auth
      operationId: Auth_PostChangePassword
      responses:
        '204':
          description: No Content
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.ChangePasswordViewModel'
          text/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.ChangePasswordViewModel'
          text/html:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.ChangePasswordViewModel'
          application/xml:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.ChangePasswordViewModel'
          text/xml:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.ChangePasswordViewModel'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Auth.ChangePasswordViewModel'
        required: true
      summary: Auth post change password
      x-summary-source: derived
components:
  schemas:
    Dome9.Web.Api.Auth.ResetPasswordGetViewModel:
      required:
      - verificationToken
      type: object
      properties:
        verificationToken:
          type: string
        mfa:
          type: boolean
    Dome9.Web.Api.Auth.ChangePasswordViewModel:
      required:
      - currentPassword
      - newPassword
      type: object
      properties:
        currentPassword:
          type: string
        newPassword:
          type: string
    Dome9.Web.Api.Auth.ResetPasswordByEmailRequestViewModel:
      required:
      - email
      type: object
      properties:
        email:
          format: email
          description: Email Address
          type: string
          example: MyName@gmail.com
    Dome9.Web.Api.Auth.AssumeRoleViewModel:
      type: object
      properties:
        accountId:
          format: int32
          type: integer
        roleName:
          type: string
        expirationInMin:
          format: int32
          maximum: 300
          minimum: 5
          type: integer
    Dome9.Web.Api.Auth.ResetPasswordRequestViewModel:
      required:
      - email
      type: object
      properties:
        email:
          format: email
          description: Email Address
          type: string
          example: MyName@gmail.com
        recaptchaResponse:
          type: string
    Dome9.Web.Api.Auth.ResetPasswordPostViewModel:
      required:
      - requestId
      - verificationToken
      - password
      type: object
      properties:
        requestId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        verificationToken:
          type: string
        password:
          type: string
        mfaCode:
          type: string
  securitySchemes:
    API_key_V2:
      type: http
      scheme: basic