Skip to content

Commit

Permalink
Merge pull request #22 from logzio/documentation/1password-api-usage
Browse files Browse the repository at this point in the history
Update 1Password API usage guideline
  • Loading branch information
ralongit authored Oct 13, 2024
2 parents 6bd2261 + 81487b9 commit e1aa462
Showing 1 changed file with 33 additions and 7 deletions.
40 changes: 33 additions & 7 deletions src/apis/onepassword/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,46 @@ By default `1password` API type has built in pagination settings and sets the `r


## Example
```Yaml
You can customize the endpoints to collect data from by adding extra API configurations under `apis`. 1Password API Docs can be found [here](https://developer.1password.com/docs/connect/connect-api-reference/).

Example configuration:

```yaml
apis:
- name: 1Password example
- name: 1Password Audit Events
type: 1password
onepassword_bearer_token: <<1PASSWORD_BEARER_TOKEN>>
url: https://events.1password.com/api/v1/auditevents
method: POST
days_back_fetch: 3
days_back_fetch: 7
scrape_interval: 5
additional_fields:
type: 1password
eventType: auditevents

- name: 1Password Item Usages
type: 1password
onepassword_bearer_token: <<1PASSWORD_BEARER_TOKEN>>
url: https://events.1password.com/api/v1/itemusages
method: POST
days_back_fetch: 7
scrape_interval: 5
additional_fields:
type: 1password
eventType: itemusages

- name: 1Password Sign In Attempts
type: 1password
onepassword_bearer_token: <<1PASSWORD_BEARER_TOKEN>>
url: https://events.1password.com/api/v1/signinattempts
method: POST
days_back_fetch: 7
scrape_interval: 5
additional_fields:
type: 1password
onepassword_limit: 200
eventType: signinattempts

logzio:
url: https://listener-eu.logz.io:8071 # for us-east-1 region delete url param (default)
token: <<SHIPPING_TOKEN>>
```
url: https://<<LISTENER-HOST>>:8071
token: <<LOG-SHIPPING-TOKEN>>
```

0 comments on commit e1aa462

Please sign in to comment.