@opusdns/api 1.4.0 → 1.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/src/openapi.yaml CHANGED
@@ -9090,90 +9090,6 @@ components:
9090
9090
  - d
9091
9091
  title: PeriodUnit
9092
9092
  type: string
9093
- Permission:
9094
- enum:
9095
- - bulk_create
9096
- - bulk_delete
9097
- - bulk_renew_expire
9098
- - bulk_transfer_trade
9099
- - bulk_update
9100
- - corporate_plan
9101
- - create
9102
- - create_vanity_ns
9103
- - delete
9104
- - delete_api_keys
9105
- - delete_contacts
9106
- - delete_dns_zones
9107
- - delete_domains
9108
- - delete_domain_forwards
9109
- - delete_email_forwards
9110
- - delete_events
9111
- - delete_hosts
9112
- - delete_jobs
9113
- - delete_parking
9114
- - delete_registrar_credentials
9115
- - delete_tags
9116
- - delete_users
9117
- - enterprise_plan
9118
- - has_accepted_tos
9119
- - manage_api_keys
9120
- - manage_billing
9121
- - manage_chats
9122
- - manage_cms_content
9123
- - manage_contacts
9124
- - manage_dns_zones
9125
- - manage_domains
9126
- - manage_domain_forwards
9127
- - manage_email_forwards
9128
- - manage_events
9129
- - manage_hosts
9130
- - manage_jobs
9131
- - manage_opusdns_api_keys
9132
- - manage_parking
9133
- - manage_products
9134
- - manage_registrar_credentials
9135
- - manage_reseller
9136
- - manage_sub_zones
9137
- - manage_tags
9138
- - manage_users
9139
- - manage_user_relations
9140
- - manage_vanity_ns
9141
- - plan_manager
9142
- - premium_plan
9143
- - renew_expire
9144
- - starter_plan
9145
- - transfer_trade
9146
- - update
9147
- - update_domain_forwards
9148
- - verify
9149
- - view
9150
- - view_api_keys
9151
- - view_audit_logs
9152
- - view_billing
9153
- - view_contacts
9154
- - view_dns_zones
9155
- - view_domains
9156
- - view_domain_forwards
9157
- - view_email_forwards
9158
- - view_events
9159
- - view_hosts
9160
- - view_jobs
9161
- - view_parking
9162
- - view_registrar_credentials
9163
- - view_tags
9164
- - view_users
9165
- - view_vanity_ns
9166
- title: Permission
9167
- type: string
9168
- PermissionSet:
9169
- properties:
9170
- permissions:
9171
- items:
9172
- $ref: '#/components/schemas/Permission'
9173
- title: Permissions
9174
- type: array
9175
- title: PermissionSet
9176
- type: object
9177
9093
  PlatformStatsBucket:
9178
9094
  properties:
9179
9095
  key:
@@ -9424,6 +9340,21 @@ components:
9424
9340
  - client_secret
9425
9341
  title: PublicAuthRequestForm
9426
9342
  type: object
9343
+ PublicPermission:
9344
+ examples:
9345
+ - domains:read
9346
+ - domains:manage
9347
+ - domains:delete
9348
+ type: string
9349
+ PublicPermissionSet:
9350
+ properties:
9351
+ permissions:
9352
+ items:
9353
+ $ref: '#/components/schemas/PublicPermission'
9354
+ title: Permissions
9355
+ type: array
9356
+ title: PublicPermissionSet
9357
+ type: object
9427
9358
  PublicReportListRes:
9428
9359
  properties:
9429
9360
  pagination:
@@ -9496,6 +9427,50 @@ components:
9496
9427
  - updated_on
9497
9428
  title: PublicReportRes
9498
9429
  type: object
9430
+ PublicResource:
9431
+ enum:
9432
+ - domains
9433
+ - contacts
9434
+ - dns
9435
+ - hosts
9436
+ - email_forwards
9437
+ - domain_forwards
9438
+ - parking
9439
+ - events
9440
+ - jobs
9441
+ - billing
9442
+ - users
9443
+ - api_keys
9444
+ - registrar_credentials
9445
+ - tags
9446
+ - audit_logs
9447
+ - vanity_ns
9448
+ title: PublicResource
9449
+ type: string
9450
+ PublicRole:
9451
+ enum:
9452
+ - admin
9453
+ - viewer
9454
+ - domain_manager
9455
+ - dns_manager
9456
+ - billing_manager
9457
+ title: PublicRole
9458
+ type: string
9459
+ PublicRoleAssignment:
9460
+ properties:
9461
+ role:
9462
+ anyOf:
9463
+ - $ref: '#/components/schemas/PublicRole'
9464
+ - type: 'null'
9465
+ title: PublicRoleAssignment
9466
+ type: object
9467
+ PublicScope:
9468
+ enum:
9469
+ - read
9470
+ - manage
9471
+ - delete
9472
+ title: PublicScope
9473
+ type: string
9499
9474
  RdapBase:
9500
9475
  properties:
9501
9476
  rdap_server:
@@ -9617,71 +9592,6 @@ components:
9617
9592
  - supported
9618
9593
  title: RegistryLockBase
9619
9594
  type: object
9620
- Relation:
9621
- enum:
9622
- - accepted_tos
9623
- - root_admin
9624
- - owner
9625
- - parent
9626
- - admin
9627
- - member
9628
- - client_api_key
9629
- - opusdns_internal_api_key
9630
- - reseller_manager
9631
- - chat_manager
9632
- - domain_view
9633
- - domain_manage
9634
- - domain_delete
9635
- - contact_view
9636
- - contact_manage
9637
- - contact_delete
9638
- - dns_zone_view
9639
- - dns_zone_manage
9640
- - dns_zone_delete
9641
- - host_view
9642
- - host_manage
9643
- - host_delete
9644
- - email_forward_view
9645
- - email_forward_manage
9646
- - email_forward_delete
9647
- - domain_forward_view
9648
- - domain_forward_manage
9649
- - domain_forward_delete
9650
- - parking_view
9651
- - parking_manage
9652
- - parking_delete
9653
- - events_view
9654
- - events_manage
9655
- - events_delete
9656
- - jobs_view
9657
- - jobs_manage
9658
- - jobs_delete
9659
- - tag_view
9660
- - tag_manage
9661
- - tag_delete
9662
- - registrar_credential_view
9663
- - registrar_credential_manage
9664
- - registrar_credential_delete
9665
- - user_view
9666
- - user_manage
9667
- - user_delete
9668
- - api_key_view
9669
- - api_key_manage
9670
- - api_key_delete
9671
- - billing_view
9672
- - billing_manage
9673
- - audit_log_view
9674
- title: Relation
9675
- type: string
9676
- RelationSet:
9677
- properties:
9678
- relations:
9679
- items:
9680
- $ref: '#/components/schemas/Relation'
9681
- title: Relations
9682
- type: array
9683
- title: RelationSet
9684
- type: object
9685
9595
  RenewalMode:
9686
9596
  enum:
9687
9597
  - renew
@@ -9872,24 +9782,6 @@ components:
9872
9782
  - desc
9873
9783
  title: SortOrder
9874
9784
  type: string
9875
- SpiceDbRelationshipUpdate:
9876
- properties:
9877
- add:
9878
- anyOf:
9879
- - items:
9880
- $ref: '#/components/schemas/Relation'
9881
- type: array
9882
- - type: 'null'
9883
- title: Add
9884
- remove:
9885
- anyOf:
9886
- - items:
9887
- $ref: '#/components/schemas/Relation'
9888
- type: array
9889
- - type: 'null'
9890
- title: Remove
9891
- title: SpiceDbRelationshipUpdate
9892
- type: object
9893
9785
  StatusChanges:
