okta2snipe/settings.example.yaml at main · jackvaughanjr/okta2snipe · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# okta2snipe configuration
# Copy this file to settings.yaml and fill in your values.
# settings.yaml is gitignored and should never be committed.
#
# All values can be overridden with environment variables:
#   OKTA_URL    → okta.url
#   OKTA_TOKEN  → okta.api_token
#   SNIPE_URL   → snipe_it.url
#   SNIPE_TOKEN → snipe_it.api_key

okta:
  # Base URL of your Okta organization.
  # Use *.okta.com for commercial, *.okta-gov.com for Okta-Gov.
  url: "https://your-org.okta.com"

  # Okta API token with read access to users and roles (SSWS auth).
  # Generate one at: Admin → Security → API → Tokens
  api_token: ""

snipe_it:
  # Base URL of your Snipe-IT instance.
  url: "https://your-snipe-it-instance.example.com"

  # Snipe-IT API key with license management permissions.
  # Generate one at: Admin → API Keys
  api_key: ""

  # Name of the license to assign Okta seats to.
  # The license is created automatically on first run if it does not exist.
  license_name: "Okta"

  # Snipe-IT category ID to assign to the license when it is created.
  # Required. Find category IDs at: Admin → Categories, or via the Snipe-IT API.
  license_category_id: 0

  # Snipe-IT manufacturer ID to assign to the license when it is created.
  # Optional. If omitted (0), an "Okta" manufacturer is found or created
  # automatically with URL https://www.okta.com.
  license_manufacturer_id: 0

  # Snipe-IT supplier ID to assign to the license when it is created.
  # Optional. If omitted (0), no supplier is set on the license.
  license_supplier_id: 0

  # Pin to a specific license by ID instead of looking it up by name.
  # Optional. Useful if multiple licenses share the same name.
  # license_id: 42

sync:
  # Simulate a full sync without making any changes to Snipe-IT.
  # Overridden by the --dry-run flag.
  dry_run: false

  # Re-sync seat notes even if they appear up to date.
  # Overridden by the --force flag.
  force: false

  # Snipe-IT API rate limit in milliseconds between requests.
  # 500ms = 2 req/s. Increase if you encounter 429 errors.
  rate_limit_ms: 500

slack:
  # Incoming webhook URL for Slack notifications.
  # Optional. If omitted, all Slack notifications are silently skipped.
  # Notifications are sent for: sync success (with stats), sync failure
  # (with error details), and unmatched Okta users (no Snipe-IT account).
  # Notifications are suppressed during dry-run.
  # Can be overridden with the SLACK_WEBHOOK environment variable.
  webhook_url: ""