openapi: 3.0.0 info: title: Sumo Logic accessKeyManagement scimUserManagement 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 \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Deployment Endpoint
AU https://api.au.sumologic.com/api/
CA https://api.ca.sumologic.com/api/
DE https://api.de.sumologic.com/api/
EU https://api.eu.sumologic.com/api/
FED https://api.fed.sumologic.com/api/
IN https://api.in.sumologic.com/api/
JP https://api.jp.sumologic.com/api/
KR https://api.kr.sumologic.com/api/
US1 https://api.sumologic.com/api/
US2 https://api.us2.sumologic.com/api/
\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 \":\" -X GET https://api..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 `:` to authenticate your HTTPS request. The following is an example request, replace the placeholder `` with your encoded Access ID and Access Key string:\n ```bash\n curl -H \"Authorization: Basic \" -X GET https://api..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 \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
HTTP Status Code Error Code Description
301 moved 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.
401 unauthorized Credential could not be verified.
403 forbidden 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.
404 notfound Requested resource could not be found.
405 method.unsupported Unsupported method for URL.
415 contenttype.invalid Invalid content type.
429 rate.limit.exceeded The API request rate is higher than 4 request per second or inflight API requests are higher than 10 request per second.
500 internal.error Internal server error.
503 service.unavailable Service is currently unavailable.
\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 \":\" https://api..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 \":\" https://api..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 \":\" https://api..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: scimUserManagement description: APIs to manage scim based users. x-displayName: SCIM User Management paths: /v1/scim/Users: get: tags: - scimUserManagement summary: List SCIM Users description: Retrieves a list of users in the SCIM system, with optional pagination operationId: listSCIMUsers parameters: - name: startIndex in: query description: The index of the first result to return. Defaults to 1 if not specified, a value less than 1 SHALL be interpreted as 1 required: false schema: minimum: 1 type: integer format: int32 default: 1 - name: count in: query description: The maximum number of results to return. Defaults to 100 required: false schema: maximum: 1000 minimum: 1 type: integer default: 100 - name: filter in: query description: Find user with the given email address required: false schema: minLength: 1 type: string example: emails.value eq "john@doe.com" - name: sortOrder in: query description: The sort order. Use "ascending" or "descending" required: false schema: type: string example: descending enum: - ascending - descending - name: sortBy in: query description: Sort the list of users by the `givenName`, `familyName`, or `emails` field required: false schema: type: string example: givenName responses: '200': description: A paginated list of users in the organization content: application/scim+json: schema: $ref: '#/components/schemas/ListSCIMUserModelsResponse' application/json: schema: $ref: '#/components/schemas/ListSCIMUserModelsResponse' default: description: Operation failed with an error content: application/scim+json: schema: $ref: '#/components/schemas/ErrorResponseScim' application/json: schema: $ref: '#/components/schemas/ErrorResponseScim' post: tags: - scimUserManagement summary: Create SCIM User description: Creates a new user in the SCIM system operationId: createSCIMUser requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/SCIMCreateUserDefinition' application/json: schema: $ref: '#/components/schemas/ListSCIMUserModelsResponse' required: true responses: '201': description: The user has been created successfully content: application/scim+json: schema: $ref: '#/components/schemas/SCIMUserModel' application/json: schema: $ref: '#/components/schemas/SCIMUserModel' default: description: Operation failed with an error content: application/scim+json: schema: $ref: '#/components/schemas/ErrorResponseScim' application/json: schema: $ref: '#/components/schemas/ErrorResponseScim' /v1/scim/Users/{id}: get: tags: - scimUserManagement summary: Get A SCIM User description: Fetches the details of a SCIM user by their unique identifier operationId: getSCIMUserById parameters: - name: id in: path description: Unique identifier of the SCIM user required: true schema: type: string responses: '200': description: User details retrieved successfully content: application/scim+json: schema: $ref: '#/components/schemas/SCIMUserModel' application/json: schema: $ref: '#/components/schemas/SCIMUserModel' default: description: Operation failed with an error content: application/scim+json: schema: $ref: '#/components/schemas/ErrorResponseScim' application/json: schema: $ref: '#/components/schemas/ErrorResponseScim' put: tags: - scimUserManagement summary: Update SCIM User description: Updates an existing user's attributes in the SCIM system operationId: updateSCIMUser parameters: - name: id in: path description: Unique identifier of the SCIM user required: true schema: type: string requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/SCIMUpdateUserDefinition' application/json: schema: $ref: '#/components/schemas/ListSCIMUserModelsResponse' required: true responses: '200': description: The user has been updated successfully content: application/scim+json: schema: $ref: '#/components/schemas/SCIMUserModel' application/json: schema: $ref: '#/components/schemas/SCIMUserModel' default: description: Operation failed with an error content: application/scim+json: schema: $ref: '#/components/schemas/ErrorResponseScim' application/json: schema: $ref: '#/components/schemas/ErrorResponseScim' delete: tags: - scimUserManagement summary: Delete SCIM User description: Deletes a SCIM user by their unique identifier operationId: deleteSCIMUserById parameters: - name: id in: path description: Unique identifier of the SCIM user to delete required: true schema: type: string responses: '204': description: User was deleted successfully default: description: Operation failed with an error content: application/scim+json: schema: $ref: '#/components/schemas/ErrorResponseScim' application/json: schema: $ref: '#/components/schemas/ErrorResponseScim' patch: tags: - scimUserManagement summary: Update SCIM User Attributes description: Updates specific attributes of an existing user in the SCIM system operationId: patchSCIMUser parameters: - name: id in: path description: Unique identifier of the SCIM user required: true schema: type: string requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/SCIMPatchUserDefinition' application/json: schema: $ref: '#/components/schemas/ListSCIMUserModelsResponse' required: true responses: '200': description: The user attributes updated successfully content: application/scim+json: schema: $ref: '#/components/schemas/SCIMUserModel' application/json: schema: $ref: '#/components/schemas/SCIMUserModel' default: description: Operation failed with an error content: application/scim+json: schema: $ref: '#/components/schemas/ErrorResponseScim' application/json: schema: $ref: '#/components/schemas/ErrorResponseScim' components: schemas: ListSCIMUserModelsResponse: type: object properties: totalResults: type: integer description: Total number of users that match the filter criteria example: 100 startIndex: minimum: 0 type: integer description: The index of the first returned result format: int32 example: 0 default: 0 itemsPerPage: type: integer description: The number of results returned in this page example: 10 Resources: type: array description: List of SCIM user resources items: $ref: '#/components/schemas/SCIMUserModel' SCIMPatchUserDefinition: required: - Operations - schemas type: object properties: schemas: type: array description: Defines the SCIM schemas for the patch operation example: - urn:ietf:params:scim:api:messages:2.0:PatchOp items: type: string Operations: type: array description: Updates one or more attributes of a SCIM resource using a sequence of operations items: type: object properties: op: pattern: (?i)^(replace|add|remove)$ type: string description: Supports 'add', 'replace' and 'remove' operations example: replace x-pattern-message: '`replace`, `add`, `remove`' path: type: string description: Attribute path to modify example: name.familyName value: type: object allOf: - type: object properties: value: type: string - type: object properties: value: type: array items: type: string SCIMCreateUserDefinition: required: - emails - name - roles - schemas - userName type: object properties: schemas: type: array description: Defines the SCIM schemas for the user example: - urn:ietf:params:scim:schemas:core:2.0:User items: type: string userName: maxLength: 64 type: string description: Unique identifier for the user (email) example: jdoe@example.com name: $ref: '#/components/schemas/NameInfo' emails: type: array description: Sumo logic accepts only one email address items: type: object properties: value: type: string format: email example: jdoe@example.com type: type: string example: work primary: type: boolean example: true default: true roles: type: array description: roles should exactly match with role names within sumologic. `roles` can be either `Array of strings` or `Array of objects` as shown in the payload. `primary` always set to 'true' as sumologic doesn't have a concept of primary/secondary roles example: - - role1 - role2 - - value: role1 primary: true - value: role2 primary: true items: {} ErrorResponseScim: required: - schemas - status type: object properties: status: type: integer description: The HTTP status code. example: 409 schemas: type: array description: Defines the SCIM schemas for the user example: - urn:ietf:params:scim:schemas:core:2.0:User items: type: string scimType: type: string description: A SCIM detail error keyword. example: uniqueness 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. ResourceData: type: object properties: resourceType: type: string description: The name of the resource type of the resource example: User created: type: string description: Creation timestamp in date-time format format: date-time example: 2024-01-01 12:00:00+00:00 lastModified: type: string description: Last modification timestamp in date-time format format: date-time example: 2024-01-01 12:00:00+00:00 description: Resource meta data of a user NameInfo: required: - familyName - givenName type: object properties: givenName: type: string description: Given name of the user (firstName) example: John familyName: type: string description: Family name of the user (lastName) example: Doe SCIMUpdateUserDefinition: required: - active - emails - name - roles - schemas type: object properties: schemas: type: array description: Defines the SCIM schemas for the user example: - urn:ietf:params:scim:schemas:core:2.0:User items: type: string name: $ref: '#/components/schemas/NameInfo' active: type: boolean description: Indicates if the user is active example: true emails: type: array description: Sumo logic accepts only one email address items: type: object properties: value: type: string format: email example: jdoe@example.com type: type: string example: work primary: type: boolean example: true default: true roles: type: array description: roles should exactly match with role names within sumologic. `roles` can be either `Array of strings` or `Array of objects` as shown in the payload. `primary` always set to 'true' as sumologic doesn't have a concept of primary/secondary roles example: - - role1 - role2 - - value: role1 primary: true - value: role2 primary: true items: {} SCIMUserModel: type: object allOf: - $ref: '#/components/schemas/SCIMCreateUserDefinition' - required: - id properties: id: type: string description: Unique SCIM identifier for the user example: 000000000FE20FE2 active: type: boolean description: True if the user is active example: true meta: $ref: '#/components/schemas/ResourceData' 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