9894
9786
  properties:
9895
9787
  add:
@@ -11213,7 +11105,7 @@ components:
11213
11105
  title: Username
11214
11106
  title: UserUpdate
11215
11107
  type: object
11216
- UserWithRelationPermissions:
11108
+ UserWithPermissions:
11217
11109
  properties:
11218
11110
  created_on:
11219
11111
  description: The date/time the entry was created on
@@ -11262,7 +11154,7 @@ components:
11262
11154
  permissions:
11263
11155
  anyOf:
11264
11156
  - items:
11265
- $ref: '#/components/schemas/Permission'
11157
+ $ref: '#/components/schemas/PublicPermission'
11266
11158
  type: array
11267
11159
  - type: 'null'
11268
11160
  title: Permissions
@@ -11275,13 +11167,6 @@ components:
11275
11167
  examples:
11276
11168
  - '+1.2125552368'
11277
11169
  title: Phone
11278
- relations:
11279
- anyOf:
11280
- - items:
11281
- $ref: '#/components/schemas/Relation'
11282
- type: array
11283
- - type: 'null'
11284
- title: Relations
11285
11170
  status:
11286
11171
  $ref: '#/components/schemas/UserStatus'
11287
11172
  readOnly: true
@@ -11326,7 +11211,7 @@ components:
11326
11211
  - email
11327
11212
  - locale
11328
11213
  - status
11329
- title: UserWithRelationPermissions
11214
+ title: UserWithPermissions
11330
11215
  type: object
11331
11216
  ValidationError:
11332
11217
  properties:
@@ -11652,7 +11537,7 @@ info:
11652
11537
  \n\n"
11653
11538
  summary: OpusDNS - your gateway to a seamless domain management experience.
11654
11539
  title: OpusDNS API
11655
- version: 2026-06-08-154726
11540
+ version: 2026-06-10-075045
11656
11541
  x-logo:
11657
11542
  altText: OpusDNS API Reference
11658
11543
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -12932,6 +12817,8 @@ paths:
12932
12817
  summary: Retrieve email forward logs by alias
12933
12818
  tags:
12934
12819
  - archive
12820
+ x-required-permissions:
12821
+ - email_forwards:read
12935
12822
  /v1/archive/email-forward-logs/{email_forward_id}:
12936
12823
  get:
12937
12824
  description: Retrieves a paginated list of email forward logs for a specific
@@ -13023,6 +12910,8 @@ paths:
13023
12910
  summary: Retrieve email forward logs
13024
12911
  tags:
13025
12912
  - archive
12913
+ x-required-permissions:
12914
+ - email_forwards:read
13026
12915
  /v1/archive/object-logs:
13027
12916
  get:
13028
12917
  description: Retrieve all paginated audit logs with optional filtering and sorting
@@ -13823,6 +13712,8 @@ paths:
13823
13712
  summary: List all contacts
13824
13713
  tags:
13825
13714
  - contact
13715
+ x-required-permissions:
13716
+ - contacts:read
13826
13717
  post:
13827
13718
  description: Create a new contact object to use for domain registration
13828
13719
  operationId: create_contact_v1_contacts_post
@@ -13851,6 +13742,8 @@ paths:
13851
13742
  summary: Create a contact
13852
13743
  tags:
13853
13744
  - contact
13745
+ x-required-permissions:
13746
+ - contacts:manage
13854
13747
  /v1/contacts/attribute-sets:
13855
13748
  get:
13856
13749
  operationId: list_attribute_sets_v1_contacts_attribute_sets_get
@@ -13919,6 +13812,8 @@ paths:
13919
13812
  summary: List contact attribute sets
13920
13813
  tags:
13921
13814
  - contact
13815
+ x-required-permissions:
13816
+ - contacts:read
13922
13817
  post:
13923
13818
  operationId: create_attribute_set_v1_contacts_attribute_sets_post
13924
13819
  requestBody:
@@ -13960,6 +13855,8 @@ paths:
13960
13855
  summary: Create a contact attribute set
13961
13856
  tags:
13962
13857
  - contact
13858
+ x-required-permissions:
13859
+ - contacts:manage
13963
13860
  /v1/contacts/attribute-sets/{contact_attribute_set_id}:
13964
13861
  delete:
13965
13862
  operationId: delete_attribute_set_v1_contacts_attribute_sets__contact_attribute_set_id__delete
@@ -14003,6 +13900,8 @@ paths:
14003
13900
  summary: Delete a contact attribute set
14004
13901
  tags:
14005
13902
  - contact
13903
+ x-required-permissions:
13904
+ - contacts:manage
14006
13905
  get:
14007
13906
  operationId: get_attribute_set_v1_contacts_attribute_sets__contact_attribute_set_id__get
14008
13907
  parameters:
@@ -14049,6 +13948,8 @@ paths:
14049
13948
  summary: Retrieve a contact attribute set
14050
13949
  tags:
14051
13950
  - contact
13951
+ x-required-permissions:
13952
+ - contacts:read
14052
13953
  patch:
14053
13954
  operationId: update_attribute_set_v1_contacts_attribute_sets__contact_attribute_set_id__patch
14054
13955
  parameters:
@@ -14115,6 +14016,8 @@ paths:
14115
14016
  summary: Update a contact attribute set
14116
14017
  tags:
14117
14018
  - contact
14019
+ x-required-permissions:
14020
+ - contacts:manage
14118
14021
  /v1/contacts/verification:
14119
14022
  get:
14120
14023
  operationId: get_verification_by_token_v1_contacts_verification_get
@@ -14309,6 +14212,8 @@ paths:
14309
14212
  summary: Delete a contact
14310
14213
  tags:
14311
14214
  - contact
14215
+ x-required-permissions:
14216
+ - contacts:delete
14312
14217
  get:
14313
14218
  operationId: get_contact_v1_contacts__contact_id__get
14314
14219
  parameters:
@@ -14365,6 +14270,8 @@ paths:
14365
14270
  summary: Retrieve a contact
14366
14271
  tags:
14367
14272
  - contact
14273
+ x-required-permissions:
14274
+ - contacts:read
14368
14275
  /v1/contacts/{contact_id}/link/{contact_attribute_set_id}:
14369
14276
  patch:
14370
14277
  operationId: create_attribute_link_v1_contacts__contact_id__link__contact_attribute_set_id__patch
@@ -14448,6 +14355,8 @@ paths:
14448
14355
  summary: Link a contact to a contact attribute set
14449
14356
  tags:
14450
14357
  - contact
14358
+ x-required-permissions:
14359
+ - contacts:manage
14451
14360
  /v1/contacts/{contact_id}/verification:
14452
14361
  delete:
14453
14362
  operationId: cancel_verification_v1_contacts__contact_id__verification_delete
@@ -14503,6 +14412,8 @@ paths:
14503
14412
  summary: Delete contact verification
14504
14413
  tags:
14505
14414
  - contact
14415
+ x-required-permissions:
14416
+ - contacts:manage
14506
14417
  get:
14507
14418
  operationId: get_verification_status_v1_contacts__contact_id__verification_get
14508
14419
  parameters:
@@ -14561,6 +14472,8 @@ paths:
14561
14472
  summary: Retrieve contact verification by contact ID
14562
14473
  tags:
14563
14474
  - contact
14475
+ x-required-permissions:
14476
+ - contacts:manage
14564
14477
  post:
14565
14478
  operationId: start_contact_verification_v1_contacts__contact_id__verification_post
14566
14479
  parameters:
