openapi: 3.0.0
info:
  title: Sumo Logic accessKeyManagement oauthManagement API
  description: "# Getting Started\nWelcome to the Sumo Logic API reference. You can use these APIs to interact with the Sumo Logic platform. For information on Collector and Search Job APIs, see our [API home page](https://help.sumologic.com/docs/api).\n## API Endpoints\nSumo Logic has several deployments in different geographic locations. You'll need to use the Sumo Logic API endpoint corresponding to your geographic location. See the table below for the different API endpoints by deployment. For details determining your account's deployment, see [API endpoints](https://help.sumologic.com/?cid=3011).\n\n  <table>\n    <tr>\n      <td> <strong>Deployment</strong> </td>\n      <td> <strong>Endpoint</strong> </td>\n    </tr>\n    <tr>\n      <td> AU </td>\n      <td> https://api.au.sumologic.com/api/ </td>\n    </tr>\n    <tr>\n      <td> CA </td>\n      <td> https://api.ca.sumologic.com/api/ </td>\n    </tr>\n    <tr>\n      <td> DE </td>\n      <td> https://api.de.sumologic.com/api/ </td>\n    </tr>\n    <tr>\n      <td> EU </td>\n      <td> https://api.eu.sumologic.com/api/ </td>\n    </tr>\n    <tr>\n      <td> FED </td>\n      <td> https://api.fed.sumologic.com/api/ </td>\n    </tr>\n    <tr>\n      <td> IN </td>\n      <td> https://api.in.sumologic.com/api/ </td>\n    </tr>\n    <tr>\n      <td> JP </td>\n      <td> https://api.jp.sumologic.com/api/ </td>\n    </tr>\n    <tr>\n      <td> KR </td>\n      <td> https://api.kr.sumologic.com/api/ </td>\n    </tr>\n    <tr>\n      <td> US1 </td>\n      <td> https://api.sumologic.com/api/ </td>\n    </tr>\n    <tr>\n      <td> US2 </td>\n      <td> https://api.us2.sumologic.com/api/ </td>\n    </tr>\n  </table>\n\n## Authentication\nSumo Logic supports the following options for API authentication:\n- Access ID and Access Key\n- Base64 encoded Access ID and Access Key\n\nSee [Access Keys](https://help.sumologic.com/docs/manage/security/access-keys) to generate an Access Key. Make sure to copy the key you create, because it is displayed only once.\nWhen you have an Access ID and Access Key you can execute requests such as the following:\n  ```bash\n  curl -u \"<accessId>:<accessKey>\" -X GET https://api.<deployment>.sumologic.com/api/v1/users\n  ```\n\nWhere `deployment` is either `au`, `ca`, `de`, `eu`, `fed`, `in`, `jp`, `us1`, or `us2`. See [API endpoints](#section/API-Endpoints) for details.\n\nIf you prefer to use basic access authentication, you can do a Base64 encoding of your `<accessId>:<accessKey>` to authenticate your HTTPS request. The following is an example request, replace the placeholder `<encoded>` with your encoded Access ID and Access Key string:\n  ```bash\n  curl -H \"Authorization: Basic <encoded>\" -X GET https://api.<deployment>.sumologic.com/api/v1/users\n  ```\n\n\nRefer to [API Authentication](https://help.sumologic.com/?cid=3012) for a Base64 example.\n\n## Status Codes\nGeneric status codes that apply to all our APIs. See the [HTTP status code registry](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml) for reference.\n  <table>\n    <tr>\n      <td> <strong>HTTP Status Code</strong> </td>\n      <td> <strong>Error Code</strong> </td>\n      <td> <strong>Description</strong> </td>\n    </tr>\n    <tr>\n      <td> 301 </td>\n      <td> moved </td>\n      <td> The requested resource SHOULD be accessed through returned URI in Location Header. See [troubleshooting](https://help.sumologic.com/docs/api/troubleshooting/#api---301-error---moved) for details.</td>\n    </tr>\n    <tr>\n      <td> 401 </td>\n      <td> unauthorized </td>\n      <td> Credential could not be verified.</td>\n    </tr>\n    <tr>\n      <td> 403 </td>\n      <td> forbidden </td>\n      <td> This operation is not allowed for your account type or the user doesn't have the role capability to perform this action. See [troubleshooting](https://help.sumologic.com/docs/api/troubleshooting/#api---401-error---credential-could-not-be-verified) for details.</td>\n    </tr>\n    <tr>\n      <td> 404 </td>\n      <td> notfound </td>\n      <td> Requested resource could not be found. </td>\n    </tr>\n    <tr>\n      <td> 405 </td>\n      <td> method.unsupported </td>\n      <td> Unsupported method for URL. </td>\n    </tr>\n    <tr>\n      <td> 415 </td>\n      <td> contenttype.invalid </td>\n      <td> Invalid content type. </td>\n    </tr>\n    <tr>\n      <td> 429 </td>\n      <td> rate.limit.exceeded </td>\n      <td> The API request rate is higher than 4 request per second or inflight API requests are higher than 10 request per second. </td>\n    </tr>\n    <tr>\n      <td> 500 </td>\n      <td> internal.error </td>\n      <td> Internal server error. </td>\n    </tr>\n    <tr>\n      <td> 503 </td>\n      <td> service.unavailable </td>\n      <td> Service is currently unavailable. </td>\n    </tr>\n  </table>\n\n## Filtering\nSome API endpoints support filtering results on a specified set of fields. Each endpoint that supports filtering will list the fields that can be filtered. Multiple fields can be combined by using an ampersand `&` character.\n\nExample: To get user with email `john@demo.com`:\n  ```bash\n  api.sumologic.com/v1/users?email=john@demo.com\n  ```\n\n## Sorting\nSome API endpoints support sorting fields by using the `sortBy` query parameter. The default sort order is ascending. Prefix the field with a minus sign `-` to sort in descending order.\n\nFor example, to get 20 users sorted by their `email` in descending order:\n  ```bash\n  api.sumologic.com/v1/users?limit=20&sort=-email\n  ```\n\n## Asynchronous Request\nAsynchronous requests do not wait for results, instead they immediately respond back with a job identifier while the job runs in the background. You can use the job identifier to track the status of the asynchronous job request. Here is a typical flow for an asynchronous request.\n1. Start an asynchronous job. On success, a job identifier is returned. The job identifier uniquely identifies\n  your asynchronous job.\n\n2. Once started, use the job identifier from step 1 to track the status of your asynchronous job. An asynchronous\n  request will typically provide an endpoint to poll for the status of asynchronous job. A successful response\n  from the status endpoint will have the following structure:\n  ```json\n  {\n      \"status\": \"Status of asynchronous request\",\n      \"statusMessage\": \"Optional message with additional information in case request succeeds\",\n      \"error\": \"Error object in case request fails\"\n  }\n  ```\n  The `status` field can have one of the following values:\n    1. `Success`: The job succeeded. The `statusMessage` field might have additional information.\n    2. `InProgress`: The job is still running.\n    3. `Failed`: The job failed. The `error` field in the response will have more information about the failure.\n\n3. Some asynchronous APIs may provide a third endpoint (like [export result](#operation/getAsyncExportResult))\n  to fetch the result of an asynchronous job.\n\n\n### Example\nLet's say we want to export a folder with the identifier `0000000006A2E86F`. We will use the [async export](#operation/beginAsyncExport) API to export all the content under the folder with `id=0000000006A2E86F`.\n1. Start an export job for the folder\n  ```bash\n  curl -X POST -u \"<accessId>:<accessKey>\" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export\n  ```\n  See [authentication section](#section/Authentication) for more details about `accessId`, `accessKey`, and\n  `deployment`.\n  On success, you will get back a job identifier. In the response below, `C03E086C137F38B4` is the job identifier.\n  ```bash\n  {\n      \"id\": \"C03E086C137F38B4\"\n  }\n  ```\n\n2. Now poll for the status of the asynchronous job with the [status](#operation/getAsyncExportStatus) endpoint.\n  ```bash\n  curl -X GET -u \"<accessId>:<accessKey>\" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export/C03E086C137F38B4/status\n  ```\n  You may get a response like\n  ```json\n  {\n      \"status\": \"InProgress\",\n      \"statusMessage\": null,\n      \"error\": null\n  }\n  ```\n  It implies the job is still in progress. Keep polling till the status is either `Success` or `Failed`.\n\n3. When the asynchronous job completes (`status != \"InProgress\"`), you can fetch the results with the\n  [export result](#operation/getAsyncExportResult) endpoint.\n  ```bash\n  curl -X GET -u \"<accessId>:<accessKey>\" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export/C03E086C137F38B4/result\n  ```\n\n  The asynchronous job may fail (`status == \"Failed\"`). You can look at the `error` field for more details.\n  ```json\n  {\n      \"status\": \"Failed\",\n      \"errors\": {\n          \"code\": \"content1:too_many_items\",\n          \"message\": \"Too many objects: object count(1100) was greater than limit 1000\"\n      }\n  }\n  ```\n\n\n## Rate Limiting\n* A rate limit of four API requests per second (240 requests per minute) applies to all API calls from a user.\n* A rate limit of 10 concurrent requests to any API endpoint applies to an access key.\n\nIf a rate is exceeded, a rate limit exceeded 429 status code is returned.\n\n## Generating Clients\nYou can use [OpenAPI Generator](https://openapi-generator.tech) to generate clients from the YAML file to access the API.\n\n### Using [NPM](https://www.npmjs.com/get-npm)\n1. Install [NPM package wrapper](https://github.com/openapitools/openapi-generator-cli) globally, exposing the CLI\n  on the command line:\n  ```bash\n  npm install @openapitools/openapi-generator-cli -g\n  ```\n  You can see detailed instructions [here](https://openapi-generator.tech/docs/installation#npm).\n\n2. Download the [YAML file](/docs/sumologic-api.yaml) and save it locally. Let's say the file is saved as `sumologic-api.yaml`.\n3. Use the following command to generate `python` client inside the `sumo/client/python` directory:\n  ```bash\n  openapi-generator generate -i sumologic-api.yaml -g python -o sumo/client/python\n  ```\n\n\n### Using [Homebrew](https://brew.sh/)\n1. Install OpenAPI Generator\n  ```bash\n  brew install openapi-generator\n  ```\n\n2. Download the [YAML file](/docs/sumologic-api.yaml) and save it locally. Let's say the file is saved as `sumologic-api.yaml`.\n3. Use the following command to generate `python` client side code inside the `sumo/client/python` directory:\n  ```bash\n  openapi-generator generate -i sumologic-api.yaml -g python -o sumo/client/python\n  ```\n"
  version: 1.0.0
  x-logo:
    url: ./sumologic_logo.png
