[GitLab.com Silver and above](https://about.gitlab.com/pricing/) provides an [SCIM API](scim.md) that implements [the RFC7644 protocol](https://tools.ietf.org/html/rfc7644) and provides
[GitLab.com Silver and above](https://about.gitlab.com/pricing/) provides an [SCIM API](scim.md) that implements [the RFC7644 protocol](https://tools.ietf.org/html/rfc7644) and provides
the `/Users` endpoint. The base URL is: `/api/scim/v2/groups/:group_path/Users/`.
the `/Users` endpoint. The base URL is: `/api/scim/v2/groups/:group_path/Users/`.
The API uses JSON to serialize data. You don't need to specify `.json` at the
The API uses JSON to serialize data. You don't need to specify `.json` at the
end of an API URL.
end of an API URL.
All of the API endpoints that use the `POST`, `PUT` or `PATCH` method support params in the request body, with `Content-Type``application/x-www-form-urlencoded`, `multipart/form-data` or `application/json`.
## Authentication
## Authentication
Most API requests require authentication, or will only return public data when
Most API requests require authentication, or will only return public data when
Search the expression within the specified scope. Currently these scopes are supported: projects, issues, merge_requests, milestones, snippet_titles, snippet_blobs, users.
Search the expression within the specified scope. Currently these scopes are supported: projects, issues, merge_requests, milestones, snippet_titles, snippet_blobs, users.
If Elasticsearch is enabled additional scopes available are blobs, wiki_blobs and commits. Find more about [the feature](../integration/elasticsearch.md).
If Elasticsearch is enabled additional scopes available are blobs, wiki_blobs and commits. Find more about [the feature](../integration/elasticsearch.md).**[STARTER]**
The response depends on the requested scope.
The response depends on the requested scope.
...
@@ -283,9 +283,9 @@ Example response:
...
@@ -283,9 +283,9 @@ Example response:
]
]
```
```
### Scope: wiki_blobs
### Scope: wiki_blobs **[STARTER]**
This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled.
This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled.
```bash
```bash
curl --request GET --header"PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/search?scope=wiki_blobs&search=bye
curl --request GET --header"PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/search?scope=wiki_blobs&search=bye
...
@@ -308,7 +308,7 @@ Example response:
...
@@ -308,7 +308,7 @@ Example response:
]
]
```
```
### Scope: commits
### Scope: commits **[STARTER]**
This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled.
This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled.
...
@@ -341,7 +341,7 @@ Example response:
...
@@ -341,7 +341,7 @@ Example response:
]
]
```
```
### Scope: blobs
### Scope: blobs **[STARTER]**
This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled.
This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled.
...
@@ -414,7 +414,7 @@ GET /groups/:id/search
...
@@ -414,7 +414,7 @@ GET /groups/:id/search
Search the expression within the specified scope. Currently these scopes are supported: projects, issues, merge_requests, milestones, users.
Search the expression within the specified scope. Currently these scopes are supported: projects, issues, merge_requests, milestones, users.
If Elasticsearch is enabled additional scopes available are blobs, wiki_blobs and commits. Find more about [the feature](../integration/elasticsearch.md).
If Elasticsearch is enabled additional scopes available are blobs, wiki_blobs and commits. Find more about [the feature](../integration/elasticsearch.md).**[STARTER]**
The response depends on the requested scope.
The response depends on the requested scope.
...
@@ -616,7 +616,7 @@ Example response:
...
@@ -616,7 +616,7 @@ Example response:
]
]
```
```
### Scope: wiki_blobs
### Scope: wiki_blobs **[STARTER]**
This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled.
This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled.
...
@@ -641,7 +641,7 @@ Example response:
...
@@ -641,7 +641,7 @@ Example response:
]
]
```
```
### Scope: commits
### Scope: commits **[STARTER]**
This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled.
This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled.
...
@@ -674,7 +674,7 @@ Example response:
...
@@ -674,7 +674,7 @@ Example response:
]
]
```
```
### Scope: blobs
### Scope: blobs **[STARTER]**
This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled.
This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled.
...
@@ -744,7 +744,6 @@ GET /projects/:id/search
...
@@ -744,7 +744,6 @@ GET /projects/:id/search
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `scope` | string | yes | The scope to search in |
| `scope` | string | yes | The scope to search in |
| `search` | string | yes | The search query |
| `search` | string | yes | The search query |
| `ref` | string | no | The name of a repository branch or tag to search on. The project's default branch is used by default. This is only applicable for scopes: commits, blobs, and wiki_blobs. |
Search the expression within the specified scope. Currently these scopes are supported: issues, merge_requests, milestones, notes, wiki_blobs, commits, blobs, users.
Search the expression within the specified scope. Currently these scopes are supported: issues, merge_requests, milestones, notes, wiki_blobs, commits, blobs, users.
...
@@ -1039,7 +1038,7 @@ Blobs searches are performed on both filenames and contents. Search results:
...
@@ -1039,7 +1038,7 @@ Blobs searches are performed on both filenames and contents. Search results:
times in the content.
times in the content.
```bash
```bash
curl --request GET --header"PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/6/search?scope=blobs&search=installation&ref=feature
curl --request GET --header"PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/6/search?scope=blobs&search=installation
```
```
Example response:
Example response:
...
@@ -1052,7 +1051,7 @@ Example response:
...
@@ -1052,7 +1051,7 @@ Example response:
"data":"```\n\n## Installation\n\nQuick start using the [pre-built",
"data":"```\n\n## Installation\n\nQuick start using the [pre-built",