@@ -14640,6 +14553,8 @@ paths:
14640
14553
  summary: Start contact verification
14641
14554
  tags:
14642
14555
  - contact
14556
+ x-required-permissions:
14557
+ - contacts:manage
14643
14558
  put:
14644
14559
  operationId: update_verification_v1_contacts__contact_id__verification_put
14645
14560
  parameters:
@@ -14728,6 +14643,8 @@ paths:
14728
14643
  summary: Complete contact verification by contact ID
14729
14644
  tags:
14730
14645
  - contact
14646
+ x-required-permissions:
14647
+ - contacts:manage
14731
14648
  /v1/contacts/{contact_id}/verifications:
14732
14649
  get:
14733
14650
  description: Retrieve the current verification state for a contact from the
@@ -14801,6 +14718,8 @@ paths:
14801
14718
  summary: Get contact verification status
14802
14719
  tags:
14803
14720
  - contact
14721
+ x-required-permissions:
14722
+ - contacts:read
14804
14723
  /v1/contacts/{contact_id}/verifications/attest:
14805
14724
  post:
14806
14725
  description: Submit one or more contact-verification attestations. Returns the
@@ -14895,6 +14814,8 @@ paths:
14895
14814
  summary: Attest a contact verification
14896
14815
  tags:
14897
14816
  - contact
14817
+ x-required-permissions:
14818
+ - contacts:manage
14898
14819
  /v1/dns:
14899
14820
  get:
14900
14821
  operationId: list_zones_v1_dns_get
@@ -15092,6 +15013,8 @@ paths:
15092
15013
  summary: List Zones
15093
15014
  tags:
15094
15015
  - dns
15016
+ x-required-permissions:
15017
+ - dns:read
15095
15018
  post:
15096
15019
  operationId: create_zone_v1_dns_post
15097
15020
  requestBody:
@@ -15346,6 +15269,8 @@ paths:
15346
15269
  summary: Create Zone
15347
15270
  tags:
15348
15271
  - dns
15272
+ x-required-permissions:
15273
+ - dns:manage
15349
15274
  /v1/dns/domain-forwards:
15350
15275
  get:
15351
15276
  description: Retrieves a paginated list of domain forwards grouped by DNS zones.
@@ -15465,6 +15390,8 @@ paths:
15465
15390
  summary: List domain forwards by zone
15466
15391
  tags:
15467
15392
  - dns
15393
+ x-required-permissions:
15394
+ - dns:read
15468
15395
  /v1/dns/email-forwards:
15469
15396
  get:
15470
15397
  description: Retrieves a paginated list of email forwards grouped by DNS zones.
@@ -15550,6 +15477,8 @@ paths:
15550
15477
  summary: List email forwards by zone
15551
15478
  tags:
15552
15479
  - dns
15480
+ x-required-permissions:
15481
+ - dns:read
15553
15482
  /v1/dns/summary:
15554
15483
  get:
15555
15484
  operationId: get_zones_summary_v1_dns_summary_get
@@ -15581,6 +15510,8 @@ paths:
15581
15510
  summary: Get Zones Summary
15582
15511
  tags:
15583
15512
  - dns
15513
+ x-required-permissions:
15514
+ - dns:read
15584
15515
  /v1/dns/{zone_name}:
15585
15516
  delete:
15586
15517
  operationId: delete_zone_v1_dns__zone_name__delete
@@ -15608,6 +15539,8 @@ paths:
15608
15539
  summary: Delete Zone
15609
15540
  tags:
15610
15541
  - dns
15542
+ x-required-permissions:
15543
+ - dns:delete
15611
15544
  get:
15612
15545
  operationId: get_zone_v1_dns__zone_name__get
15613
15546
  parameters:
@@ -15648,6 +15581,8 @@ paths:
15648
15581
  summary: Get Zone
15649
15582
  tags:
15650
15583
  - dns
15584
+ x-required-permissions:
15585
+ - dns:read
15651
15586
  /v1/dns/{zone_name}/dnssec/disable:
15652
15587
  post:
15653
15588
  operationId: disable_dnssec_v1_dns__zone_name__dnssec_disable_post
@@ -15734,6 +15669,8 @@ paths:
15734
15669
  summary: Disable Dnssec
15735
15670
  tags:
15736
15671
  - dns
15672
+ x-required-permissions:
15673
+ - dns:manage
15737
15674
  /v1/dns/{zone_name}/dnssec/enable:
15738
15675
  post:
15739
15676
  operationId: enable_dnssec_v1_dns__zone_name__dnssec_enable_post
@@ -15820,6 +15757,8 @@ paths:
15820
15757
  summary: Enable Dnssec
15821
15758
  tags:
15822
15759
  - dns
15760
+ x-required-permissions:
15761
+ - dns:manage
15823
15762
  /v1/dns/{zone_name}/domain-forwards:
15824
15763
  get:
15825
15764
  description: Retrieves all domain forwards configured for the specified DNS
@@ -15903,6 +15842,8 @@ paths:
15903
15842
  summary: List domain forwards for a zone
15904
15843
  tags:
15905
15844
  - dns
15845
+ x-required-permissions:
15846
+ - dns:read
15906
15847
  /v1/dns/{zone_name}/email-forwards:
15907
15848
  get:
15908
15849
  description: Retrieves all email forwards configured for the specified DNS zone,
@@ -15960,6 +15901,8 @@ paths:
15960
15901
  summary: List email forwards for a zone
15961
15902
  tags:
15962
15903
  - dns
15904
+ x-required-permissions:
15905
+ - dns:read
15963
15906
  /v1/dns/{zone_name}/records:
15964
15907
  patch:
15965
15908
  operationId: patch_zone_records_v1_dns__zone_name__records_patch
@@ -16059,6 +16002,8 @@ paths:
16059
16002
  summary: Patch Zone Records
16060
16003
  tags:
16061
16004
  - dns
16005
+ x-required-permissions:
16006
+ - dns:manage
16062
16007
  /v1/dns/{zone_name}/rrsets:
16063
16008
  patch:
16064
16009
  operationId: patch_zone_rrsets_v1_dns__zone_name__rrsets_patch
@@ -16204,6 +16149,8 @@ paths:
16204
16149
  summary: Patch Zone Rrsets
16205
16150
  tags:
16206
16151
  - dns
16152
+ x-required-permissions:
16153
+ - dns:manage
16207
16154
  put:
16208
16155
  operationId: update_zone_rrsets_v1_dns__zone_name__rrsets_put
16209
16156
  parameters:
@@ -16336,6 +16283,8 @@ paths:
16336
16283
  summary: Update Zone Rrsets
16337
16284
  tags:
16338
16285
  - dns
16286
+ x-required-permissions:
16287
+ - dns:manage
16339
16288
  /v1/domain-forwards:
16340
16289
  get:
16341
16290
  description: Retrieves a paginated list of domain forwards by hostname for the
@@ -16519,6 +16468,8 @@ paths:
16519
16468
  summary: List domain forwards
16520
16469
  tags:
16521
16470
  - domain_forward
16471
+ x-required-permissions:
16472
+ - domain_forwards:read
16522
16473
  patch:
16523
16474
  description: Applies patch operations to update or remove redirects across hostnames
16524
16475
  and protocols. Raises an error if the domain forward or domain forward set
@@ -16581,6 +16532,8 @@ paths:
16581
16532
  summary: Patch domain forward redirects
16582
16533
  tags:
16583
16534
  - domain_forward
16535
+ x-required-permissions:
16536
+ - domain_forwards:manage
16584
16537
  post:
16585
16538
  description: Creates a new domain forward configuration. Wildcard forwards can