servers:
- url: https://api.au.sumologic.com/api/
  description: AU deployment API server
- url: https://api.ca.sumologic.com/api/
  description: CA deployment API server
- url: https://api.de.sumologic.com/api/
  description: DE deployment API server
- url: https://api.eu.sumologic.com/api/
  description: EU deployment API server
- url: https://api.fed.sumologic.com/api/
  description: FED deployment API server
- url: https://api.jp.sumologic.com/api/
  description: JP deployment API server
- url: https://api.kr.sumologic.com/api/
  description: KR deployment API server
- url: https://api.in.sumologic.com/api/
  description: IN deployment API server
- url: https://api.sumologic.com/api/
  description: US1 deployment API server
- url: https://api.us2.sumologic.com/api/
  description: US2 deployment API server
security:
- basicAuth: []
tags:
- name: oauthManagement
  description: '** Only available to Beta customers. During Beta endpoints are subject to backwards incompatible changes. **


    APIs to manage OAuth Clients'
  x-displayName: OAuth Management (Beta)
paths:
  /v1/oauth/scopes:
    get:
      tags:
      - oauthManagement
      summary: Get All Scopes.
      description: '** Only available to Beta customers. During Beta endpoints are subject to backwards incompatible changes. **


        Get a list of all of the scopes that can be added to an oauth client.'
      operationId: listOAuthScopes
      responses:
        '200':
          description: A list of scopes that can be added to an oauth client.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScopesList'
        default:
          description: Operation failed with an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/oauth/clients:
    get:
      tags:
      - oauthManagement
      summary: List The OAuth Clients.
      description: '** Only available to Beta customers. During Beta endpoints are subject to backwards incompatible changes. **


        List all OAuth clients.'
      operationId: listOAuthClients
      parameters:
      - name: limit
        in: query
        description: Limit the number of OAuth clients returned in the response. The number of OAuth clients returned may be  less than the `limit`.
        required: false
        schema:
          maximum: 1000
          minimum: 1
          type: integer
          format: int32
          default: 100
      - name: token
        in: query
        description: Continuation token to get the next page of results. A page object with the next continuation token is  returned in the response body. Subsequent GET requests should specify the continuation token to get the  next page of results. `token` is set to null when no more pages are left.
        required: false
        schema:
          type: string
      - name: runAsId
        in: query
        description: Identifier of the service account that the OAuth Client runs as.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: A list of all OAuth clients within the organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedListOAuthClientsResult'
        default:
          description: Operation failed with an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
      - oauthManagement
      summary: Create A New OAuth Client.
      description: '** Only available to Beta customers. During Beta endpoints are subject to backwards incompatible changes. **


        Creates a new OAuth clientId and clientSecret.'
      operationId: createOAuthClient
      requestBody:
        description: Information about the new OAuth client.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OAuthClientCreateRequest'
        required: true
      responses:
        '200':
          description: The OAuth client has been created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthClientWithSecret'
        default:
          description: Operation failed with an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/oauth/clients/{clientId}:
    get:
      tags:
      - oauthManagement
      summary: Get An OAuth Client.
      description: '** Only available to Beta customers. During Beta endpoints are subject to backwards incompatible changes. **


        Get an OAuth client with the given identifier from the organization.'
      operationId: getOAuthClientById
      parameters:
      - name: clientId
        in: path
        description: Identifier of an OAuth client to return.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OAuth client object that was requested.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthClient'
        default:
          description: Operation failed with an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    put:
      tags:
      - oauthManagement
      summary: Update An OAuth Client.
      description: '** Only available to Beta customers. During Beta endpoints are subject to backwards incompatible changes. **


        Updates the properties of existing OAuth client by Id.'
      operationId: updateOAuthClient
      parameters:
      - name: clientId
        in: path
        description: The id of an OAuth client to update.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OAuthClientUpdateRequest'
        required: true
      responses:
        '200':
          description: OAuth client updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthClient'
        default:
          description: OAuth client update failed with an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      tags:
      - oauthManagement
      summary: Delete An OAuth Client.
      description: '** Only available to Beta customers. During Beta endpoints are subject to backwards incompatible changes. **


        Deletes the OAuth client with the given Id.'
      operationId: deleteOAuthClient
      parameters:
      - name: clientId
        in: path
        description: The Id of the OAuth client to delete.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: OAuth client deletion completed successfully.
        default:
          description: OAuth client deletion failed with an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/oauth/clients/{clientId}/rotate:
    put:
      tags:
      - oauthManagement
      summary: Rotate The Oauth Client Secret
      description: Generates a new secret for the oauth client that is passed in the call, keeping the same client ID.
      operationId: rotateOauthSecret
      parameters:
      - name: clientId
        in: path
        description: The ID of the oauth client to rotate the secret for.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OAuth client secret rotated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthClientWithSecret'
        default:
          description: Oauth client secret rotation failed with an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/oauth/consents:
    get:
      tags:
      - oauthManagement
      summary: List OAuth Consents.
      description: Get a list of OAuth consents within the organization. Administrators can list all consents, while others can only list consents that they have authorized.
      operationId: listOAuthConsents
      parameters:
      - name: limit
        in: query
        description: Limit the number of consents returned in the response.
        required: false
        schema:
          maximum: 10000
          minimum: 1
          type: integer
          format: int32
          default: 100
      - name: token
        in: query
        description: Continuation token to get the next page of results.
        required: false
        schema:
          type: string
      - name: authorizedUser
        in: query
        description: Filter consents by the identifier of the user who authorized the consent.
        required: false
        schema:
          type: string
      - name: clientId
        in: query
        description: Filter consents by the clientId of a registered OAuth client.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: A list of OAuth consents.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedListOAuthConsentsResult'
        default:
          description: Operation failed with an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/oauth/consents/{consentId}:
    delete:
      tags:
      - oauthManagement
      summary: Delete An OAuth Consent.
      description: Deletes the OAuth consent with the given Id.
      operationId: deleteOAuthConsent
      parameters:
      - name: consentId
        in: path
        description: The ID of the OAuth consent to delete.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: OAuth consent deletion completed successfully.
        default:
          description: OAuth consent deletion failed with an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ScopeDefinition:
      required:
      - dependsOn
      - group
      - id
      - label
      - type
      type: object
      properties:
        id:
          type: string
          description: The name of the scope.
          example: managePartitions
        label:
          type: string
          description: The UI label for the scope.
          example: Manage Partitions
        type:
          type: string
          description: Type of scope.
          example: Manage
        dependsOn:
          type: array
          description: Any scopes that are required for this scope to be enabled.
          example:
          - viewPartitions
          items:
            type: string
        group:
          required:
          - id
          - label
          type: object
          properties:
            id:
              type: string
              description: The name of the scope group
              example: dataManagement
            label:
              type: string
              description: The label for the scope group
              example: Data Management
            parentId:
              type: string
              description: The ID of the parent scope group
          description: The group that the scope belongs to.
    OAuthClientUpdateRequest:
      required:
      - description
      - disabled
      - name
      - scopes
      - type
      type: object
      properties:
        type:
          type: string
          description: Type of the object model.
        name:
          maxLength: 128
          minLength: 0
          type: string
          description: Name of the OAuth client.
          example: My OAuth Client
        description:
          maxLength: 255
          minLength: 0
          type: string
          description: Description of the OAuth client.
          example: OAuth client for data ingestion
        disabled:
          type: boolean
          description: Whether the OAuth client is disabled. Disabled OAuth clients cannot be used to authenticate users.
        scopes:
          type: array
          description: "Scopes assigned to the client.\n### Alerting\n  - adminMonitorsV2\n  - viewMonitorsV2\n  - manageMonitorsV2\n\n### Data Management\n  - manageApps\n  - viewCollectors\n  - manageCollectors\n  - viewConnections\n  - manageConnections\n  - contentAdmin\n  - viewFieldExtractionRules\n  - manageFieldExtractionRules            \n  - viewFields\n  - manageFields\n  - manageBudgets\n  - viewLibrary\n  - manageLibrary\n  - viewPartitions\n  - managePartitions \n  - manageS3DataForwarding\n  - viewScheduledViews\n  - manageScheduledViews\n  - manageTokens\n\n### Logs\n  - runLogSearch\n\n### Metrics\n  - runMetricsQuery \n\n### Reliability Management\n  - viewSlos\n  - manageSlos\n\n### Security\n  - manageAccessKeys\n  - viewPersonalAccessKeys\n  - managePersonalAccessKeys\n\n### UserManagement\n  - viewUsersAndRoles\n  - manageUsersAndRoles"
          example:
          - manageUsersAndRoles
          - viewCollectors
          items:
            type: string
      discriminator:
        propertyName: type
        mapping:
          ClientCredentialsClient: '#/components/schemas/UpdateClientCredentialsClientRequest'
          AuthorizationCodeClient: '#/components/schemas/UpdateAuthorizationCodeClientRequest'
    ScopesList:
      required:
      - data
      type: object
      properties:
        data:
          type: array
          description: List of scopes
          items:
            $ref: '#/components/schemas/ScopeDefinition'
    PaginatedListOAuthConsentsResult:
      required:
      - data
      type: object
      properties:
        data:
          type: array
          description: An array of OAuth consents.
          items:
            $ref: '#/components/schemas/OAuthConsent'
        next:
          type: string
          description: Next continuation token.
          example: GDCiRv4vebF3UWFJQ1kySXBOR3Bzh69GR0RyWm9vCtc
      description: List of OAuth consents.
    OAuthClientCreateRequest:
      required:
      - name
      - type
      type: object
      properties:
        type:
          type: string
          description: Type of the object model.
        name:
          maxLength: 128
          minLength: 0
          type: string
          description: Name of the OAuth client.
          example: My OAuth Client
        description:
          maxLength: 255
          minLength: 0
          type: string
          description: Description of the OAuth client.
          example: OAuth client for data ingestion
          default: ''
        scopes:
          type: array
          description: "Scopes assigned to the client.\n### Alerting\n  - adminMonitorsV2\n  - viewMonitorsV2\n  - manageMonitorsV2\n\n### Data Management\n  - manageApps\n  - viewCollectors\n  - manageCollectors\n  - viewConnections\n  - manageConnections\n  - contentAdmin\n  - viewFieldExtractionRules\n  - manageFieldExtractionRules            \n  - viewFields\n  - manageFields\n  - manageBudgets\n  - viewLibrary\n  - manageLibrary\n  - viewPartitions\n  - managePartitions \n  - manageS3DataForwarding\n  - viewScheduledViews\n  - manageScheduledViews\n  - manageTokens\n\n### Logs\n  - runLogSearch\n\n### Metrics\n  - runMetricsQuery \n\n### Reliability Management\n  - viewSlos\n  - manageSlos\n\n### Security\n  - manageAccessKeys\n  - viewPersonalAccessKeys\n  - managePersonalAccessKeys\n\n### UserManagement\n  - viewUsersAndRoles\n  - manageUsersAndRoles"
          example:
          - manageUsersAndRoles
          - viewCollectors
          items:
            type: string
          default: []
      discriminator:
        propertyName: type
        mapping:
          ClientCredentialsClient: '#/components/schemas/CreateClientCredentialsClientRequest'
          AuthorizationCodeClient: '#/components/schemas/CreateAuthorizationCodeClientRequest'
    OAuthClientWithSecret:
      required:
      - clientId
      - clientSecret
      - createdAt
      - createdBy
      - description
      - disabled
      - modifiedAt
      - modifiedBy
      - name
      - scopes
      - type
      type: object
      properties:
        type:
          type: string
          description: Type of the object model.
        clientId:
          type: string
          description: Identifier of the OAuth client.
          example: zVplCFHcpTDwtktBIQmFI2K6s9HEo4HAtcQD1f1M5eQ
        createdAt:
          type: string
          description: Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format.
          format: date-time
          example: 2018-10-16 09:10:00+00:00
        createdBy:
          type: string
          description: Identifier of the user who created the OAuth client.
          example: 0000000006743FDD
        modifiedAt:
          type: string
          description: Last modification timestamp in UTC.
          format: date-time
          example: 2018-10-16 09:10:00+00:00
        modifiedBy:
          type: string
          description: Identifier of the user who modified the OAuth client.
          example: 0000000006743FDD
        name:
          maxLength: 128
          minLength: 0
          type: string
          description: Name of the OAuth client.
          example: My OAuth Client
        description:
          maxLength: 255
          minLength: 0
          type: string
          description: Description of the OAuth client.
          example: OAuth client for data ingestion
        disabled:
          type: boolean
          description: Whether the OAuth client is disabled. Disabled OAuth clients cannot be used to authenticate users.
        scopes:
          type: array
          description: "Scopes assigned to the client.\n### Alerting\n  - adminMonitorsV2\n  - viewMonitorsV2\n  - manageMonitorsV2\n\n### Data Management\n  - manageApps\n  - viewCollectors\n  - manageCollectors\n  - viewConnections\n  - manageConnections\n  - contentAdmin\n  - viewFieldExtractionRules\n  - manageFieldExtractionRules            \n  - viewFields\n  - manageFields\n  - manageBudgets\n  - viewLibrary\n  - manageLibrary\n  - viewPartitions\n  - managePartitions \n  - manageS3DataForwarding\n  - viewScheduledViews\n  - manageScheduledViews\n  - manageTokens\n\n### Logs\n  - runLogSearch\n\n### Metrics\n  - runMetricsQuery \n\n### Reliability Management\n  - viewSlos\n  - manageSlos\n\n### Security\n  - manageAccessKeys\n  - viewPersonalAccessKeys\n  - managePersonalAccessKeys\n\n### UserManagement\n  - viewUsersAndRoles\n  - manageUsersAndRoles"
          example:
          - manageUsersAndRoles
          - viewCollectors
          items:
            type: string
        clientSecret:
          type: string
          description: The client secret for the created OAuth Client.
          example: EqyuIvsnae0LnMC2mbJArysXcmp0LuBsRgmyeLtSkFPEzSxdvpYQMDajn_8buaDj
      discriminator:
        propertyName: type
        mapping:
          ClientCredentialsClient: '#/components/schemas/ClientCredentialsClientWithSecret'
          AuthorizationCodeClient: '#/components/schemas/AuthorizationCodeClientWithSecret'
    ErrorDescription:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
          description: An error code describing the type of error.
          example: auth:password_too_short
        message:
          type: string
          description: A short English-language description of the error.
          example: Your password was too short.
        detail:
          type: string
          description: An optional fuller English-language description of the error.
          example: Your password was 5 characters long, the minimum length is 12 characters. See http://example.com/password for more information.
        meta:
          type: object
          description: An optional list of metadata about the error.
          example:
            minLength: 12
            actualLength: 5
    PaginatedListOAuthClientsResult:
      required:
      - data
      type: object
      properties:
        data:
          type: array
          description: An array of OAuth clients.
          items:
            $ref: '#/components/schemas/OAuthClient'
        next:
          type: string
          description: Next continuation token.
          example: GDCiRv4vebF3UWFJQ1kySXBOR3Bzh69GR0RyWm9vCtc
      description: List of OAuth clients.
    ErrorResponse:
      required:
      - errors
      - id
      type: object
      properties:
        id:
          type: string
          description: An identifier for the error; this is unique to the specific API request.
          example: IUUQI-DGH5I-TJ045
        errors:
          type: array
          description: A list of one or more causes of the error.
          example:
          - code: auth:password_too_short
            message: Your password was too short.
          - code: auth:password_character_classes
            message: Your password did not contain any non-alphanumeric characters
          items:
            $ref: '#/components/schemas/ErrorDescription'
    OAuthConsent:
      required:
      - authorizedAt
      - authorizedUser
      - clientId
      - clientName
      - id
      - scopes
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the consent.
          example: 0000000006743FDE
        clientId:
          type: string
          description: The ID of the registered client that was used in granting consent.
          example: zVplCFHcpTDwtktBIQmFI2K6s9HEo4HAtcQD1f1M5eQ
        clientName:
          type: string
          description: The name of the registered client that was used in granting consent.
          example: My OAuth App
        authorizedAt:
          type: string
          description: Timestamp when the consent was authorized in UTC in RFC3339 format.
          format: date-time
          example: 2018-10-16 09:10:00+00:00
        authorizedUser:
          type: string
          description: Identifier of the user who authorized the consent.
          example: 0000000006743FDD
        lastUsedAt:
          type: string
          description: Timestamp when the consent was last used to grant an access token in UTC in RFC3339 format. Null if never used.
          format: date-time
          example: 2018-10-16 09:10:00+00:00
        scopes:
          type: array
          description: The scopes that were granted in the consent.
          example:
          - manageUsersAndRoles
          - viewCollectors
          items:
            type: string
      description: An OAuth consent granted by a user.
    OAuthClient:
      required:
      - clientId
      - createdAt
      - createdBy
      - description
      - disabled
      - modifiedAt
      - modifiedBy
      - name
      - scopes
      - type
      type: object
      properties:
        type:
          type: string
          description: Type of the object model.
        clientId:
          type: string
          description: Identifier of the OAuth client.
          example: zVplCFHcpTDwtktBIQmFI2K6s9HEo4HAtcQD1f1M5eQ
        createdAt:
          type: string
          description: Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format.
          format: date-time
          example: 2018-10-16 09:10:00+00:00
        createdBy:
          type: string
          description: Identifier of the user who created the OAuth client.
          example: 0000000006743FDD
        modifiedAt:
          type: string
          description: Last modification timestamp in UTC.
          format: date-time
          example: 2018-10-16 09:10:00+00:00
        modifiedBy:
          type: string
          description: Identifier of the user who modified the OAuth client.
          example: 0000000006743FDD
        name:
          maxLength: 128
          minLength: 0
          type: string
          description: Name of the OAuth client.
          example: My OAuth Client
        description:
          maxLength: 255
          minLength: 0
          type: string
          description: Description of the OAuth client.
          example: OAuth client for data ingestion
        disabled:
          type: boolean
          description: Whether the OAuth client is disabled. Disabled OAuth clients cannot be used to authenticate users.
        scopes:
          type: array
          description: "Scopes assigned to the client.\n### Alerting\n  - adminMonitorsV2\n  - viewMonitorsV2\n  - manageMonitorsV2\n\n### Data Management\n  - manageApps\n  - viewCollectors\n  - manageCollectors\n  - viewConnections\n  - manageConnections\n  - contentAdmin\n  - viewFieldExtractionRules\n  - manageFieldExtractionRules            \n  - viewFields\n  - manageFields\n  - manageBudgets\n  - viewLibrary\n  - manageLibrary\n  - viewPartitions\n  - managePartitions \n  - manageS3DataForwarding\n  - viewScheduledViews\n  - manageScheduledViews\n  - manageTokens\n\n### Logs\n  - runLogSearch\n\n### Metrics\n  - runMetricsQuery \n\n### Reliability Management\n  - viewSlos\n  - manageSlos\n\n### Security\n  - manageAccessKeys\n  - viewPersonalAccessKeys\n  - managePersonalAccessKeys\n\n### UserManagement\n  - viewUsersAndRoles\n  - manageUsersAndRoles"
          example:
          - manageUsersAndRoles
          - viewCollectors
          items:
            type: string
      discriminator:
        propertyName: type
        mapping:
          ClientCredentialsClient: '#/components/schemas/ClientCredentialsClient'
          AuthorizationCodeClient: '#/components/schemas/AuthorizationCodeClient'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
