Beyond Identity Launch Mechanisms API

openapi: 3.0.1
info:
  title: Beyond Identity Secure Access Applications Launch Mechanisms API
  version: 1.7.0
  contact:
    email: support@beyondidentity.com
  description: "# Introduction\n\n**NOTE:** To determine if you are accessing the Secure Access Platform, check the URL of your Admin Console.\nIf it looks like one of the following, you are using the Secure Access Platform:\n- `https://console.beyondidentity.com` (Localized to your region)\n- `https://console-us.beyondidentity.com` (US region)\n- `https://console-eu.beyondidentity.com` (EU region)\n- `https://console.us1.beyondidentity-gov.com` (US FedRAMP)\n\nIf your Admin Console URL does not look like one of the above, you are using the Secure Workforce Platform. Please refer to the [Secure Workforce API documentation](https://docs.beyondidentity.com/api/v0). <br /><br />\n\nThe Beyond Identity Secure Access API defines methods for managing resources in the Beyond Identity Secure Access platform.<br /><br />\n\nAll of the functionality available in the Beyond Identity Admin Console is\nalso available through the API. <br /><br />\n\nThis API is currently in the early-access stage and is under active\ndevelopment. Feedback and suggestions are encouraged and should be directed\nto the\n[Beyond Identity Developer Slack Channel](https://join.slack.com/t/byndid/shared_invite/zt-1anns8n83-NQX4JvW7coi9dksADxgeBQ).\n\n# Base API URLs\n\nThe base API URLs is determined by the region your tenant is hosted in OR if you are a FedRAMP customer. <br><br>\n\n### US Region\n\nIf you are a US region customer, your base API URLs will be:\n- `https://api-us.beyondidentity.com`\n- `https://auth-us.beyondidentity.com`\n\n### EU Region\n\nIf you are a EU region customer, your base API URLs will be:\n- `https://api-eu.beyondidentity.com`\n- `https://auth-eu.beyondidentity.com`\n\n### US FedRAMP\n\n**NOTE**: The FedRAMP version of Secure Access is released approximately *two weeks* after the commercial version, so some API endpoints may not be available immediately. <br><br>\n\nIf you are a FedRAMP customer in the US region, your base API URLs will be:\n- `https://api.us1.beyondidentity-gov.com`\n- `https://auth.us1.beyondidentity-gov.com`\n\nFor all the examples in this document, we will use the US region API base URL. You can always replace `https://api-us.beyondidentity.com`\nand `https://auth-us.beyondidentity.com` in the examples to use the proper base URL for your tenant.\n\n# Authentication\n\nAll Beyond Identity API endpoints require authentication using an access\ntoken. The access token is generated through OAuth 2.0 or OIDC, using the\nauthorization code flow or the client credentials flow. <br /><br />\n\nThe simplest way to acquire an access token is through the Beyond Identity Admin Console. Under the \"Applications\" tab, select the \"Beyond Identity Management API\" application, navigate to the \"API Tokens\" tab, and then click on \"Create token\". <br /><br />\n\nAlternatively, an access token may also be generated directly via the API by\nrequesting a token for the \"Beyond Identity Management API\" Application. <br><br>\n\n```\ncurl https://auth-us.beyondidentity.com/v1/tenants/$TENANT_ID/realms/$REALM_ID/applications/$APPLICATION_ID/token \\\n  -X POST \\\n  -u \"$CLIENT_ID:$CLIENT_SECRET\" --basic \\\n  -H \"Content-Type: application/x-www-form-urlencoded\" \\\n  -d \"grant_type=client_credentials&scope=$SCOPES\"\n```\n\nThis will work for any application that you have configured to provide\naccess to the Beyond Identity Management API Resource Server. The \"Beyond\nIdentity Management API\" application is provided by default as part of the\ntenant onboarding process.\n\nThe access token must be provided in the `Authorization` header of the\nAPI request. <br><br>\n\n```\ncurl https://api-us.beyondidentity.com/v1/... \\\n  -X $HTTP_METHOD -H \"Authorization: Bearer $TOKEN\"\n```\n\n## Requests and Responses\n\nTo interact with the Beyond Identity API, all requests should be made over\nHTTPS. <br /><br />\n\nThe Beyond Identity API is generally structured as a resource-oriented API.\nResources are represented as JSON objects and are used as both inputs to\nand outputs from API methods. <br /><br />\n\nResource fields may be described as read-only and immutable. A read-only\nfield is only provided on the response. An immutable field is only assigned\nonce and may not be changed after. For example, system-generated IDs are\ndescribed as both read-only and immutable. <br /><br />\n\nTo create a new resource, requests should use the `POST` method. Create\nrequests include all of the necessary attributes to create a new resource.\nCreate operations return the created resource in the response. <br /><br />\n\nTo retrieve a single resource or a collection of resources, requests should\nuse the `GET` method. When retrieving a collection of resources, the\nresponse will include an array of JSON objects keyed on the plural name of\nthe requested resource. <br /><br />\n\nTo update an resource, requests should use the `PATCH` method. Update\noperations support partial updating so requests may specify only the\nattributes which should be updated. Update operations return the updated\nresource in the response. <br /><br />\n\nTo delete a resource, requests should use the `DELETE` method. Note that\ndelete operations return an empty response instead of returning the\nresource in the response. <br /><br />\n\n### Example Response for a Realm\n\n```\n{\n  \"id\": \"a448fe493e02fa9f\",\n  \"tenant_id\": \"000168dc50bdce49\",\n  \"display_name\": \"Test Realm\",\n  \"create_time\": \"2022-06-22T21:46:08.930278Z\",\n  \"update_time\": \"2022-06-22T21:46:08.930278Z\"\n}\n```\n\n### Example Response for a Collection of Realms\n\n```\n{\n  \"realms\": [\n    {\n      \"id\": \"a448fe493e02fa9f\",\n      \"tenant_id\": \"000168dc50bdce49\",\n      \"display_name\": \"Test Realm\",\n      \"create_time\": \"2022-06-22T21:46:08.930278Z\",\n      \"update_time\": \"2022-06-22T21:46:08.930278Z\"\n    }\n  ],\n  \"total_size\": 1\n}\n```\n\n## HTTP Statuses\n\nThe API returns standard HTTP statuses and error codes.\n\nStatuses in the 200 range indicate that the request was successfully\nfulfilled and there were no errors. <br><br>\n\nStatuses in the 400 range indicate that there was an issue with the request\nthat may be addressed by the client. For example, client errors may\nindicate that the request was missing proper authorization or that the\nrequest was malformed. <br><br>\n\nStatuses in the 500 range indicate that the server encountered an internal\nissue and was unable to fulfill the request. <br><br>\n\nAll error responses include a JSON object with a `code` field and a\n`message` field. `code` contains a human-readable name for the HTTP status\ncode and `message` contains a high-level description of the error. The\nerror object may also contain additional error details which may be used by\nthe client to determine the exact cause of the error. Refer to each API\nmethod's examples to determine the specific error detail types supported\nfor that method. <br><br>\n\n### Invalid Access Token Example\n\nIf the provided access token is invalid, you will receive a 401 error.\nThis error indicates that the token is not recognized and was not generated\nby Beyond Identity. <br><br>\n\n```\nHTTP/1.1 401 Unauthorized\n{\n  \"code\": \"unauthorized\",\n  \"message\": \"unauthorized\"\n}\n```\n\n### Permission Denied Example\n\nIf the provided access token does not have access to the requested resource,\nyou will receive a 403 error. Access tokens are scoped at a minimum to your\ntenant. Any request for resources outside of your tenant will result in this\nerror. <br><br>\n\n```\nHTTP/1.1 403 Forbidden\n{\n  \"code\": \"forbidden\",\n  \"message\": \"forbidden\"\n}\n```\n\n### Missing Resource Example\n\nIf the requested resource does not exist, you will receive a 404 error. The\nspecific API method may return additional details about the missing\nresource. <br><br>\n\n```\nHTTP/1.1 404 Not Found\n{\n  \"code\": \"not_found\",\n  \"message\": \"group not found\"\n  \"details\": [\n    {\n      \"type\": \"ResourceInfo\",\n      \"resource_type\": \"Group\",\n      \"id\": \"4822738be6b7f658\",\n      \"description\": \"group not found\"\n    }\n  ],\n}\n```\n\n### Invalid Parameters Example\n\nIf the request body contains invalid parameters, you will receive a 400\nerror. The specific API method may return additional details about the\ninvalid parameter. <br><br>\n\n```\nHTTP/1.1 400 Bad Request\n{\n  \"code\": \"bad_request\",\n  \"message\": \"invalid parameters\"\n  \"details\": [\n    {\n      \"type\": \"FieldViolations\"\n      \"field_violations\": [\n        {\n          \"description\": \"missing\",\n          \"field\": \"group.display_name\"\n        }\n      ],\n    }\n  ],\n}\n```\n"
