Skip to content

Commit

Permalink
docs: add nativeAuth instantiating option
Browse files Browse the repository at this point in the history 
Signed-off-by: Kipras Melnikovas <[email protected]>
  • Loading branch information
@kiprasmel
kiprasmel committed Feb 5, 2021
1 parent f1f3c98 commit f44df2a
Showing 1 changed file with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -132,20 +132,21 @@ const api = new Gitlab({

Available instantiating options:

| Name | Optional | Default | Description |
| -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| `host` | Yes | `https://gitlab.com` | Gitlab Instance Host URL |
| `token` | No\* | N/A | Personal Token. Required (one of the three tokens are required) |
| `oauthToken` | No\* | N/A | OAuth Token. Required (one of the three tokens are required) |
| `jobToken` | No\* | N/A | CI Job Token. Required (one of the three tokens are required) |
| `rejectUnauthorized` | Yes | `true` | Http Certificate setting, Only applies to HTTPS hosts urls |
| `sudo` | Yes | `false` | [Sudo](https://docs.gitlab.com/ee/api/#sudo) query parameter |
| `version` | Yes | `4` | API Version ID |
| `camelize` | Yes | `false` | Camelizes all response body keys |
| `requester` | Yes\* | @gitbeaker/node & @gitbeaker/cli : Got-based, @gitbeaker/browser: Ky-based. The @gitbeaker/core package **does not** have a default and thus must be set explicitly | Request Library Wrapper | |
| `requestTimeout` | Yes | `300000` | Request Library Timeout in ms |
| `profileToken` | Yes | N/A | [Requests Profiles Token](https://docs.gitlab.com/ee/administration/monitoring/performance/request_profiling.html) |
| `profileMode` | Yes | `execution` | [Requests Profiles Token](https://docs.gitlab.com/ee/administration/monitoring/performance/request_profiling.html) |
| Name | Optional | Default | Description |
| -------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| `host` | Yes | `https://gitlab.com` | Gitlab Instance Host URL |
| `token` | No\* | N/A | Personal Token. Required (one of the four tokens are required) |
| `oauthToken` | No\* | N/A | OAuth Token. Required (one of the four tokens are required) |
| `jobToken` | No\* | N/A | CI Job Token. Required (one of the four tokens are required) |
| `nativeAuth` | No\* | <pre>{<br> "gitlabSessionCookieKey": "\_gitlab_session",<br> "gitlabSessionCookieValue": undefined,<br> "gitlabCSRFTokenKey": "authenticity_token",<br> "gitlabCSRFTokenValue": undefined<br> }</pre> | Browser-native auth object. `undefined` values required (one of the four tokens are required) |
| `rejectUnauthorized` | Yes | `true` | Http Certificate setting, Only applies to HTTPS hosts urls |
| `sudo` | Yes | `false` | [Sudo](https://docs.gitlab.com/ee/api/#sudo) query parameter |
| `version` | Yes | `4` | API Version ID |
| `camelize` | Yes | `false` | Camelizes all response body keys |
| `requester` | Yes\* | @gitbeaker/node & @gitbeaker/cli : Got-based, @gitbeaker/browser: Ky-based. The @gitbeaker/core package **does not** have a default and thus must be set explicitly | Request Library Wrapper | |
| `requestTimeout` | Yes | `300000` | Request Library Timeout in ms |
| `profileToken` | Yes | N/A | [Requests Profiles Token](https://docs.gitlab.com/ee/administration/monitoring/performance/request_profiling.html) |
| `profileMode` | Yes | `execution` | [Requests Profiles Token](https://docs.gitlab.com/ee/administration/monitoring/performance/request_profiling.html) |

### CLI Support

Expand Down

0 comments on commit f44df2a

Please sign in to comment.