x-tagGroups:
- name: Archive Management
  tags:
  - archiveManagement
- name: Health Events
  tags:
  - healthEvents
- name: Infrequent Data Tier
  tags:
  - logSearchesEstimatedUsage
- name: Ingest Budgets Management V2
  tags:
  - ingestBudgetManagementV2
- name: Library Management
  tags:
  - appManagement
  - appManagementV2
  - contentManagement
  - dashboardManagement
  - folderManagement
  - lookupManagement
  - contentPermissions
  - logSearchesManagement
  - parsersLibraryManagement
- name: Metrics
  tags:
  - metricsSearchesManagement
  - transformationRuleManagement
  - metricsQuery
  - metricsSearchesManagementV2
- name: Security Management
  tags:
  - accessKeyManagement
  - oauthManagement
  - accountManagement
  - passwordPolicy
  - policiesManagement
  - samlConfigurationManagement
  - serviceAllowlistManagement
  - serviceAccountManagement
  - scimUserManagement
- name: Organizations Management
  tags:
  - orgsManagement
- name: Settings Management
  tags:
  - connectionManagement
  - dynamicParsingRuleManagement
  - extractionRuleManagement
  - fieldManagementV1
  - partitionManagement
  - scheduledViewManagement
  - logsDataForwardingManagement
  - dataDeletionRules
- name: Tokens Management
  tags:
  - tokensLibraryManagement
- name: Tracing
  tags:
  - traces
  - spanAnalytics
  - serviceMap
- name: Users and Roles Management
  tags:
  - roleManagement
  - roleManagementV2
  - userManagement
- name: Threat Intel Ingest Management
  tags:
  - threatIntelIngest
  - threatIntelIngestProducer
- name: OpenTelemetry Collector Management
  tags:
  - otCollectorManagementExternal
- name: Source Template Management
  tags:
  - sourceTemplateManagementExternal
- name: Schema Base Management
  tags:
  - schemaBaseManagement
- name: Event Analytics Management
  tags:
  - eventAnalytics
- name: Budget Management
  tags:
  - budgetManagement
- name: Macro Management
  tags:
  - macroManagement
- name: Muting Schedules Management
  tags:
  - mutingSchedulesLibraryManagement
- name: SLO Management
  tags:
  - slosLibraryManagement
- name: Monitor Management
  tags:
  - monitorsLibraryManagement