servers:
- url: https://api-us.beyondidentity.com
  description: US region API base URL
- url: https://api-eu.beyondidentity.com
  description: EU region API base URL
- url: https://api.us1.beyondidentity-gov.com/
  description: US FedRAMP API base URL
security:
- BearerAuth: []
tags:
- name: Launch Mechanisms
  description: 'Launch mechanisms, or flow type configurations, define which authentication launch mechanisms are enabled and valid for different platforms (Android, iOS, macOS, Windows, Web, Linux, ChromeOS) within a tenant. These configurations control which authentication methods end users can use on different devices and platforms.

    '
paths:
  /v1/tenants/{tenant_id}/realms/{realm_id}/flow-type-config:
    get:
      tags:
      - Launch Mechanisms
      summary: Get flow type configuration
      description: Retrieves the flow type configuration for a tenant or creates a default configuration if one does not exist
      operationId: GetFlowTypeConfig
      security:
      - DirectoryAuth:
        - tenants:read
        - realms:read
        - flow-type:read
        - flow-type:create
      parameters:
      - $ref: '#/components/parameters/tenant_id'
      - $ref: '#/components/parameters/realm_id'
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlowTypeConfig'
        '400':
          description: 'Bad request. If the request failed due to invalid fields, the error details will include a FieldViolations.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthenticated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Permission denied. The error details will include a ResourceInfo describing the authorization failure.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: 'Not found. The error details will include a ResourceInfo describing the required resource that was not found.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: 'Already exists. The error details will include a ResourceInfo describing the conflicting resource.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    patch:
      tags:
      - Launch Mechanisms
      summary: Update flow type configuration
      description: Updates the flow type configuration for a tenant, note that this will also create a default configuration if one does not exist
      operationId: UpdateFlowTypeConfig
      security:
      - DirectoryAuth:
        - tenants:read
        - realms:read
        - flow-type:read
        - flow-type:create
        - flow-type:update
      parameters:
      - $ref: '#/components/parameters/tenant_id'
      - $ref: '#/components/parameters/realm_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePlatformFlowTypeConfig'
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlowTypeConfig'
        '400':
          description: 'Bad request. If the request failed due to invalid fields, the error details will include a FieldViolations.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthenticated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Permission denied. The error details will include a ResourceInfo describing the authorization failure.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: 'Not found. The error details will include a ResourceInfo describing the required resource that was not found.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: 'Already exists. The error details will include a ResourceInfo describing the conflicting resource.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    UpdateFlowTypeSet:
      title: UpdateFlowTypeSet
      description: Set of flow type configurations for a platform (update version)
      type: object
      properties:
        unknown:
          $ref: '#/components/schemas/UpdateFlowTypeConfiguration'
        scheme:
          $ref: '#/components/schemas/UpdateFlowTypeConfiguration'
        embedded:
          $ref: '#/components/schemas/UpdateFlowTypeConfiguration'
        copy:
          $ref: '#/components/schemas/UpdateFlowTypeConfiguration'
        roaming_auth:
          $ref: '#/components/schemas/UpdateFlowTypeConfiguration'
        android_autofill:
          $ref: '#/components/schemas/UpdateFlowTypeConfiguration'
        android_accessibility:
          $ref: '#/components/schemas/UpdateFlowTypeConfiguration'
        pipe:
          $ref: '#/components/schemas/UpdateFlowTypeConfiguration'
        localhost:
          $ref: '#/components/schemas/UpdateFlowTypeConfiguration'
        universal_link:
          $ref: '#/components/schemas/UpdateFlowTypeConfiguration'
        safari_extension:
          $ref: '#/components/schemas/UpdateFlowTypeConfiguration'
        layered_auth_qr_code:
          $ref: '#/components/schemas/UpdateFlowTypeConfiguration'
        secure_localhost:
          $ref: '#/components/schemas/UpdateFlowTypeConfiguration'
    FlowTypeConfiguration:
      title: FlowTypeConfiguration
      description: Configuration for a specific flow type
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether the this flow type is allowed to be used.
        valid:
          type: boolean
          description: Whether the flow type is valid and expected on a given platform
      required:
      - enabled
      - valid
    ErrorDetail:
      title: Error Detail
      description: 'Additional details for errors designed to support client applications.

        '
      type: object
      discriminator:
        propertyName: type
      properties:
        type:
          type: string
          description: Type of the error detail.
      required:
      - type
    UpdateFlowTypeConfiguration:
      title: UpdateFlowTypeConfiguration
      description: Configuration for a specific flow type (update version)
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether the customer allows this flow type to be used.
        valid:
          type: boolean
          description: Whether the flow type is valid and expected on a given platform
    UpdatePlatformFlowTypeConfig:
      title: UpdatePlatformFlowTypeConfig
      description: Platform-specific flow type configurations for updates
      type: object
      properties:
        android:
          $ref: '#/components/schemas/UpdateFlowTypeSet'
        macos:
          $ref: '#/components/schemas/UpdateFlowTypeSet'
        ios:
          $ref: '#/components/schemas/UpdateFlowTypeSet'
        windows:
          $ref: '#/components/schemas/UpdateFlowTypeSet'
        web:
          $ref: '#/components/schemas/UpdateFlowTypeSet'
        linux:
          $ref: '#/components/schemas/UpdateFlowTypeSet'
        chromeos:
          $ref: '#/components/schemas/UpdateFlowTypeSet'
        chromeosweb:
          $ref: '#/components/schemas/UpdateFlowTypeSet'
    FlowTypeConfig:
      title: FlowTypeConfig
      description: Flow type configuration for a tenant
      type: object
      properties:
        id:
          type: string
          description: 'ID of the flow type configuration. This is automatically generated on creation. This field is immutable and output-only.

            '
          minLength: 1
          readOnly: true
        tenant_id:
          type: string
          description: ID of the tenant this configuration belongs to
          readOnly: true
        realm_id:
          type: string
          description: ID of the realm this configuration belongs to
          readOnly: true
        create_time:
          type: string
          format: date-time
          description: Timestamp when the flow type configuration was created
          readOnly: true
        update_time:
          type: string
          format: date-time
          description: Timestamp when the flow type configuration was last updated
          readOnly: true
        platform_config:
          $ref: '#/components/schemas/PlatformFlowTypeConfig'
      required:
      - id
      - tenant_id
      - realm_id
      - create_time
      - update_time
      - platform_config
    Error:
      type: object
      properties:
        code:
          type: string
          description: 'Human-readable HTTP status code name, stylized as lower snake case (e.g. bad_request).

            '
        message:
          type: string
          description: 'Human-readable message describing the error.

            '
        details:
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetail'
      required:
      - code
      - message
    PlatformFlowTypeConfig:
      title: PlatformFlowTypeConfig
      description: Platform-specific flow type configurations
      type: object
      properties:
        android:
          $ref: '#/components/schemas/FlowTypeSet'
        macos:
          $ref: '#/components/schemas/FlowTypeSet'
        ios:
          $ref: '#/components/schemas/FlowTypeSet'
        windows:
          $ref: '#/components/schemas/FlowTypeSet'
        web:
          $ref: '#/components/schemas/FlowTypeSet'
        linux:
          $ref: '#/components/schemas/FlowTypeSet'
        chromeos:
          $ref: '#/components/schemas/FlowTypeSet'
        chromeosweb:
          $ref: '#/components/schemas/FlowTypeSet'
      required:
      - android
      - macos
      - ios
      - windows
      - web
      - linux
      - chromeos
      - chromeosweb
    FlowTypeSet:
      title: FlowTypeSet
      description: Set of flow type configurations for a platform
      type: object
      properties:
        unknown:
          $ref: '#/components/schemas/FlowTypeConfiguration'
        scheme:
          $ref: '#/components/schemas/FlowTypeConfiguration'
        embedded:
          $ref: '#/components/schemas/FlowTypeConfiguration'
        copy:
          $ref: '#/components/schemas/FlowTypeConfiguration'
        roaming_auth:
          $ref: '#/components/schemas/FlowTypeConfiguration'
        android_autofill:
          $ref: '#/components/schemas/FlowTypeConfiguration'
        android_accessibility:
          $ref: '#/components/schemas/FlowTypeConfiguration'
        pipe:
          $ref: '#/components/schemas/FlowTypeConfiguration'
        localhost:
          $ref: '#/components/schemas/FlowTypeConfiguration'
        universal_link:
          $ref: '#/components/schemas/FlowTypeConfiguration'
        safari_extension:
          $ref: '#/components/schemas/FlowTypeConfiguration'
        layered_auth_qr_code:
          $ref: '#/components/schemas/FlowTypeConfiguration'
        secure_localhost:
          $ref: '#/components/schemas/FlowTypeConfiguration'
      required:
      - unknown
      - scheme
      - embedded
      - copy
      - roaming_auth
      - android_autofill
      - android_accessibility
      - pipe
      - localhost
      - universal_link
      - safari_extension
      - layered_auth_qr_code
      - secure_localhost
  parameters:
    realm_id:
      name: realm_id
      in: path
      description: A unique identifier for a realm.
      required: true
      schema:
        type: string
        example: 19a95130480dfa79
    tenant_id:
      name: tenant_id
      in: path
      description: A unique identifier for a tenant.
      required: true
      schema:
        type: string
        example: 000176d94fd7b4d1
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'See the [Authentication](#section/Authentication) section for details.

        '