16586
16539
  be created by using *.hostname (e.g., *.example.com).
@@ -16756,6 +16709,8 @@ paths:
16756
16709
  summary: Create a domain forward
16757
16710
  tags:
16758
16711
  - domain_forward
16712
+ x-required-permissions:
16713
+ - domain_forwards:manage
16759
16714
  /v1/domain-forwards/metrics:
16760
16715
  get:
16761
16716
  description: Retrieves overall metrics for domain forwards including total and
@@ -16874,6 +16829,8 @@ paths:
16874
16829
  summary: Get domain forward metrics
16875
16830
  tags:
16876
16831
  - domain_forward
16832
+ x-required-permissions:
16833
+ - domain_forwards:read
16877
16834
  /v1/domain-forwards/metrics/browser:
16878
16835
  get:
16879
16836
  description: Retrieves visitor traffic broken down by browser type (Chrome,
@@ -17015,6 +16972,8 @@ paths:
17015
16972
  summary: Get browser statistics
17016
16973
  tags:
17017
16974
  - domain_forward
16975
+ x-required-permissions:
16976
+ - domain_forwards:read
17018
16977
  /v1/domain-forwards/metrics/geo:
17019
16978
  get:
17020
16979
  description: Retrieves visitor traffic broken down by geographic location (country
@@ -17149,6 +17108,8 @@ paths:
17149
17108
  summary: Get geographic statistics
17150
17109
  tags:
17151
17110
  - domain_forward
17111
+ x-required-permissions:
17112
+ - domain_forwards:read
17152
17113
  /v1/domain-forwards/metrics/platform:
17153
17114
  get:
17154
17115
  description: Retrieves visitor traffic broken down by platform (Windows, Macintosh,
@@ -17288,6 +17249,8 @@ paths:
17288
17249
  summary: Get platform statistics
17289
17250
  tags:
17290
17251
  - domain_forward
17252
+ x-required-permissions:
17253
+ - domain_forwards:read
17291
17254
  /v1/domain-forwards/metrics/referrer:
17292
17255
  get:
17293
17256
  description: Retrieves visitor referral sources (where traffic came from) with
@@ -17429,6 +17392,8 @@ paths:
17429
17392
  summary: Get referrer statistics
17430
17393
  tags:
17431
17394
  - domain_forward
17395
+ x-required-permissions:
17396
+ - domain_forwards:read
17432
17397
  /v1/domain-forwards/metrics/status-code:
17433
17398
  get:
17434
17399
  description: Retrieves distribution of HTTP redirect status codes (301, 302,
@@ -17556,6 +17521,8 @@ paths:
17556
17521
  summary: Get HTTP status code statistics
17557
17522
  tags:
17558
17523
  - domain_forward
17524
+ x-required-permissions:
17525
+ - domain_forwards:read
17559
17526
  /v1/domain-forwards/metrics/time-series:
17560
17527
  get:
17561
17528
  description: Retrieves visit counts bucketed by time intervals (hourly, daily)
@@ -17729,6 +17696,8 @@ paths:
17729
17696
  summary: Get domain forward time series metrics
17730
17697
  tags:
17731
17698
  - domain_forward
17699
+ x-required-permissions:
17700
+ - domain_forwards:read
17732
17701
  /v1/domain-forwards/metrics/user-agent:
17733
17702
  get:
17734
17703
  description: Retrieves visitor traffic broken down by user agent string with
@@ -17862,6 +17831,8 @@ paths:
17862
17831
  summary: Get user agent statistics
17863
17832
  tags:
17864
17833
  - domain_forward
17834
+ x-required-permissions:
17835
+ - domain_forwards:read
17865
17836
  /v1/domain-forwards/metrics/visits-by-key:
17866
17837
  get:
17867
17838
  description: Retrieves visit metrics grouped by a specified key (url, fqdn,
@@ -18016,6 +17987,8 @@ paths:
18016
17987
  summary: Get visits grouped by key
18017
17988
  tags:
18018
17989
  - domain_forward
17990
+ x-required-permissions:
17991
+ - domain_forwards:read
18019
17992
  /v1/domain-forwards/{hostname}:
18020
17993
  delete:
18021
17994
  description: Deletes the domain forward configuration for the specified hostname
@@ -18080,6 +18053,8 @@ paths:
18080
18053
  summary: Delete a domain forward
18081
18054
  tags:
18082
18055
  - domain_forward
18056
+ x-required-permissions:
18057
+ - domain_forwards:delete
18083
18058
  get:
18084
18059
  description: Retrieves the domain forward configuration for the specified hostname
18085
18060
  operationId: get_domain_forward_v1_domain_forwards__hostname__get
@@ -18182,6 +18157,8 @@ paths:
18182
18157
  summary: Get a domain forward
18183
18158
  tags:
18184
18159
  - domain_forward
18160
+ x-required-permissions:
18161
+ - domain_forwards:read
18185
18162
  post:
18186
18163
  description: Creates a new domain forward set for a specific protocol (HTTP
18187
18164
  or HTTPS). Raises an error if the set already exists.
@@ -18286,6 +18263,8 @@ paths:
18286
18263
  summary: Create domain forward set
18287
18264
  tags:
18288
18265
  - domain_forward
18266
+ x-required-permissions:
18267
+ - domain_forwards:manage
18289
18268
  /v1/domain-forwards/{hostname}/disable:
18290
18269
  patch:
18291
18270
  description: Disables domain forwarding by removing DNS records. The domain
@@ -18340,6 +18319,8 @@ paths:
18340
18319
  summary: Disable domain forward
18341
18320
  tags:
18342
18321
  - domain_forward
18322
+ x-required-permissions:
18323
+ - domain_forwards:manage
18343
18324
  /v1/domain-forwards/{hostname}/enable:
18344
18325
  patch:
18345
18326
  description: Enables domain forwarding by creating necessary DNS records
@@ -18393,6 +18374,8 @@ paths:
18393
18374
  summary: Enable domain forward
18394
18375
  tags:
18395
18376
  - domain_forward
18377
+ x-required-permissions:
18378
+ - domain_forwards:manage
18396
18379
  /v1/domain-forwards/{hostname}/{protocol}:
18397
18380
  delete:
18398
18381
  description: Deletes a domain forward set for a specific protocol (HTTP or HTTPS).
@@ -18463,6 +18446,8 @@ paths:
18463
18446
  summary: Delete domain forward set
18464
18447
  tags:
18465
18448
  - domain_forward
18449
+ x-required-permissions:
18450
+ - domain_forwards:delete
18466
18451
  get:
18467
18452
  description: Retrieves all redirects for a specific protocol (HTTP or HTTPS)
18468
18453
  for the specified hostname
@@ -18571,6 +18556,8 @@ paths:
18571
18556
  summary: Get domain forward set
18572
18557
  tags:
18573
18558
  - domain_forward
18559
+ x-required-permissions:
18560
+ - domain_forwards:read
18574
18561
  put:
18575
18562
  description: Updates an existing domain forward set for a specific protocol
18576
18563
  (HTTP or HTTPS). All existing redirects for this protocol are replaced with
@@ -18670,6 +18657,8 @@ paths:
18670
18657
  summary: Update domain forward set
18671
18658
  tags:
18672
18659
  - domain_forward
18660
+ x-required-permissions:
18661
+ - domain_forwards:manage
18673
18662
  /v1/domain-search/suggest:
18674
18663
  get:
18675
18664
  description: Get a list of domain suggestions based on a search query
@@ -19033,6 +19022,8 @@ paths:
19033
19022
  summary: List all domains
19034
19023
  tags:
19035
19024
  - domain
19025
+ x-required-permissions:
19026
+ - domains:read
19036
19027
  post:
19037
19028
  description: 'Registers a new domain.
19038
19029
 
@@ -19150,6 +19141,8 @@ paths:
19150
19141
  summary: Create a domain
19151
19142
  tags:
19152
19143
  - domain
19144
+ x-required-permissions:
19145
+ - domains:manage
19153
19146
  /v1/domains/check:
19154
19147
  get:
19155
19148
  description: 'Performs a real-time check against the authoritative registry
@@ -19237,6 +19230,8 @@ paths:
19237
19230
  summary: Check domain availability and registration metadata
19238
19231
  tags:
19239
19232
  - domain
19233
+ x-required-permissions:
19234
+ - domains:read
19240
19235
  /v1/domains/claims-notices:
19241
19236
  post:
19242
19237
  description: Retrieves the trademark claims notice for a `claims_key` returned
@@ -19296,6 +19291,8 @@ paths:
19296
19291
  summary: Retrieve claims notices from claim keys
19297
19292
  tags:
19298
19293
  - domain
19294
+ x-required-permissions:
19295
+ - domains:manage
19299
19296
  /v1/domains/summary:
19300
19297
  get:
19301
19298
  description: Retrieves a summary of domains including counts by status, TLD,
@@ -19320,6 +19317,8 @@ paths:
19320
19317
  summary: Get domain summary
19321
19318
  tags:
19322
19319
  - domain
19320
+ x-required-permissions:
19321
+ - domains:read
19323
19322
  /v1/domains/tld-specific/at/{domain_reference}/withdraw:
19324
19323
  post:
19325
19324
  operationId: withdraw_domain_v1_domains_tld_specific_at__domain_reference__withdraw_post
@@ -19376,6 +19375,8 @@ paths:
19376
19375
  tags:
19377
19376
  - domain
19378
19377
  - domain_tld_specific
19378
+ x-required-permissions:
19379
+ - domains:manage
19379
19380
  /v1/domains/tld-specific/be/{domain_reference}/auth_code/request:
19380
19381
  post:
19381
19382
  operationId: request_auth_code_v1_domains_tld_specific_be__domain_reference__auth_code_request_post
@@ -19440,6 +19441,8 @@ paths:
19440
19441
  tags:
19441
19442
  - domain
19442
19443
  - domain_tld_specific
19444
+ x-required-permissions:
19445
+ - domains:manage
19443
19446
  /v1/domains/tld-specific/de/{domain_reference}/transit:
19444
19447
  post:
19445
19448
  operationId: transit_domain_v1_domains_tld_specific_de__domain_reference__transit_post
@@ -19496,6 +19499,8 @@ paths:
19496
19499
  tags:
19497
19500
  - domain
19498
19501
  - domain_tld_specific
19502
+ x-required-permissions:
19503
+ - domains:manage
19499
19504
  /v1/domains/tld-specific/eu/{domain_reference}/auth_code/request:
19500
19505
  post:
19501
19506
  operationId: request_auth_code_v1_domains_tld_specific_eu__domain_reference__auth_code_request_post
@@ -19560,6 +19565,8 @@ paths:
19560
19565
  tags:
19561
19566
  - domain
19562
19567
  - domain_tld_specific
19568
+ x-required-permissions:
19569
+ - domains:manage
19563
19570
  /v1/domains/transfer:
19564
19571
  post:
19565
19572
  description: 'Start the transfer process for a domain <br>
@@ -19703,6 +19710,8 @@ paths:
19703
19710
  summary: Transfer a domain
19704
19711
  tags:
19705
19712
  - domain
19713
+ x-required-permissions:
19714
+ - domains:manage
19706
19715
  /v1/domains/{domain_reference}:
19707
19716
  delete:
19708
19717
  description: 'Initiates the deletion process for a domain. The domain will be
@@ -19766,6 +19775,8 @@ paths:
19766
19775
  summary: Delete a domain
19767
19776
  tags:
19768
19777
  - domain
19778
+ x-required-permissions:
19779
+ - domains:delete
19769
19780
  get:
19770
19781
  description: Retrieves a single active domain by either its name or id
19771
19782
  operationId: get_domain_v1_domains__domain_reference__get
@@ -19827,6 +19838,8 @@ paths:
19827
19838
  summary: Retrieve a domain
19828
19839
  tags:
19829
19840
  - domain
19841
+ x-required-permissions:
19842
+ - domains:read
19830
19843
  patch:
19831
19844
  description: 'Updates various attributes of an existing domain. Only the fields
19832
19845
  provided in the request
@@ -19898,6 +19911,8 @@ paths:
19898
19911
  summary: Update a domain
19899
19912
  tags:
19900
19913
  - domain
19914
+ x-required-permissions:
19915
+ - domains:manage
19901
19916
  /v1/domains/{domain_reference}/dnssec:
19902
19917
  delete:
19903
19918
  description: Removes all DNSSEC data for a domain
@@ -19944,6 +19959,8 @@ paths:
19944
19959
  summary: Delete DNSSEC data
19945
19960
  tags:
19946
19961
  - domain
19962
+ x-required-permissions:
19963
+ - domains:manage
19947
19964
  get:
19948
19965
  description: Fetches all DNSSEC records associated with the specified domain.
19949
19966
  operationId: get_dnssec_v1_domains__domain_reference__dnssec_get
@@ -19996,6 +20013,8 @@ paths:
19996
20013
  summary: Retrieve DNSSEC data
19997
20014
  tags:
19998
20015
  - domain
20016
+ x-required-permissions:
20017
+ - domains:read
19999
20018
  put:
20000
20019
  description: Replaces all existing DNSSEC records for the domain with the provided
20001
20020
  records.
@@ -20065,6 +20084,8 @@ paths:
20065
20084
  summary: Update DNSSEC data
20066
20085
  tags:
20067
20086
  - domain
20087
+ x-required-permissions:
20088
+ - domains:manage
20068
20089
  /v1/domains/{domain_reference}/dnssec/disable:
20069
20090
  post:
20070
20091
  operationId: disable_and_unpublish_dnssec_records_v1_domains__domain_reference__dnssec_disable_post
@@ -20110,6 +20131,8 @@ paths:
20110
20131
  summary: Disable DNSSEC for domains using our nameservers
20111
20132
  tags:
20112
20133
  - domain
20134
+ x-required-permissions:
20135
+ - domains:manage
20113
20136
  /v1/domains/{domain_reference}/dnssec/enable:
20114
20137
  post:
20115
20138
  operationId: enable_and_publish_dnssec_records_v1_domains__domain_reference__dnssec_enable_post
@@ -20163,6 +20186,8 @@ paths:
20163
20186
  summary: Enable DNSSEC for domains using our nameservers
20164
20187
  tags:
20165
20188
  - domain
20189
+ x-required-permissions:
20190
+ - domains:manage
20166
20191
  /v1/domains/{domain_reference}/renew:
20167
20192
  post:
20168
20193
  description: 'Extends the registration period of an existing domain. The renewal
@@ -20209,6 +20234,8 @@ paths:
20209
20234
  summary: Renew a domain
20210
20235
  tags:
20211
20236
  - domain
20237
+ x-required-permissions:
20238
+ - domains:manage
20212
20239
  /v1/domains/{domain_reference}/restore:
20213
20240
  post:
20214
20241
  operationId: restore_domain_v1_domains__domain_reference__restore_post
@@ -20251,6 +20278,8 @@ paths:
20251
20278
  summary: Restore an eligible domain (during redemption period)
20252
20279
  tags:
20253
20280
  - domain
20281
+ x-required-permissions:
20282
+ - domains:manage
20254
20283
  /v1/domains/{domain_reference}/transfer:
20255
20284
  delete:
20256
20285
  description: This will cancel the in-progress domain transfer and delete the
@@ -20312,6 +20341,8 @@ paths:
20312
20341
  summary: Cancel a domain transfer
20313
20342
  tags:
20314
20343
  - domain
20344
+ x-required-permissions:
20345
+ - domains:manage
20315
20346
  /v1/email-forwards:
20316
20347
  get:
20317
20348
  description: Retrieves a paginated list of all email forwards for the organization.
@@ -20405,6 +20436,8 @@ paths:
20405
20436
  summary: List all email forwards
20406
20437
  tags:
20407
20438
  - email_forward
20439
+ x-required-permissions:
20440
+ - email_forwards:read
20408
20441
  post:
20409
20442
  description: 'Creates an email forward configuration with optional aliases.
20410
20443
  Can be created enabled or disabled (default: disabled). Includes created_on
@@ -20546,6 +20579,9 @@ paths:
20546
20579
  summary: Create email forward configuration
20547
20580
  tags:
20548
20581
  - email_forward
20582
+ x-required-permissions:
20583
+ - dns:manage
20584
+ - email_forwards:manage
20549
20585
  /v1/email-forwards/{email_forward_id}:
20550
20586
  delete:
20551
20587
  description: Permanently deletes the email forward configuration including all
@@ -20603,6 +20639,8 @@ paths:
20603
20639
  summary: Delete email forward configuration
20604
20640
  tags:
20605
20641
  - email_forward
20642
+ x-required-permissions:
20643
+ - email_forwards:delete
20606
20644
  get:
20607
20645
  description: Retrieves the email forward configuration for the specified email
20608
20646
  forward including all aliases
@@ -20674,6 +20712,8 @@ paths:
20674
20712
  summary: Get email forward configuration
20675
20713
  tags:
20676
20714
  - email_forward
20715
+ x-required-permissions:
20716
+ - email_forwards:read
20677
20717
  /v1/email-forwards/{email_forward_id}/aliases:
20678
20718
  post:
20679
20719
  description: Creates a new email forward alias for the specified email forward.
@@ -20799,6 +20839,8 @@ paths:
20799
20839
  summary: Create email forward alias
20800
20840
  tags:
20801
20841
  - email_forward
20842
+ x-required-permissions:
20843
+ - email_forwards:manage
20802
20844
  /v1/email-forwards/{email_forward_id}/aliases/{alias_id}:
20803
20845
  delete:
20804
20846
  description: Deletes a specific email forward alias specified by email_forward_alias_id
@@ -20879,6 +20921,8 @@ paths:
20879
20921
  summary: Delete email forward alias
20880
20922
  tags:
20881
20923
  - email_forward
20924
+ x-required-permissions:
20925
+ - email_forwards:manage
20882
20926
  put:
20883
20927
  description: Updates the forward_to address for a specific email forward alias
20884
20928
  specified by email_forward_alias_id
@@ -20968,6 +21012,8 @@ paths:
20968
21012
  summary: Update email forward alias
20969
21013
  tags:
20970
21014
  - email_forward
21015
+ x-required-permissions:
21016
+ - email_forwards:manage
20971
21017
  /v1/email-forwards/{email_forward_id}/disable:
20972
21018
  patch:
20973
21019
  description: Disables email forwarding by removing MX and SPF DNS records and
@@ -21037,6 +21083,8 @@ paths:
21037
21083
  summary: Disable email forwarding
21038
21084
  tags:
21039
21085
  - email_forward
21086
+ x-required-permissions:
21087
+ - email_forwards:manage
21040
21088
  /v1/email-forwards/{email_forward_id}/enable:
21041
21089
  patch:
21042
21090
  description: Enables email forwarding by creating necessary MX and SPF DNS records
@@ -21105,6 +21153,8 @@ paths:
21105
21153
  summary: Enable email forwarding
21106
21154
  tags:
21107
21155
  - email_forward
21156
+ x-required-permissions:
21157
+ - email_forwards:manage
21108
21158
  /v1/email-forwards/{email_forward_id}/metrics:
21109
21159
  get:
21110
21160
  description: Retrieves metrics and statistics for a specific email forward,
@@ -21195,6 +21245,8 @@ paths:
21195
21245
  summary: Retrieve email forward metrics
21196
21246
  tags:
21197
21247
  - email_forward
21248
+ x-required-permissions:
21249
+ - email_forwards:read
21198
21250
  /v1/events:
21199
21251
  get:
21200
21252
  description: Retrieves a paginated list of events for the organization
@@ -21301,6 +21353,8 @@ paths:
21301
21353
  summary: Get pending events
21302
21354
  tags:
21303
21355
  - event
21356
+ x-required-permissions:
21357
+ - events:read
21304
21358
  /v1/events/{event_id}:
21305
21359
  get:
21306
21360
  description: Get an event by its ID
@@ -21361,6 +21415,8 @@ paths:
21361
21415
  summary: Get event
21362
21416
  tags:
21363
21417
  - event
21418
+ x-required-permissions:
21419
+ - events:read
21364
21420
  patch:
21365
21421
  description: Acknowledge an event
21366
21422
  operationId: acknowledge_event_v1_events__event_id__patch
@@ -21416,6 +21472,8 @@ paths:
21416
21472
  summary: Acknowledge event
21417
21473
  tags:
21418
21474
  - event
21475
+ x-required-permissions:
21476
+ - events:manage
21419
21477
  /v1/job/{job_id}:
21420
21478
  delete:
21421
21479
  operationId: delete_job_v1_job__job_id__delete
@@ -21460,6 +21518,8 @@ paths:
21460
21518
  summary: Delete (cancel) a queued job
21461
21519
  tags:
21462
21520
  - jobs
21521
+ x-required-permissions:
21522
+ - jobs:manage
21463
21523
  get:
21464
21524
  operationId: get_job_v1_job__job_id__get
21465
21525
  parameters:
@@ -21507,6 +21567,8 @@ paths:
21507
21567
  summary: Get individual job details
21508
21568
  tags:
21509
21569
  - jobs
21570
+ x-required-permissions:
21571
+ - jobs:read
21510
21572
  /v1/job/{job_id}/pause:
21511
21573
  post:
21512
21574
  operationId: pause_job_v1_job__job_id__pause_post
@@ -21551,6 +21613,8 @@ paths:
21551
21613
  summary: Pause a job
21552
21614
  tags:
21553
21615
  - jobs
21616
+ x-required-permissions:
21617
+ - jobs:manage
21554
21618
  /v1/job/{job_id}/resume:
21555
21619
  post:
21556
21620
  operationId: resume_job_v1_job__job_id__resume_post
@@ -21599,6 +21663,8 @@ paths:
21599
21663
  summary: Resume a paused job
21600
21664
  tags:
21601
21665
  - jobs
21666
+ x-required-permissions:
21667
+ - jobs:manage
21602
21668
  /v1/job/{job_id}/retry:
21603
21669
  post:
21604
21670
  operationId: retry_job_v1_job__job_id__retry_post
@@ -21659,6 +21725,8 @@ paths:
21659
21725
  summary: Retry a failed or dead-lettered job
21660
21726
  tags:
21661
21727
  - jobs
21728
+ x-required-permissions:
21729
+ - jobs:manage
21662
21730
  /v1/jobs:
21663
21731
  get:
21664
21732
  operationId: list_batches_v1_jobs_get
@@ -21725,6 +21793,8 @@ paths:
21725
21793
  summary: List batches for organization
21726
21794
  tags:
21727
21795
  - jobs
21796
+ x-required-permissions:
21797
+ - jobs:read
21728
21798
  post:
21729
21799
  operationId: create_batch_v1_jobs_post
21730
21800
  requestBody:
@@ -22211,6 +22281,12 @@ paths:
22211
22281
  summary: Create a batch of commands for async execution
22212
22282
  tags:
22213
22283
  - jobs
22284
+ x-required-permissions:
22285
+ - contacts:manage
22286
+ - dns:manage
22287
+ - domains:manage
22288
+ - jobs:manage
22289
+ - parking:manage
22214
22290
  /v1/jobs/{batch_id}:
22215
22291
  delete:
22216
22292
  operationId: delete_batch_v1_jobs__batch_id__delete
@@ -22255,6 +22331,8 @@ paths:
22255
22331
  summary: Delete (cancel) all queued jobs in a batch
22256
22332
  tags:
22257
22333
  - jobs
22334
+ x-required-permissions:
22335
+ - jobs:manage
22258
22336
  get:
22259
22337
  operationId: get_batch_v1_jobs__batch_id__get
22260
22338
  parameters:
@@ -22361,6 +22439,8 @@ paths:
22361
22439
  summary: Get batch details and execution status
22362
22440
  tags:
22363
22441
  - jobs
22442
+ x-required-permissions:
22443
+ - jobs:read
22364
22444
  /v1/jobs/{batch_id}/jobs:
22365
22445
  get:
22366
22446
  operationId: get_batch_jobs_v1_jobs__batch_id__jobs_get
@@ -22644,6 +22724,8 @@ paths:
22644
22724
  summary: Get individual jobs within a batch
22645
22725
  tags:
22646
22726
  - jobs
22727
+ x-required-permissions:
22728
+ - jobs:read
22647
22729
  /v1/jobs/{batch_id}/pause:
22648
22730
  post:
22649
22731
  operationId: pause_batch_v1_jobs__batch_id__pause_post
@@ -22688,6 +22770,8 @@ paths:
22688
22770
  summary: Pause all eligible jobs in a batch
22689
22771
  tags:
22690
22772
  - jobs
22773
+ x-required-permissions:
22774
+ - jobs:manage
22691
22775
  /v1/jobs/{batch_id}/resume:
22692
22776
  post:
22693
22777
  operationId: resume_batch_v1_jobs__batch_id__resume_post
@@ -22732,6 +22816,8 @@ paths:
22732
22816
  summary: Resume all paused jobs in a batch
22733
22817
  tags:
22734
22818
  - jobs
22819
+ x-required-permissions:
22820
+ - jobs:manage
22735
22821
  /v1/jobs/{batch_id}/retry:
22736
22822
  post:
22737
22823
  operationId: retry_batch_v1_jobs__batch_id__retry_post
@@ -22798,6 +22884,8 @@ paths:
22798
22884
  summary: Retry failed and dead-lettered jobs in a batch
22799
22885
  tags:
22800
22886
  - jobs
22887
+ x-required-permissions:
22888
+ - jobs:manage
22801
22889
  /v1/organizations:
22802
22890
  get:
22803
22891
  description: Retrieves a paginated list of organizations under the current organization
@@ -23361,52 +23449,6 @@ paths:
23361
23449
  summary: Update an IP restriction
23362
23450
  tags:
23363
23451
  - organization
23364
- /v1/organizations/roles:
23365
- get:
23366
- description: Retrieves a list of roles for the current organization
23367
- operationId: list_roles_v1_organizations_roles_get
23368
- responses:
23369
- '200':
23370
- content:
23371
- application/json:
23372
- schema: {}
23373
- description: Successful Response
23374
- '401':
23375
- content:
23376
- application/problem+json:
23377
- example:
23378
- code: ERROR_AUTHENTICATION
23379
- detail: Additional error context.
23380
- status: 401
23381
- title: Authentication Error
23382
- type: authentication
23383
- schema:
23384
- $ref: '#/components/schemas/Problem'
23385
- description: Unauthorized
23386
- '403':
23387
- content:
23388
- application/problem+json:
23389
- example:
23390
- code: ERROR_PERMISSION_DENIED
23391
- detail: Insufficient permissions to perform this action
23392
- status: 403
23393
- title: Permission Denied
23394
- type: permission-denied
23395
- schema:
23396
- $ref: '#/components/schemas/Problem'
23397
- description: Forbidden
23398
- '422':
23399
- content:
23400
- application/problem+json:
23401
- schema:
23402
- $ref: '#/components/schemas/HTTPValidationError'
23403
- description: Validation Error
23404
- security:
23405
- - OAuth2PasswordBearer: []
23406
- - APIKeyHeader: []
23407
- summary: List all roles
23408
- tags:
23409
- - organization
23410
23452
  /v1/organizations/users:
23411
23453
  get:
23412
23454
  description: Retrieves a paginated list of users under the current organization
@@ -23868,6 +23910,8 @@ paths:
23868
23910
  summary: List all invoices for the organization
23869
23911
  tags:
23870
23912
  - organization
23913
+ x-required-permissions:
23914
+ - billing:manage
23871
23915
  /v1/organizations/{organization_id}/pricing/product-type/{product_type}:
23872
23916
  get:
23873
23917
  description: Retrieves pricing data for a specific product type. If a product
@@ -24278,6 +24322,8 @@ paths:
24278
24322
  summary: List parking entries
24279
24323
  tags:
24280
24324
  - parking
24325
+ x-required-permissions:
24326
+ - parking:read
24281
24327
  /v1/parking/metrics:
24282
24328
  get:
24283
24329
  description: Retrieves aggregated metrics for all parking entries of the organization.
@@ -24344,6 +24390,8 @@ paths:
24344
24390
  summary: Get total metrics for all parking entries
24345
24391
  tags:
24346
24392
  - parking
24393
+ x-required-permissions:
24394
+ - parking:read
24347
24395
  /v1/parking/signup:
24348
24396
  post:
24349
24397
  description: Accept the parking agreement to enable parking features for your
@@ -24397,6 +24445,8 @@ paths:
24397
24445
  summary: Sign up for parking
24398
24446
  tags:
24399
24447
  - parking
24448
+ x-required-permissions:
24449
+ - parking:manage
24400
24450
  /v1/parking/signup/status:
24401
24451
  get:
24402
24452
  description: Check if your organization has accepted the parking agreement.
@@ -24444,6 +24494,8 @@ paths:
24444
24494
  summary: Get parking signup status
24445
24495
  tags:
24446
24496
  - parking
24497
+ x-required-permissions:
24498
+ - parking:read
24447
24499
  /v1/parking/{parking_reference}/metrics:
24448
24500
  get:
24449
24501
  description: Retrieves metrics for a specific parking entry by ID or domain
@@ -24536,6 +24588,8 @@ paths:
24536
24588
  summary: Get metrics for a parking entry
24537
24589
  tags:
24538
24590
  - parking
24591
+ x-required-permissions:
24592
+ - parking:read
24539
24593
  /v1/reports:
24540
24594
  get:
24541
24595
  operationId: list_reports_v1_reports_get
@@ -24792,6 +24846,8 @@ paths:
24792
24846
  summary: List tags
24793
24847
  tags:
24794
24848
  - tag
24849
+ x-required-permissions:
24850
+ - tags:read
24795
24851
  post:
24796
24852
  description: Create a new tag
24797
24853
  operationId: create_tag_v1_tags_post
@@ -24845,6 +24901,8 @@ paths:
24845
24901
  summary: Create a tag
24846
24902
  tags:
24847
24903
  - tag
24904
+ x-required-permissions:
24905
+ - tags:manage
24848
24906
  /v1/tags/objects:
24849
24907
  post:
24850
24908
  description: Add, remove, or replace tags on multiple objects at once. 'replace'
@@ -24913,6 +24971,8 @@ paths:
24913
24971
  summary: Bulk tag or untag objects
24914
24972
  tags:
24915
24973
  - tag
24974
+ x-required-permissions:
24975
+ - tags:manage
24916
24976
  /v1/tags/{tag_id}:
24917
24977
  delete:
24918
24978
  description: Delete a tag
@@ -24969,6 +25029,8 @@ paths:
24969
25029
  summary: Delete a tag
24970
25030
  tags:
24971
25031
  - tag
25032
+ x-required-permissions:
25033
+ - tags:delete
24972
25034
  get:
24973
25035
  description: Retrieve a single tag by its ID
24974
25036
  operationId: get_tag_v1_tags__tag_id__get
@@ -25028,6 +25090,8 @@ paths:
25028
25090
  summary: Get a tag
25029
25091
  tags:
25030
25092
  - tag
25093
+ x-required-permissions:
25094
+ - tags:read
25031
25095
  patch:
25032
25096
  description: Update a tag's label, description, or color
25033
25097
  operationId: update_tag_v1_tags__tag_id__patch
@@ -25106,6 +25170,8 @@ paths:
25106
25170
  summary: Update a tag
25107
25171
  tags:
25108
25172
  - tag
25173
+ x-required-permissions:
25174
+ - tags:manage
25109
25175
  /v1/tags/{tag_id}/objects:
25110
25176
  post:
25111
25177
  description: Add or remove objects from a tag. Objects are matched by the tag's
@@ -25173,6 +25239,8 @@ paths:
25173
25239
  summary: Tag or untag objects
25174
25240
  tags:
25175
25241
  - tag
25242
+ x-required-permissions:
25243
+ - tags:manage
25176
25244
  /v1/tlds/:
25177
25245
  get:
25178
25246
  description: Retrieves a list of TLD Specifications we have support for
@@ -25316,6 +25384,8 @@ paths:
25316
25384
  summary: Create a user
25317
25385
  tags:
25318
25386
  - user
25387
+ x-required-permissions:
25388
+ - users:manage
25319
25389
  /v1/users/me:
25320
25390
  get:
25321
25391
  description: Get the current user
@@ -25336,7 +25406,7 @@ paths:
25336
25406
  content:
25337
25407
  application/json:
25338
25408
  schema:
25339
- $ref: '#/components/schemas/UserWithRelationPermissions'
25409
+ $ref: '#/components/schemas/UserWithPermissions'
25340
25410
  description: Successful Response
25341
25411
  '422':
25342
25412
  content:
@@ -25349,6 +25419,8 @@ paths:
25349
25419
  summary: Get current user
25350
25420
  tags:
25351
25421
  - user
25422
+ x-required-permissions:
25423
+ - users:read
25352
25424
  /v1/users/me/password-reset:
25353
25425
  patch:
25354
25426
  operationId: change_password_v1_users_me_password_reset_patch
@@ -25384,6 +25456,8 @@ paths:
25384
25456
  summary: Change Password
25385
25457
  tags:
25386
25458
  - user
25459
+ x-required-permissions:
25460
+ - users:manage
25387
25461
  /v1/users/{user_id}:
25388
25462
  delete:
25389
25463
  description: Delete a user by ID
@@ -25439,6 +25513,8 @@ paths:
25439
25513
  summary: Delete a user
25440
25514
  tags:
25441
25515
  - user
25516
+ x-required-permissions:
25517
+ - users:delete
25442
25518
  get:
25443
25519
  description: Get a user by ID
25444
25520
  operationId: get_user_v1_users__user_id__get
@@ -25483,6 +25559,8 @@ paths:
25483
25559
  summary: Get a user
25484
25560
  tags:
25485
25561
  - user
25562
+ x-required-permissions:
25563
+ - users:read
25486
25564
  patch:
25487
25565
  description: Update a user by ID
25488
25566
  operationId: update_user_v1_users__user_id__patch
@@ -25523,6 +25601,8 @@ paths:
25523
25601
  summary: Update a user
25524
25602
  tags:
25525
25603
  - user
25604
+ x-required-permissions:
25605
+ - users:manage
25526
25606
  /v1/users/{user_id}/permissions:
25527
25607
  get:
25528
25608
  description: Get the permissions for a user
@@ -25544,7 +25624,7 @@ paths:
25544
25624
  content:
25545
25625
  application/json:
25546
25626
  schema:
25547
- $ref: '#/components/schemas/PermissionSet'
25627
+ $ref: '#/components/schemas/PublicPermissionSet'
25548
25628
  description: Successful Response
25549
25629
  '422':
25550
25630
  content:
@@ -25558,10 +25638,12 @@ paths:
25558
25638
  summary: Get user permissions
25559
25639
  tags:
25560
25640
  - user
25561
- /v1/users/{user_id}/roles:
25641
+ x-required-permissions:
25642
+ - users:read
25643
+ /v1/users/{user_id}/role:
25562
25644
  get:
25563
- description: Get the roles for a user
25564
- operationId: list_roles_v1_users__user_id__roles_get
25645
+ description: Get the role for a user
25646
+ operationId: get_role_v1_users__user_id__role_get
25565
25647
  parameters:
25566
25648
  - in: path
25567
25649
  name: user_id
@@ -25579,7 +25661,7 @@ paths:
25579
25661
  content:
25580
25662
  application/json:
25581
25663
  schema:
25582
- $ref: '#/components/schemas/RelationSet'
25664
+ $ref: '#/components/schemas/PublicRoleAssignment'
25583
25665
  description: Successful Response
25584
25666
  '422':
25585
25667
  content:
@@ -25590,12 +25672,14 @@ paths:
25590
25672
  security:
25591
25673
  - OAuth2PasswordBearer: []
25592
25674
  - APIKeyHeader: []
25593
- summary: Get user roles
25675
+ summary: Get user role
25594
25676
  tags:
25595
25677
  - user
25596
- patch:
25597
- description: Update the roles for a user
25598
- operationId: update_user_relations_v1_users__user_id__roles_patch
25678
+ x-required-permissions:
25679
+ - users:read
25680
+ put:
25681
+ description: Set the role for a user, replacing any existing role
25682
+ operationId: set_user_role_v1_users__user_id__role_put
25599
25683
  parameters:
25600
25684
  - in: path
25601
25685
  name: user_id
@@ -25612,14 +25696,14 @@ paths:
25612
25696
  content:
25613
25697
  application/json:
25614
25698
  schema:
25615
- $ref: '#/components/schemas/SpiceDbRelationshipUpdate'
25699
+ $ref: '#/components/schemas/PublicRoleAssignment'
25616
25700
  required: true
25617
25701
  responses:
25618
25702
  '200':
25619
25703
  content:
25620
25704
  application/json:
25621
25705
  schema:
25622
- $ref: '#/components/schemas/RelationSet'
25706
+ $ref: '#/components/schemas/PublicRoleAssignment'
25623
25707
  description: Successful Response
25624
25708
  '422':
25625
25709
  content:
@@ -25630,7 +25714,7 @@ paths:
25630
25714
  security:
25631
25715
  - OAuth2PasswordBearer: []
25632
25716
  - APIKeyHeader: []
25633
- summary: Update user roles
25717
+ summary: Set user role
25634
25718
  tags:
25635
25719
  - user
25636
25720
  servers: