@opusdns/api 0.54.0 → 0.56.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/package.json +1 -1
- package/src/helpers/constants.ts +1 -51
- package/src/helpers/keys.ts +3061 -5172
- package/src/helpers/requests.d.ts +1 -569
- package/src/helpers/responses.d.ts +38 -916
- package/src/helpers/schemas-arrays.d.ts +1 -15
- package/src/helpers/schemas.d.ts +0 -208
- package/src/openapi.yaml +127 -1224
- package/src/schema.d.ts +122 -1289
package/src/openapi.yaml
CHANGED
|
@@ -2582,192 +2582,6 @@ components:
|
|
|
2582
2582
|
- hostname
|
|
2583
2583
|
title: Nameserver
|
|
2584
2584
|
type: object
|
|
2585
|
-
Notification:
|
|
2586
|
-
properties:
|
|
2587
|
-
author:
|
|
2588
|
-
description: The user or system that created the notification
|
|
2589
|
-
title: Author
|
|
2590
|
-
type: string
|
|
2591
|
-
created_on:
|
|
2592
|
-
description: The date/time the entry was created on
|
|
2593
|
-
format: date-time
|
|
2594
|
-
title: Created On
|
|
2595
|
-
type: string
|
|
2596
|
-
message:
|
|
2597
|
-
description: The message content of the notification
|
|
2598
|
-
title: Message
|
|
2599
|
-
type: string
|
|
2600
|
-
notification_id:
|
|
2601
|
-
examples:
|
|
2602
|
-
- notification_01h45ytscbebyvny4gc8cr8ma2
|
|
2603
|
-
format: typeid
|
|
2604
|
-
pattern: ^notification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
2605
|
-
title: Notification Id
|
|
2606
|
-
type: string
|
|
2607
|
-
x-typeid-prefix: notification
|
|
2608
|
-
publish_date:
|
|
2609
|
-
description: The date/time the notification is to be published
|
|
2610
|
-
format: date-time
|
|
2611
|
-
title: Publish Date
|
|
2612
|
-
type: string
|
|
2613
|
-
source:
|
|
2614
|
-
description: Source of the notification
|
|
2615
|
-
title: Source
|
|
2616
|
-
type: string
|
|
2617
|
-
subject:
|
|
2618
|
-
description: The subject of the notification
|
|
2619
|
-
title: Subject
|
|
2620
|
-
type: string
|
|
2621
|
-
target:
|
|
2622
|
-
description: Target audience (broadcast, account, user)
|
|
2623
|
-
title: Target
|
|
2624
|
-
type: string
|
|
2625
|
-
type:
|
|
2626
|
-
description: The type of notification
|
|
2627
|
-
title: Type
|
|
2628
|
-
type: string
|
|
2629
|
-
updated_on:
|
|
2630
|
-
description: The date/time the entry was last updated on
|
|
2631
|
-
format: date-time
|
|
2632
|
-
title: Updated On
|
|
2633
|
-
type: string
|
|
2634
|
-
required:
|
|
2635
|
-
- subject
|
|
2636
|
-
- type
|
|
2637
|
-
- source
|
|
2638
|
-
- message
|
|
2639
|
-
- author
|
|
2640
|
-
- target
|
|
2641
|
-
title: Notification
|
|
2642
|
-
type: object
|
|
2643
|
-
NotificationCreate:
|
|
2644
|
-
properties:
|
|
2645
|
-
author:
|
|
2646
|
-
description: The user or system that created the notification
|
|
2647
|
-
title: Author
|
|
2648
|
-
type: string
|
|
2649
|
-
message:
|
|
2650
|
-
description: The message content of the notification
|
|
2651
|
-
title: Message
|
|
2652
|
-
type: string
|
|
2653
|
-
publish_date:
|
|
2654
|
-
description: The date/time the notification is to be published
|
|
2655
|
-
format: date-time
|
|
2656
|
-
title: Publish Date
|
|
2657
|
-
type: string
|
|
2658
|
-
source:
|
|
2659
|
-
description: Source of the notification
|
|
2660
|
-
title: Source
|
|
2661
|
-
type: string
|
|
2662
|
-
subject:
|
|
2663
|
-
description: The subject of the notification
|
|
2664
|
-
title: Subject
|
|
2665
|
-
type: string
|
|
2666
|
-
target:
|
|
2667
|
-
description: Target audience (broadcast, account, user)
|
|
2668
|
-
title: Target
|
|
2669
|
-
type: string
|
|
2670
|
-
type:
|
|
2671
|
-
description: The type of notification
|
|
2672
|
-
title: Type
|
|
2673
|
-
type: string
|
|
2674
|
-
required:
|
|
2675
|
-
- subject
|
|
2676
|
-
- type
|
|
2677
|
-
- source
|
|
2678
|
-
- message
|
|
2679
|
-
- author
|
|
2680
|
-
- target
|
|
2681
|
-
title: NotificationCreate
|
|
2682
|
-
type: object
|
|
2683
|
-
NotificationSummary:
|
|
2684
|
-
properties:
|
|
2685
|
-
author:
|
|
2686
|
-
description: The user or system that created the notification
|
|
2687
|
-
title: Author
|
|
2688
|
-
type: string
|
|
2689
|
-
message:
|
|
2690
|
-
description: The message content of the notification
|
|
2691
|
-
title: Message
|
|
2692
|
-
type: string
|
|
2693
|
-
notification_id:
|
|
2694
|
-
examples:
|
|
2695
|
-
- notification_01h45ytscbebyvny4gc8cr8ma2
|
|
2696
|
-
format: typeid
|
|
2697
|
-
pattern: ^notification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
2698
|
-
title: Notification Id
|
|
2699
|
-
type: string
|
|
2700
|
-
x-typeid-prefix: notification
|
|
2701
|
-
publish_date:
|
|
2702
|
-
description: The date/time the notification is to be published
|
|
2703
|
-
format: date-time
|
|
2704
|
-
title: Publish Date
|
|
2705
|
-
type: string
|
|
2706
|
-
source:
|
|
2707
|
-
description: Source of the notification
|
|
2708
|
-
title: Source
|
|
2709
|
-
type: string
|
|
2710
|
-
subject:
|
|
2711
|
-
description: The subject of the notification
|
|
2712
|
-
title: Subject
|
|
2713
|
-
type: string
|
|
2714
|
-
target:
|
|
2715
|
-
description: Target audience (broadcast, account, user)
|
|
2716
|
-
title: Target
|
|
2717
|
-
type: string
|
|
2718
|
-
type:
|
|
2719
|
-
description: The type of notification
|
|
2720
|
-
title: Type
|
|
2721
|
-
type: string
|
|
2722
|
-
required:
|
|
2723
|
-
- subject
|
|
2724
|
-
- type
|
|
2725
|
-
- source
|
|
2726
|
-
- message
|
|
2727
|
-
- author
|
|
2728
|
-
- target
|
|
2729
|
-
title: NotificationSummary
|
|
2730
|
-
type: object
|
|
2731
|
-
NotificationUpdate:
|
|
2732
|
-
properties:
|
|
2733
|
-
author:
|
|
2734
|
-
description: The user or system that created the notification
|
|
2735
|
-
title: Author
|
|
2736
|
-
type: string
|
|
2737
|
-
message:
|
|
2738
|
-
description: The message content of the notification
|
|
2739
|
-
title: Message
|
|
2740
|
-
type: string
|
|
2741
|
-
publish_date:
|
|
2742
|
-
description: The date/time the notification is to be published
|
|
2743
|
-
format: date-time
|
|
2744
|
-
title: Publish Date
|
|
2745
|
-
type: string
|
|
2746
|
-
source:
|
|
2747
|
-
description: Source of the notification
|
|
2748
|
-
title: Source
|
|
2749
|
-
type: string
|
|
2750
|
-
subject:
|
|
2751
|
-
description: The subject of the notification
|
|
2752
|
-
title: Subject
|
|
2753
|
-
type: string
|
|
2754
|
-
target:
|
|
2755
|
-
description: Target audience (broadcast, account, user)
|
|
2756
|
-
title: Target
|
|
2757
|
-
type: string
|
|
2758
|
-
type:
|
|
2759
|
-
description: The type of notification
|
|
2760
|
-
title: Type
|
|
2761
|
-
type: string
|
|
2762
|
-
required:
|
|
2763
|
-
- subject
|
|
2764
|
-
- type
|
|
2765
|
-
- source
|
|
2766
|
-
- message
|
|
2767
|
-
- author
|
|
2768
|
-
- target
|
|
2769
|
-
title: NotificationUpdate
|
|
2770
|
-
type: object
|
|
2771
2585
|
Organization:
|
|
2772
2586
|
properties:
|
|
2773
2587
|
address_1:
|
|
@@ -3722,20 +3536,6 @@ components:
|
|
|
3722
3536
|
- pagination
|
|
3723
3537
|
title: Pagination[Organization]
|
|
3724
3538
|
type: object
|
|
3725
|
-
Pagination_UserNotificationSummary_:
|
|
3726
|
-
properties:
|
|
3727
|
-
pagination:
|
|
3728
|
-
$ref: '#/components/schemas/PaginationMetadata'
|
|
3729
|
-
results:
|
|
3730
|
-
items:
|
|
3731
|
-
$ref: '#/components/schemas/UserNotificationSummary'
|
|
3732
|
-
title: Results
|
|
3733
|
-
type: array
|
|
3734
|
-
required:
|
|
3735
|
-
- results
|
|
3736
|
-
- pagination
|
|
3737
|
-
title: Pagination[UserNotificationSummary]
|
|
3738
|
-
type: object
|
|
3739
3539
|
Pagination_User_:
|
|
3740
3540
|
properties:
|
|
3741
3541
|
pagination:
|
|
@@ -4203,16 +4003,6 @@ components:
|
|
|
4203
4003
|
title: Remove
|
|
4204
4004
|
title: SpiceDbRelationshipUpdate
|
|
4205
4005
|
type: object
|
|
4206
|
-
StartPasswordReset:
|
|
4207
|
-
properties:
|
|
4208
|
-
email:
|
|
4209
|
-
format: email
|
|
4210
|
-
title: Email
|
|
4211
|
-
type: string
|
|
4212
|
-
required:
|
|
4213
|
-
- email
|
|
4214
|
-
title: StartPasswordReset
|
|
4215
|
-
type: object
|
|
4216
4006
|
SyncOperationType:
|
|
4217
4007
|
enum:
|
|
4218
4008
|
- registration
|
|
@@ -4687,92 +4477,6 @@ components:
|
|
|
4687
4477
|
- password
|
|
4688
4478
|
title: UserCreate
|
|
4689
4479
|
type: object
|
|
4690
|
-
UserNotification:
|
|
4691
|
-
properties:
|
|
4692
|
-
created_on:
|
|
4693
|
-
description: The date/time the entry was created on
|
|
4694
|
-
format: date-time
|
|
4695
|
-
title: Created On
|
|
4696
|
-
type: string
|
|
4697
|
-
notification:
|
|
4698
|
-
$ref: '#/components/schemas/Notification'
|
|
4699
|
-
notification_id:
|
|
4700
|
-
default: None
|
|
4701
|
-
description: Unique identifier for the notification
|
|
4702
|
-
examples:
|
|
4703
|
-
- notification_01h45ytscbebyvny4gc8cr8ma2
|
|
4704
|
-
format: typeid
|
|
4705
|
-
pattern: ^notification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
4706
|
-
title: Notification Id
|
|
4707
|
-
type: string
|
|
4708
|
-
x-typeid-prefix: notification
|
|
4709
|
-
status:
|
|
4710
|
-
$ref: '#/components/schemas/UserNotificationStatus'
|
|
4711
|
-
default: unread
|
|
4712
|
-
description: Whether the user has read the notification
|
|
4713
|
-
updated_on:
|
|
4714
|
-
description: The date/time the entry was last updated on
|
|
4715
|
-
format: date-time
|
|
4716
|
-
title: Updated On
|
|
4717
|
-
type: string
|
|
4718
|
-
user_id:
|
|
4719
|
-
default: None
|
|
4720
|
-
examples:
|
|
4721
|
-
- user_01h45ytscbebyvny4gc8cr8ma2
|
|
4722
|
-
format: typeid
|
|
4723
|
-
pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
4724
|
-
title: User Id
|
|
4725
|
-
type: string
|
|
4726
|
-
x-typeid-prefix: user
|
|
4727
|
-
user_notification_id:
|
|
4728
|
-
examples:
|
|
4729
|
-
- user_notification_01h45ytscbebyvny4gc8cr8ma2
|
|
4730
|
-
format: typeid
|
|
4731
|
-
pattern: ^user_notification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
4732
|
-
title: User Notification Id
|
|
4733
|
-
type: string
|
|
4734
|
-
x-typeid-prefix: user_notification
|
|
4735
|
-
required:
|
|
4736
|
-
- notification
|
|
4737
|
-
title: UserNotification
|
|
4738
|
-
type: object
|
|
4739
|
-
UserNotificationStatus:
|
|
4740
|
-
enum:
|
|
4741
|
-
- read
|
|
4742
|
-
- unread
|
|
4743
|
-
title: UserNotificationStatus
|
|
4744
|
-
type: string
|
|
4745
|
-
UserNotificationSummary:
|
|
4746
|
-
properties:
|
|
4747
|
-
notification:
|
|
4748
|
-
$ref: '#/components/schemas/NotificationSummary'
|
|
4749
|
-
status:
|
|
4750
|
-
$ref: '#/components/schemas/UserNotificationStatus'
|
|
4751
|
-
default: unread
|
|
4752
|
-
description: Whether the user has read the notification
|
|
4753
|
-
user_notification_id:
|
|
4754
|
-
examples:
|
|
4755
|
-
- user_notification_01h45ytscbebyvny4gc8cr8ma2
|
|
4756
|
-
format: typeid
|
|
4757
|
-
pattern: ^user_notification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
4758
|
-
title: User Notification Id
|
|
4759
|
-
type: string
|
|
4760
|
-
x-typeid-prefix: user_notification
|
|
4761
|
-
required:
|
|
4762
|
-
- notification
|
|
4763
|
-
title: UserNotificationSummary
|
|
4764
|
-
type: object
|
|
4765
|
-
UserPasswordResetEmailResponse:
|
|
4766
|
-
properties:
|
|
4767
|
-
message:
|
|
4768
|
-
default: A password reset link will be sent to this email if an account
|
|
4769
|
-
is registered under it.
|
|
4770
|
-
description: Message to the user. This message is always displayed regarding
|
|
4771
|
-
the password reset process to prevent leaking information.
|
|
4772
|
-
title: Message
|
|
4773
|
-
type: string
|
|
4774
|
-
title: UserPasswordResetEmailResponse
|
|
4775
|
-
type: object
|
|
4776
4480
|
UserStatus:
|
|
4777
4481
|
enum:
|
|
4778
4482
|
- active
|
|
@@ -4859,237 +4563,62 @@ components:
|
|
|
4859
4563
|
title: Username
|
|
4860
4564
|
title: UserUpdate
|
|
4861
4565
|
type: object
|
|
4862
|
-
|
|
4566
|
+
UserWithAttributes:
|
|
4863
4567
|
properties:
|
|
4864
|
-
canceled_on:
|
|
4865
|
-
anyOf:
|
|
4866
|
-
- format: date-time
|
|
4867
|
-
type: string
|
|
4868
|
-
- type: 'null'
|
|
4869
|
-
description: The date the verification was cancelled
|
|
4870
|
-
title: Canceled On
|
|
4871
4568
|
created_on:
|
|
4872
4569
|
description: The date/time the entry was created on
|
|
4873
4570
|
format: date-time
|
|
4874
4571
|
title: Created On
|
|
4875
4572
|
type: string
|
|
4876
|
-
|
|
4877
|
-
|
|
4878
|
-
|
|
4879
|
-
|
|
4880
|
-
|
|
4881
|
-
description: The
|
|
4882
|
-
|
|
4883
|
-
|
|
4884
|
-
|
|
4573
|
+
deleted_on:
|
|
4574
|
+
anyOf:
|
|
4575
|
+
- format: date-time
|
|
4576
|
+
type: string
|
|
4577
|
+
- type: 'null'
|
|
4578
|
+
description: The date/time the entry was deleted on
|
|
4579
|
+
title: Deleted On
|
|
4580
|
+
email:
|
|
4581
|
+
description: The user's email address
|
|
4582
|
+
format: email
|
|
4583
|
+
title: Email
|
|
4885
4584
|
type: string
|
|
4886
|
-
|
|
4887
|
-
|
|
4888
|
-
|
|
4889
|
-
|
|
4890
|
-
updated_on:
|
|
4891
|
-
description: The date/time the entry was last updated on
|
|
4892
|
-
format: date-time
|
|
4893
|
-
title: Updated On
|
|
4585
|
+
first_name:
|
|
4586
|
+
description: The user's first name
|
|
4587
|
+
minLength: 1
|
|
4588
|
+
title: First Name
|
|
4894
4589
|
type: string
|
|
4895
|
-
|
|
4896
|
-
|
|
4897
|
-
|
|
4590
|
+
last_name:
|
|
4591
|
+
description: The user's last name
|
|
4592
|
+
minLength: 1
|
|
4593
|
+
title: Last Name
|
|
4594
|
+
type: string
|
|
4595
|
+
locale:
|
|
4898
4596
|
examples:
|
|
4899
|
-
-
|
|
4900
|
-
|
|
4901
|
-
pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
4902
|
-
title: User Id
|
|
4597
|
+
- en_US
|
|
4598
|
+
title: Locale
|
|
4903
4599
|
type: string
|
|
4904
|
-
|
|
4905
|
-
|
|
4600
|
+
organization_id:
|
|
4601
|
+
default: None
|
|
4602
|
+
description: The user's organization id
|
|
4906
4603
|
examples:
|
|
4907
|
-
-
|
|
4604
|
+
- organization_01h45ytscbebyvny4gc8cr8ma2
|
|
4908
4605
|
format: typeid
|
|
4909
|
-
pattern: ^
|
|
4910
|
-
title:
|
|
4606
|
+
pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
4607
|
+
title: Organization Id
|
|
4911
4608
|
type: string
|
|
4912
|
-
x-typeid-prefix:
|
|
4913
|
-
|
|
4914
|
-
anyOf:
|
|
4915
|
-
- format: date-time
|
|
4916
|
-
type: string
|
|
4917
|
-
- type: 'null'
|
|
4918
|
-
description: The date the verification was verified
|
|
4919
|
-
title: Verified On
|
|
4920
|
-
required:
|
|
4921
|
-
- token
|
|
4922
|
-
- type
|
|
4923
|
-
title: UserVerificationApiResponse
|
|
4924
|
-
type: object
|
|
4925
|
-
UserVerificationEmailResponse:
|
|
4926
|
-
properties:
|
|
4927
|
-
canceled_on:
|
|
4609
|
+
x-typeid-prefix: organization
|
|
4610
|
+
phone:
|
|
4928
4611
|
anyOf:
|
|
4929
|
-
- format:
|
|
4612
|
+
- format: phone
|
|
4930
4613
|
type: string
|
|
4931
4614
|
- type: 'null'
|
|
4932
|
-
description: The
|
|
4933
|
-
|
|
4934
|
-
|
|
4935
|
-
|
|
4936
|
-
format: date-time
|
|
4937
|
-
title: Created On
|
|
4938
|
-
type: string
|
|
4615
|
+
description: The user's phone number
|
|
4616
|
+
examples:
|
|
4617
|
+
- '+1.2125552368'
|
|
4618
|
+
title: Phone
|
|
4939
4619
|
status:
|
|
4940
|
-
$ref: '#/components/schemas/
|
|
4941
|
-
|
|
4942
|
-
description: Current status of the email verification
|
|
4943
|
-
type:
|
|
4944
|
-
$ref: '#/components/schemas/VerificationType'
|
|
4945
|
-
description: 'The type of verification: ''api'' for retrieving token via
|
|
4946
|
-
API, ''email'' for retrieving via email'
|
|
4947
|
-
updated_on:
|
|
4948
|
-
description: The date/time the entry was last updated on
|
|
4949
|
-
format: date-time
|
|
4950
|
-
title: Updated On
|
|
4951
|
-
type: string
|
|
4952
|
-
user_id:
|
|
4953
|
-
default: None
|
|
4954
|
-
description: The user's id
|
|
4955
|
-
examples:
|
|
4956
|
-
- user_01h45ytscbebyvny4gc8cr8ma2
|
|
4957
|
-
format: typeid
|
|
4958
|
-
pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
4959
|
-
title: User Id
|
|
4960
|
-
type: string
|
|
4961
|
-
x-typeid-prefix: user
|
|
4962
|
-
user_verification_id:
|
|
4963
|
-
examples:
|
|
4964
|
-
- user_verification_01h45ytscbebyvny4gc8cr8ma2
|
|
4965
|
-
format: typeid
|
|
4966
|
-
pattern: ^user_verification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
4967
|
-
title: User Verification Id
|
|
4968
|
-
type: string
|
|
4969
|
-
x-typeid-prefix: user_verification
|
|
4970
|
-
verified_on:
|
|
4971
|
-
anyOf:
|
|
4972
|
-
- format: date-time
|
|
4973
|
-
type: string
|
|
4974
|
-
- type: 'null'
|
|
4975
|
-
description: The date the verification was verified
|
|
4976
|
-
title: Verified On
|
|
4977
|
-
required:
|
|
4978
|
-
- type
|
|
4979
|
-
title: UserVerificationEmailResponse
|
|
4980
|
-
type: object
|
|
4981
|
-
UserVerificationResponse:
|
|
4982
|
-
properties:
|
|
4983
|
-
canceled_on:
|
|
4984
|
-
anyOf:
|
|
4985
|
-
- format: date-time
|
|
4986
|
-
type: string
|
|
4987
|
-
- type: 'null'
|
|
4988
|
-
description: The date the verification was cancelled
|
|
4989
|
-
title: Canceled On
|
|
4990
|
-
created_on:
|
|
4991
|
-
description: The date/time the entry was created on
|
|
4992
|
-
format: date-time
|
|
4993
|
-
title: Created On
|
|
4994
|
-
type: string
|
|
4995
|
-
status:
|
|
4996
|
-
$ref: '#/components/schemas/EmailVerificationStatus'
|
|
4997
|
-
default: pending
|
|
4998
|
-
description: Current status of the email verification
|
|
4999
|
-
type:
|
|
5000
|
-
$ref: '#/components/schemas/VerificationType'
|
|
5001
|
-
description: 'The type of verification: ''api'' for retrieving token via
|
|
5002
|
-
API, ''email'' for retrieving via email'
|
|
5003
|
-
updated_on:
|
|
5004
|
-
description: The date/time the entry was last updated on
|
|
5005
|
-
format: date-time
|
|
5006
|
-
title: Updated On
|
|
5007
|
-
type: string
|
|
5008
|
-
user_id:
|
|
5009
|
-
default: None
|
|
5010
|
-
description: The user's id
|
|
5011
|
-
examples:
|
|
5012
|
-
- user_01h45ytscbebyvny4gc8cr8ma2
|
|
5013
|
-
format: typeid
|
|
5014
|
-
pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
5015
|
-
title: User Id
|
|
5016
|
-
type: string
|
|
5017
|
-
x-typeid-prefix: user
|
|
5018
|
-
user_verification_id:
|
|
5019
|
-
examples:
|
|
5020
|
-
- user_verification_01h45ytscbebyvny4gc8cr8ma2
|
|
5021
|
-
format: typeid
|
|
5022
|
-
pattern: ^user_verification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
5023
|
-
title: User Verification Id
|
|
5024
|
-
type: string
|
|
5025
|
-
x-typeid-prefix: user_verification
|
|
5026
|
-
verified_on:
|
|
5027
|
-
anyOf:
|
|
5028
|
-
- format: date-time
|
|
5029
|
-
type: string
|
|
5030
|
-
- type: 'null'
|
|
5031
|
-
description: The date the verification was verified
|
|
5032
|
-
title: Verified On
|
|
5033
|
-
required:
|
|
5034
|
-
- type
|
|
5035
|
-
title: UserVerificationResponse
|
|
5036
|
-
type: object
|
|
5037
|
-
UserWithAttributes:
|
|
5038
|
-
properties:
|
|
5039
|
-
created_on:
|
|
5040
|
-
description: The date/time the entry was created on
|
|
5041
|
-
format: date-time
|
|
5042
|
-
title: Created On
|
|
5043
|
-
type: string
|
|
5044
|
-
deleted_on:
|
|
5045
|
-
anyOf:
|
|
5046
|
-
- format: date-time
|
|
5047
|
-
type: string
|
|
5048
|
-
- type: 'null'
|
|
5049
|
-
description: The date/time the entry was deleted on
|
|
5050
|
-
title: Deleted On
|
|
5051
|
-
email:
|
|
5052
|
-
description: The user's email address
|
|
5053
|
-
format: email
|
|
5054
|
-
title: Email
|
|
5055
|
-
type: string
|
|
5056
|
-
first_name:
|
|
5057
|
-
description: The user's first name
|
|
5058
|
-
minLength: 1
|
|
5059
|
-
title: First Name
|
|
5060
|
-
type: string
|
|
5061
|
-
last_name:
|
|
5062
|
-
description: The user's last name
|
|
5063
|
-
minLength: 1
|
|
5064
|
-
title: Last Name
|
|
5065
|
-
type: string
|
|
5066
|
-
locale:
|
|
5067
|
-
examples:
|
|
5068
|
-
- en_US
|
|
5069
|
-
title: Locale
|
|
5070
|
-
type: string
|
|
5071
|
-
organization_id:
|
|
5072
|
-
default: None
|
|
5073
|
-
description: The user's organization id
|
|
5074
|
-
examples:
|
|
5075
|
-
- organization_01h45ytscbebyvny4gc8cr8ma2
|
|
5076
|
-
format: typeid
|
|
5077
|
-
pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
5078
|
-
title: Organization Id
|
|
5079
|
-
type: string
|
|
5080
|
-
x-typeid-prefix: organization
|
|
5081
|
-
phone:
|
|
5082
|
-
anyOf:
|
|
5083
|
-
- format: phone
|
|
5084
|
-
type: string
|
|
5085
|
-
- type: 'null'
|
|
5086
|
-
description: The user's phone number
|
|
5087
|
-
examples:
|
|
5088
|
-
- '+1.2125552368'
|
|
5089
|
-
title: Phone
|
|
5090
|
-
status:
|
|
5091
|
-
$ref: '#/components/schemas/UserStatus'
|
|
5092
|
-
readOnly: true
|
|
4620
|
+
$ref: '#/components/schemas/UserStatus'
|
|
4621
|
+
readOnly: true
|
|
5093
4622
|
updated_on:
|
|
5094
4623
|
description: The date/time the entry was last updated on
|
|
5095
4624
|
format: date-time
|
|
@@ -5373,7 +4902,7 @@ info:
|
|
|
5373
4902
|
'
|
|
5374
4903
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
5375
4904
|
title: OpusDNS API
|
|
5376
|
-
version: 2025-09-
|
|
4905
|
+
version: 2025-09-20-150413
|
|
5377
4906
|
x-logo:
|
|
5378
4907
|
altText: OpusDNS API Reference
|
|
5379
4908
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -8435,21 +7964,10 @@ paths:
|
|
|
8435
7964
|
summary: Acknowledge Event
|
|
8436
7965
|
tags:
|
|
8437
7966
|
- event
|
|
8438
|
-
/v1/
|
|
7967
|
+
/v1/organizations:
|
|
8439
7968
|
get:
|
|
8440
|
-
operationId:
|
|
7969
|
+
operationId: list_organizations_v1_organizations_get
|
|
8441
7970
|
parameters:
|
|
8442
|
-
- in: query
|
|
8443
|
-
name: user_id
|
|
8444
|
-
required: true
|
|
8445
|
-
schema:
|
|
8446
|
-
examples:
|
|
8447
|
-
- user_01h45ytscbebyvny4gc8cr8ma2
|
|
8448
|
-
format: typeid
|
|
8449
|
-
pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
8450
|
-
title: User Id
|
|
8451
|
-
type: string
|
|
8452
|
-
x-typeid-prefix: user
|
|
8453
7971
|
- in: query
|
|
8454
7972
|
name: page
|
|
8455
7973
|
required: false
|
|
@@ -8472,7 +7990,7 @@ paths:
|
|
|
8472
7990
|
content:
|
|
8473
7991
|
application/json:
|
|
8474
7992
|
schema:
|
|
8475
|
-
$ref: '#/components/schemas/
|
|
7993
|
+
$ref: '#/components/schemas/Pagination_Organization_'
|
|
8476
7994
|
description: Successful Response
|
|
8477
7995
|
'422':
|
|
8478
7996
|
content:
|
|
@@ -8482,55 +8000,23 @@ paths:
|
|
|
8482
8000
|
description: Validation Error
|
|
8483
8001
|
security:
|
|
8484
8002
|
- OAuth2PasswordBearer: []
|
|
8485
|
-
summary: List
|
|
8003
|
+
summary: List Organizations
|
|
8486
8004
|
tags:
|
|
8487
|
-
-
|
|
8005
|
+
- organization
|
|
8488
8006
|
post:
|
|
8489
|
-
operationId:
|
|
8007
|
+
operationId: create_organization_v1_organizations_post
|
|
8490
8008
|
requestBody:
|
|
8491
8009
|
content:
|
|
8492
8010
|
application/json:
|
|
8493
8011
|
schema:
|
|
8494
|
-
$ref: '#/components/schemas/
|
|
8495
|
-
required: true
|
|
8496
|
-
responses:
|
|
8497
|
-
'201':
|
|
8498
|
-
content:
|
|
8499
|
-
application/json:
|
|
8500
|
-
schema:
|
|
8501
|
-
$ref: '#/components/schemas/Notification'
|
|
8502
|
-
description: Successful Response
|
|
8503
|
-
'422':
|
|
8504
|
-
content:
|
|
8505
|
-
application/problem+json:
|
|
8506
|
-
schema:
|
|
8507
|
-
$ref: '#/components/schemas/HTTPValidationError'
|
|
8508
|
-
description: Validation Error
|
|
8509
|
-
security:
|
|
8510
|
-
- OAuth2PasswordBearer: []
|
|
8511
|
-
summary: Create Notification
|
|
8512
|
-
tags:
|
|
8513
|
-
- notification
|
|
8514
|
-
/v1/notifications/{notification_id}:
|
|
8515
|
-
delete:
|
|
8516
|
-
operationId: delete_notification_v1_notifications__notification_id__delete
|
|
8517
|
-
parameters:
|
|
8518
|
-
- in: path
|
|
8519
|
-
name: notification_id
|
|
8012
|
+
$ref: '#/components/schemas/OrganizationCreate'
|
|
8520
8013
|
required: true
|
|
8521
|
-
schema:
|
|
8522
|
-
examples:
|
|
8523
|
-
- notification_01h45ytscbebyvny4gc8cr8ma2
|
|
8524
|
-
format: typeid
|
|
8525
|
-
pattern: ^notification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
8526
|
-
title: Notification Id
|
|
8527
|
-
type: string
|
|
8528
|
-
x-typeid-prefix: notification
|
|
8529
8014
|
responses:
|
|
8530
8015
|
'200':
|
|
8531
8016
|
content:
|
|
8532
8017
|
application/json:
|
|
8533
|
-
schema:
|
|
8018
|
+
schema:
|
|
8019
|
+
$ref: '#/components/schemas/Organization'
|
|
8534
8020
|
description: Successful Response
|
|
8535
8021
|
'422':
|
|
8536
8022
|
content:
|
|
@@ -8540,40 +8026,47 @@ paths:
|
|
|
8540
8026
|
description: Validation Error
|
|
8541
8027
|
security:
|
|
8542
8028
|
- OAuth2PasswordBearer: []
|
|
8543
|
-
summary:
|
|
8029
|
+
summary: Create Organization
|
|
8544
8030
|
tags:
|
|
8545
|
-
-
|
|
8031
|
+
- organization
|
|
8032
|
+
/v1/organizations/attributes:
|
|
8546
8033
|
get:
|
|
8547
|
-
operationId:
|
|
8034
|
+
operationId: get_attributes_v1_organizations_attributes_get
|
|
8548
8035
|
parameters:
|
|
8549
|
-
- in: path
|
|
8550
|
-
name: notification_id
|
|
8551
|
-
required: true
|
|
8552
|
-
schema:
|
|
8553
|
-
examples:
|
|
8554
|
-
- notification_01h45ytscbebyvny4gc8cr8ma2
|
|
8555
|
-
format: typeid
|
|
8556
|
-
pattern: ^notification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
8557
|
-
title: Notification Id
|
|
8558
|
-
type: string
|
|
8559
|
-
x-typeid-prefix: notification
|
|
8560
8036
|
- in: query
|
|
8561
|
-
name:
|
|
8562
|
-
required:
|
|
8037
|
+
name: organization_id
|
|
8038
|
+
required: false
|
|
8563
8039
|
schema:
|
|
8564
|
-
|
|
8565
|
-
-
|
|
8566
|
-
|
|
8567
|
-
|
|
8568
|
-
|
|
8569
|
-
|
|
8570
|
-
|
|
8040
|
+
anyOf:
|
|
8041
|
+
- examples:
|
|
8042
|
+
- organization_01h45ytscbebyvny4gc8cr8ma2
|
|
8043
|
+
format: typeid
|
|
8044
|
+
pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
8045
|
+
type: string
|
|
8046
|
+
x-typeid-prefix: organization
|
|
8047
|
+
- type: 'null'
|
|
8048
|
+
title: Organization Id
|
|
8049
|
+
- description: Optional list of attribute keys to filter
|
|
8050
|
+
in: query
|
|
8051
|
+
name: keys
|
|
8052
|
+
required: false
|
|
8053
|
+
schema:
|
|
8054
|
+
anyOf:
|
|
8055
|
+
- items:
|
|
8056
|
+
type: string
|
|
8057
|
+
type: array
|
|
8058
|
+
- type: 'null'
|
|
8059
|
+
description: Optional list of attribute keys to filter
|
|
8060
|
+
title: Keys
|
|
8571
8061
|
responses:
|
|
8572
8062
|
'200':
|
|
8573
8063
|
content:
|
|
8574
8064
|
application/json:
|
|
8575
8065
|
schema:
|
|
8576
|
-
|
|
8066
|
+
items:
|
|
8067
|
+
$ref: '#/components/schemas/OrganizationAttributeResponse'
|
|
8068
|
+
title: Response Get Attributes V1 Organizations Attributes Get
|
|
8069
|
+
type: array
|
|
8577
8070
|
description: Successful Response
|
|
8578
8071
|
'422':
|
|
8579
8072
|
content:
|
|
@@ -8583,35 +8076,43 @@ paths:
|
|
|
8583
8076
|
description: Validation Error
|
|
8584
8077
|
security:
|
|
8585
8078
|
- OAuth2PasswordBearer: []
|
|
8586
|
-
summary: Get
|
|
8079
|
+
summary: Get Attributes
|
|
8587
8080
|
tags:
|
|
8588
|
-
-
|
|
8589
|
-
|
|
8590
|
-
operationId:
|
|
8081
|
+
- organization
|
|
8082
|
+
patch:
|
|
8083
|
+
operationId: update_attributes_v1_organizations_attributes_patch
|
|
8591
8084
|
parameters:
|
|
8592
|
-
- in:
|
|
8593
|
-
name:
|
|
8594
|
-
required:
|
|
8085
|
+
- in: query
|
|
8086
|
+
name: organization_id
|
|
8087
|
+
required: false
|
|
8595
8088
|
schema:
|
|
8596
|
-
|
|
8597
|
-
-
|
|
8598
|
-
|
|
8599
|
-
|
|
8600
|
-
|
|
8601
|
-
|
|
8602
|
-
|
|
8089
|
+
anyOf:
|
|
8090
|
+
- examples:
|
|
8091
|
+
- organization_01h45ytscbebyvny4gc8cr8ma2
|
|
8092
|
+
format: typeid
|
|
8093
|
+
pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
8094
|
+
type: string
|
|
8095
|
+
x-typeid-prefix: organization
|
|
8096
|
+
- type: 'null'
|
|
8097
|
+
title: Organization Id
|
|
8603
8098
|
requestBody:
|
|
8604
8099
|
content:
|
|
8605
8100
|
application/json:
|
|
8606
8101
|
schema:
|
|
8607
|
-
|
|
8102
|
+
items:
|
|
8103
|
+
$ref: '#/components/schemas/OrganizationAttributeUpdate'
|
|
8104
|
+
title: Attributes
|
|
8105
|
+
type: array
|
|
8608
8106
|
required: true
|
|
8609
8107
|
responses:
|
|
8610
8108
|
'200':
|
|
8611
8109
|
content:
|
|
8612
8110
|
application/json:
|
|
8613
8111
|
schema:
|
|
8614
|
-
|
|
8112
|
+
items:
|
|
8113
|
+
$ref: '#/components/schemas/OrganizationAttributeResponse'
|
|
8114
|
+
title: Response Update Attributes V1 Organizations Attributes Patch
|
|
8115
|
+
type: array
|
|
8615
8116
|
description: Successful Response
|
|
8616
8117
|
'422':
|
|
8617
8118
|
content:
|
|
@@ -8621,200 +8122,7 @@ paths:
|
|
|
8621
8122
|
description: Validation Error
|
|
8622
8123
|
security:
|
|
8623
8124
|
- OAuth2PasswordBearer: []
|
|
8624
|
-
summary: Update
|
|
8625
|
-
tags:
|
|
8626
|
-
- notification
|
|
8627
|
-
/v1/notifications/{notification_id}/read:
|
|
8628
|
-
patch:
|
|
8629
|
-
operationId: update_notification_read_v1_notifications__notification_id__read_patch
|
|
8630
|
-
parameters:
|
|
8631
|
-
- in: path
|
|
8632
|
-
name: notification_id
|
|
8633
|
-
required: true
|
|
8634
|
-
schema:
|
|
8635
|
-
examples:
|
|
8636
|
-
- notification_01h45ytscbebyvny4gc8cr8ma2
|
|
8637
|
-
format: typeid
|
|
8638
|
-
pattern: ^notification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
8639
|
-
title: Notification Id
|
|
8640
|
-
type: string
|
|
8641
|
-
x-typeid-prefix: notification
|
|
8642
|
-
responses:
|
|
8643
|
-
'200':
|
|
8644
|
-
content:
|
|
8645
|
-
application/json:
|
|
8646
|
-
schema: {}
|
|
8647
|
-
description: Successful Response
|
|
8648
|
-
'422':
|
|
8649
|
-
content:
|
|
8650
|
-
application/problem+json:
|
|
8651
|
-
schema:
|
|
8652
|
-
$ref: '#/components/schemas/HTTPValidationError'
|
|
8653
|
-
description: Validation Error
|
|
8654
|
-
security:
|
|
8655
|
-
- OAuth2PasswordBearer: []
|
|
8656
|
-
summary: Update Notification Read
|
|
8657
|
-
tags:
|
|
8658
|
-
- notification
|
|
8659
|
-
/v1/organizations:
|
|
8660
|
-
get:
|
|
8661
|
-
operationId: list_organizations_v1_organizations_get
|
|
8662
|
-
parameters:
|
|
8663
|
-
- in: query
|
|
8664
|
-
name: page
|
|
8665
|
-
required: false
|
|
8666
|
-
schema:
|
|
8667
|
-
default: 1
|
|
8668
|
-
minimum: 1
|
|
8669
|
-
title: Page
|
|
8670
|
-
type: integer
|
|
8671
|
-
- in: query
|
|
8672
|
-
name: page_size
|
|
8673
|
-
required: false
|
|
8674
|
-
schema:
|
|
8675
|
-
default: 10
|
|
8676
|
-
maximum: 100
|
|
8677
|
-
minimum: 1
|
|
8678
|
-
title: Page Size
|
|
8679
|
-
type: integer
|
|
8680
|
-
responses:
|
|
8681
|
-
'200':
|
|
8682
|
-
content:
|
|
8683
|
-
application/json:
|
|
8684
|
-
schema:
|
|
8685
|
-
$ref: '#/components/schemas/Pagination_Organization_'
|
|
8686
|
-
description: Successful Response
|
|
8687
|
-
'422':
|
|
8688
|
-
content:
|
|
8689
|
-
application/problem+json:
|
|
8690
|
-
schema:
|
|
8691
|
-
$ref: '#/components/schemas/HTTPValidationError'
|
|
8692
|
-
description: Validation Error
|
|
8693
|
-
security:
|
|
8694
|
-
- OAuth2PasswordBearer: []
|
|
8695
|
-
summary: List Organizations
|
|
8696
|
-
tags:
|
|
8697
|
-
- organization
|
|
8698
|
-
post:
|
|
8699
|
-
operationId: create_organization_v1_organizations_post
|
|
8700
|
-
requestBody:
|
|
8701
|
-
content:
|
|
8702
|
-
application/json:
|
|
8703
|
-
schema:
|
|
8704
|
-
$ref: '#/components/schemas/OrganizationCreate'
|
|
8705
|
-
required: true
|
|
8706
|
-
responses:
|
|
8707
|
-
'200':
|
|
8708
|
-
content:
|
|
8709
|
-
application/json:
|
|
8710
|
-
schema:
|
|
8711
|
-
$ref: '#/components/schemas/Organization'
|
|
8712
|
-
description: Successful Response
|
|
8713
|
-
'422':
|
|
8714
|
-
content:
|
|
8715
|
-
application/problem+json:
|
|
8716
|
-
schema:
|
|
8717
|
-
$ref: '#/components/schemas/HTTPValidationError'
|
|
8718
|
-
description: Validation Error
|
|
8719
|
-
security:
|
|
8720
|
-
- OAuth2PasswordBearer: []
|
|
8721
|
-
summary: Create Organization
|
|
8722
|
-
tags:
|
|
8723
|
-
- organization
|
|
8724
|
-
/v1/organizations/attributes:
|
|
8725
|
-
get:
|
|
8726
|
-
operationId: get_attributes_v1_organizations_attributes_get
|
|
8727
|
-
parameters:
|
|
8728
|
-
- in: query
|
|
8729
|
-
name: organization_id
|
|
8730
|
-
required: false
|
|
8731
|
-
schema:
|
|
8732
|
-
anyOf:
|
|
8733
|
-
- examples:
|
|
8734
|
-
- organization_01h45ytscbebyvny4gc8cr8ma2
|
|
8735
|
-
format: typeid
|
|
8736
|
-
pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
8737
|
-
type: string
|
|
8738
|
-
x-typeid-prefix: organization
|
|
8739
|
-
- type: 'null'
|
|
8740
|
-
title: Organization Id
|
|
8741
|
-
- description: Optional list of attribute keys to filter
|
|
8742
|
-
in: query
|
|
8743
|
-
name: keys
|
|
8744
|
-
required: false
|
|
8745
|
-
schema:
|
|
8746
|
-
anyOf:
|
|
8747
|
-
- items:
|
|
8748
|
-
type: string
|
|
8749
|
-
type: array
|
|
8750
|
-
- type: 'null'
|
|
8751
|
-
description: Optional list of attribute keys to filter
|
|
8752
|
-
title: Keys
|
|
8753
|
-
responses:
|
|
8754
|
-
'200':
|
|
8755
|
-
content:
|
|
8756
|
-
application/json:
|
|
8757
|
-
schema:
|
|
8758
|
-
items:
|
|
8759
|
-
$ref: '#/components/schemas/OrganizationAttributeResponse'
|
|
8760
|
-
title: Response Get Attributes V1 Organizations Attributes Get
|
|
8761
|
-
type: array
|
|
8762
|
-
description: Successful Response
|
|
8763
|
-
'422':
|
|
8764
|
-
content:
|
|
8765
|
-
application/problem+json:
|
|
8766
|
-
schema:
|
|
8767
|
-
$ref: '#/components/schemas/HTTPValidationError'
|
|
8768
|
-
description: Validation Error
|
|
8769
|
-
security:
|
|
8770
|
-
- OAuth2PasswordBearer: []
|
|
8771
|
-
summary: Get Attributes
|
|
8772
|
-
tags:
|
|
8773
|
-
- organization
|
|
8774
|
-
patch:
|
|
8775
|
-
operationId: update_attributes_v1_organizations_attributes_patch
|
|
8776
|
-
parameters:
|
|
8777
|
-
- in: query
|
|
8778
|
-
name: organization_id
|
|
8779
|
-
required: false
|
|
8780
|
-
schema:
|
|
8781
|
-
anyOf:
|
|
8782
|
-
- examples:
|
|
8783
|
-
- organization_01h45ytscbebyvny4gc8cr8ma2
|
|
8784
|
-
format: typeid
|
|
8785
|
-
pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
8786
|
-
type: string
|
|
8787
|
-
x-typeid-prefix: organization
|
|
8788
|
-
- type: 'null'
|
|
8789
|
-
title: Organization Id
|
|
8790
|
-
requestBody:
|
|
8791
|
-
content:
|
|
8792
|
-
application/json:
|
|
8793
|
-
schema:
|
|
8794
|
-
items:
|
|
8795
|
-
$ref: '#/components/schemas/OrganizationAttributeUpdate'
|
|
8796
|
-
title: Attributes
|
|
8797
|
-
type: array
|
|
8798
|
-
required: true
|
|
8799
|
-
responses:
|
|
8800
|
-
'200':
|
|
8801
|
-
content:
|
|
8802
|
-
application/json:
|
|
8803
|
-
schema:
|
|
8804
|
-
items:
|
|
8805
|
-
$ref: '#/components/schemas/OrganizationAttributeResponse'
|
|
8806
|
-
title: Response Update Attributes V1 Organizations Attributes Patch
|
|
8807
|
-
type: array
|
|
8808
|
-
description: Successful Response
|
|
8809
|
-
'422':
|
|
8810
|
-
content:
|
|
8811
|
-
application/problem+json:
|
|
8812
|
-
schema:
|
|
8813
|
-
$ref: '#/components/schemas/HTTPValidationError'
|
|
8814
|
-
description: Validation Error
|
|
8815
|
-
security:
|
|
8816
|
-
- OAuth2PasswordBearer: []
|
|
8817
|
-
summary: Update Attributes
|
|
8125
|
+
summary: Update Attributes
|
|
8818
8126
|
tags:
|
|
8819
8127
|
- organization
|
|
8820
8128
|
/v1/organizations/attributes/{organization_id}:
|
|
@@ -9440,56 +8748,6 @@ paths:
|
|
|
9440
8748
|
summary: Create User
|
|
9441
8749
|
tags:
|
|
9442
8750
|
- user
|
|
9443
|
-
/v1/users/email/password-reset:
|
|
9444
|
-
post:
|
|
9445
|
-
operationId: create_user_password_reset_v1_users_email_password_reset_post
|
|
9446
|
-
requestBody:
|
|
9447
|
-
content:
|
|
9448
|
-
application/json:
|
|
9449
|
-
schema:
|
|
9450
|
-
$ref: '#/components/schemas/StartPasswordReset'
|
|
9451
|
-
required: true
|
|
9452
|
-
responses:
|
|
9453
|
-
'201':
|
|
9454
|
-
content:
|
|
9455
|
-
application/json:
|
|
9456
|
-
schema:
|
|
9457
|
-
$ref: '#/components/schemas/UserPasswordResetEmailResponse'
|
|
9458
|
-
description: Successful Response
|
|
9459
|
-
'422':
|
|
9460
|
-
content:
|
|
9461
|
-
application/problem+json:
|
|
9462
|
-
schema:
|
|
9463
|
-
$ref: '#/components/schemas/HTTPValidationError'
|
|
9464
|
-
description: Validation Error
|
|
9465
|
-
summary: Create User Password Reset
|
|
9466
|
-
tags:
|
|
9467
|
-
- user
|
|
9468
|
-
/v1/users/email/verify:
|
|
9469
|
-
get:
|
|
9470
|
-
operationId: redirect_verify_user_v1_users_email_verify_get
|
|
9471
|
-
parameters:
|
|
9472
|
-
- in: query
|
|
9473
|
-
name: token
|
|
9474
|
-
required: true
|
|
9475
|
-
schema:
|
|
9476
|
-
title: Token
|
|
9477
|
-
type: string
|
|
9478
|
-
responses:
|
|
9479
|
-
'200':
|
|
9480
|
-
content:
|
|
9481
|
-
application/json:
|
|
9482
|
-
schema: {}
|
|
9483
|
-
description: Successful Response
|
|
9484
|
-
'422':
|
|
9485
|
-
content:
|
|
9486
|
-
application/problem+json:
|
|
9487
|
-
schema:
|
|
9488
|
-
$ref: '#/components/schemas/HTTPValidationError'
|
|
9489
|
-
description: Validation Error
|
|
9490
|
-
summary: Redirect Verify User
|
|
9491
|
-
tags:
|
|
9492
|
-
- user
|
|
9493
8751
|
/v1/users/me:
|
|
9494
8752
|
get:
|
|
9495
8753
|
operationId: get_current_user_v1_users_me_get
|
|
@@ -9557,187 +8815,33 @@ paths:
|
|
|
9557
8815
|
summary: Confirm User Password Reset Me
|
|
9558
8816
|
tags:
|
|
9559
8817
|
- user
|
|
9560
|
-
/v1/users/
|
|
9561
|
-
|
|
9562
|
-
operationId:
|
|
8818
|
+
/v1/users/{user_id}:
|
|
8819
|
+
delete:
|
|
8820
|
+
operationId: delete_user_v1_users__user_id__delete
|
|
8821
|
+
parameters:
|
|
8822
|
+
- in: path
|
|
8823
|
+
name: user_id
|
|
8824
|
+
required: true
|
|
8825
|
+
schema:
|
|
8826
|
+
examples:
|
|
8827
|
+
- user_01h45ytscbebyvny4gc8cr8ma2
|
|
8828
|
+
format: typeid
|
|
8829
|
+
pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
8830
|
+
title: User Id
|
|
8831
|
+
type: string
|
|
8832
|
+
x-typeid-prefix: user
|
|
9563
8833
|
responses:
|
|
9564
|
-
'
|
|
9565
|
-
content:
|
|
9566
|
-
application/json:
|
|
9567
|
-
schema:
|
|
9568
|
-
$ref: '#/components/schemas/UserVerificationResponse'
|
|
8834
|
+
'204':
|
|
9569
8835
|
description: Successful Response
|
|
9570
|
-
'
|
|
8836
|
+
'409':
|
|
9571
8837
|
content:
|
|
9572
8838
|
application/problem+json:
|
|
9573
8839
|
example:
|
|
9574
|
-
code:
|
|
9575
|
-
detail:
|
|
9576
|
-
status:
|
|
9577
|
-
title:
|
|
9578
|
-
type:
|
|
9579
|
-
schema:
|
|
9580
|
-
$ref: '#/components/schemas/Problem'
|
|
9581
|
-
description: Unauthorized
|
|
9582
|
-
security:
|
|
9583
|
-
- OAuth2PasswordBearer: []
|
|
9584
|
-
summary: Get Verification Status Me
|
|
9585
|
-
tags:
|
|
9586
|
-
- user
|
|
9587
|
-
patch:
|
|
9588
|
-
operationId: update_verification_me_v1_users_me_verification_patch
|
|
9589
|
-
parameters:
|
|
9590
|
-
- in: query
|
|
9591
|
-
name: token
|
|
9592
|
-
required: true
|
|
9593
|
-
schema:
|
|
9594
|
-
title: Token
|
|
9595
|
-
type: string
|
|
9596
|
-
responses:
|
|
9597
|
-
'204':
|
|
9598
|
-
description: Successful Response
|
|
9599
|
-
'400':
|
|
9600
|
-
content:
|
|
9601
|
-
application/problem+json:
|
|
9602
|
-
examples:
|
|
9603
|
-
User Management Error:
|
|
9604
|
-
value:
|
|
9605
|
-
code: ERROR_USER_VERIFICATION_TOKEN_INVALID
|
|
9606
|
-
detail: Invalid verification token
|
|
9607
|
-
status: 400
|
|
9608
|
-
title: User Management Error
|
|
9609
|
-
type: user-verification-token-invalid
|
|
9610
|
-
schema:
|
|
9611
|
-
$ref: '#/components/schemas/Problem'
|
|
9612
|
-
description: Bad Request
|
|
9613
|
-
'401':
|
|
9614
|
-
content:
|
|
9615
|
-
application/problem+json:
|
|
9616
|
-
example:
|
|
9617
|
-
code: ERROR_AUTHENTICATION
|
|
9618
|
-
detail: Additional error context.
|
|
9619
|
-
status: 401
|
|
9620
|
-
title: Authentication Error
|
|
9621
|
-
type: authentication
|
|
9622
|
-
schema:
|
|
9623
|
-
$ref: '#/components/schemas/Problem'
|
|
9624
|
-
description: Unauthorized
|
|
9625
|
-
'404':
|
|
9626
|
-
content:
|
|
9627
|
-
application/problem+json:
|
|
9628
|
-
example:
|
|
9629
|
-
code: ERROR_USER_VERIFICATION_NOT_FOUND
|
|
9630
|
-
detail: 'No user verification found for user: user_id=Additional error
|
|
9631
|
-
context.'
|
|
9632
|
-
status: 404
|
|
9633
|
-
title: User Management Error
|
|
9634
|
-
type: user-verification-not-found
|
|
9635
|
-
schema:
|
|
9636
|
-
$ref: '#/components/schemas/Problem'
|
|
9637
|
-
description: Not Found
|
|
9638
|
-
'422':
|
|
9639
|
-
content:
|
|
9640
|
-
application/problem+json:
|
|
9641
|
-
schema:
|
|
9642
|
-
$ref: '#/components/schemas/HTTPValidationError'
|
|
9643
|
-
description: Validation Error
|
|
9644
|
-
security:
|
|
9645
|
-
- OAuth2PasswordBearer: []
|
|
9646
|
-
summary: Update Verification Me
|
|
9647
|
-
tags:
|
|
9648
|
-
- user
|
|
9649
|
-
post:
|
|
9650
|
-
operationId: create_verification_me_v1_users_me_verification_post
|
|
9651
|
-
parameters:
|
|
9652
|
-
- in: query
|
|
9653
|
-
name: type
|
|
9654
|
-
required: true
|
|
9655
|
-
schema:
|
|
9656
|
-
$ref: '#/components/schemas/VerificationType'
|
|
9657
|
-
responses:
|
|
9658
|
-
'201':
|
|
9659
|
-
content:
|
|
9660
|
-
application/json:
|
|
9661
|
-
schema:
|
|
9662
|
-
anyOf:
|
|
9663
|
-
- $ref: '#/components/schemas/UserVerificationEmailResponse'
|
|
9664
|
-
- $ref: '#/components/schemas/UserVerificationApiResponse'
|
|
9665
|
-
title: Response Create Verification Me V1 Users Me Verification Post
|
|
9666
|
-
description: Successful Response
|
|
9667
|
-
'401':
|
|
9668
|
-
content:
|
|
9669
|
-
application/problem+json:
|
|
9670
|
-
example:
|
|
9671
|
-
code: ERROR_AUTHENTICATION
|
|
9672
|
-
detail: Additional error context.
|
|
9673
|
-
status: 401
|
|
9674
|
-
title: Authentication Error
|
|
9675
|
-
type: authentication
|
|
9676
|
-
schema:
|
|
9677
|
-
$ref: '#/components/schemas/Problem'
|
|
9678
|
-
description: Unauthorized
|
|
9679
|
-
'404':
|
|
9680
|
-
content:
|
|
9681
|
-
application/problem+json:
|
|
9682
|
-
example:
|
|
9683
|
-
code: ERROR_USER_NOT_FOUND
|
|
9684
|
-
detail: Additional error context.
|
|
9685
|
-
status: 404
|
|
9686
|
-
title: User Management Error
|
|
9687
|
-
type: user-not-found
|
|
9688
|
-
schema:
|
|
9689
|
-
$ref: '#/components/schemas/Problem'
|
|
9690
|
-
description: Not Found
|
|
9691
|
-
'405':
|
|
9692
|
-
content:
|
|
9693
|
-
application/problem+json:
|
|
9694
|
-
example:
|
|
9695
|
-
code: ERROR_USER_VERIFICATION_INVALID_TYPE
|
|
9696
|
-
detail: 'Invalid verification type: Additional error context.'
|
|
9697
|
-
status: 405
|
|
9698
|
-
title: User Management Error
|
|
9699
|
-
type: user-verification-type-invalid
|
|
9700
|
-
schema:
|
|
9701
|
-
$ref: '#/components/schemas/Problem'
|
|
9702
|
-
description: Method Not Allowed
|
|
9703
|
-
'422':
|
|
9704
|
-
content:
|
|
9705
|
-
application/problem+json:
|
|
9706
|
-
schema:
|
|
9707
|
-
$ref: '#/components/schemas/HTTPValidationError'
|
|
9708
|
-
description: Validation Error
|
|
9709
|
-
security:
|
|
9710
|
-
- OAuth2PasswordBearer: []
|
|
9711
|
-
summary: Create Verification Me
|
|
9712
|
-
tags:
|
|
9713
|
-
- user
|
|
9714
|
-
/v1/users/{user_id}:
|
|
9715
|
-
delete:
|
|
9716
|
-
operationId: delete_user_v1_users__user_id__delete
|
|
9717
|
-
parameters:
|
|
9718
|
-
- in: path
|
|
9719
|
-
name: user_id
|
|
9720
|
-
required: true
|
|
9721
|
-
schema:
|
|
9722
|
-
examples:
|
|
9723
|
-
- user_01h45ytscbebyvny4gc8cr8ma2
|
|
9724
|
-
format: typeid
|
|
9725
|
-
pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
9726
|
-
title: User Id
|
|
9727
|
-
type: string
|
|
9728
|
-
x-typeid-prefix: user
|
|
9729
|
-
responses:
|
|
9730
|
-
'204':
|
|
9731
|
-
description: Successful Response
|
|
9732
|
-
'409':
|
|
9733
|
-
content:
|
|
9734
|
-
application/problem+json:
|
|
9735
|
-
example:
|
|
9736
|
-
code: ERROR_USER_IS_LAST_ADMIN
|
|
9737
|
-
detail: User is the last admin for the organization
|
|
9738
|
-
status: 409
|
|
9739
|
-
title: User Management Error
|
|
9740
|
-
type: user-is-last-admin
|
|
8840
|
+
code: ERROR_USER_IS_LAST_ADMIN
|
|
8841
|
+
detail: User is the last admin for the organization
|
|
8842
|
+
status: 409
|
|
8843
|
+
title: User Management Error
|
|
8844
|
+
type: user-is-last-admin
|
|
9741
8845
|
schema:
|
|
9742
8846
|
$ref: '#/components/schemas/Problem'
|
|
9743
8847
|
description: Conflict
|
|
@@ -9936,201 +9040,6 @@ paths:
|
|
|
9936
9040
|
summary: Update User Relations
|
|
9937
9041
|
tags:
|
|
9938
9042
|
- user
|
|
9939
|
-
/v1/users/{user_id}/verification:
|
|
9940
|
-
get:
|
|
9941
|
-
operationId: get_verification_status_v1_users__user_id__verification_get
|
|
9942
|
-
parameters:
|
|
9943
|
-
- in: path
|
|
9944
|
-
name: user_id
|
|
9945
|
-
required: true
|
|
9946
|
-
schema:
|
|
9947
|
-
examples:
|
|
9948
|
-
- user_01h45ytscbebyvny4gc8cr8ma2
|
|
9949
|
-
format: typeid
|
|
9950
|
-
pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
9951
|
-
title: User Id
|
|
9952
|
-
type: string
|
|
9953
|
-
x-typeid-prefix: user
|
|
9954
|
-
responses:
|
|
9955
|
-
'200':
|
|
9956
|
-
content:
|
|
9957
|
-
application/json:
|
|
9958
|
-
schema:
|
|
9959
|
-
$ref: '#/components/schemas/UserVerificationResponse'
|
|
9960
|
-
description: Successful Response
|
|
9961
|
-
'401':
|
|
9962
|
-
content:
|
|
9963
|
-
application/problem+json:
|
|
9964
|
-
example:
|
|
9965
|
-
code: ERROR_AUTHENTICATION
|
|
9966
|
-
detail: Additional error context.
|
|
9967
|
-
status: 401
|
|
9968
|
-
title: Authentication Error
|
|
9969
|
-
type: authentication
|
|
9970
|
-
schema:
|
|
9971
|
-
$ref: '#/components/schemas/Problem'
|
|
9972
|
-
description: Unauthorized
|
|
9973
|
-
'422':
|
|
9974
|
-
content:
|
|
9975
|
-
application/problem+json:
|
|
9976
|
-
schema:
|
|
9977
|
-
$ref: '#/components/schemas/HTTPValidationError'
|
|
9978
|
-
description: Validation Error
|
|
9979
|
-
security:
|
|
9980
|
-
- OAuth2PasswordBearer: []
|
|
9981
|
-
summary: Get Verification Status
|
|
9982
|
-
tags:
|
|
9983
|
-
- user
|
|
9984
|
-
patch:
|
|
9985
|
-
operationId: update_verification_v1_users__user_id__verification_patch
|
|
9986
|
-
parameters:
|
|
9987
|
-
- in: path
|
|
9988
|
-
name: user_id
|
|
9989
|
-
required: true
|
|
9990
|
-
schema:
|
|
9991
|
-
examples:
|
|
9992
|
-
- user_01h45ytscbebyvny4gc8cr8ma2
|
|
9993
|
-
format: typeid
|
|
9994
|
-
pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
9995
|
-
title: User Id
|
|
9996
|
-
type: string
|
|
9997
|
-
x-typeid-prefix: user
|
|
9998
|
-
- in: query
|
|
9999
|
-
name: token
|
|
10000
|
-
required: true
|
|
10001
|
-
schema:
|
|
10002
|
-
title: Token
|
|
10003
|
-
type: string
|
|
10004
|
-
responses:
|
|
10005
|
-
'204':
|
|
10006
|
-
description: Successful Response
|
|
10007
|
-
'400':
|
|
10008
|
-
content:
|
|
10009
|
-
application/problem+json:
|
|
10010
|
-
examples:
|
|
10011
|
-
User Management Error:
|
|
10012
|
-
value:
|
|
10013
|
-
code: ERROR_USER_VERIFICATION_TOKEN_INVALID
|
|
10014
|
-
detail: Invalid verification token
|
|
10015
|
-
status: 400
|
|
10016
|
-
title: User Management Error
|
|
10017
|
-
type: user-verification-token-invalid
|
|
10018
|
-
schema:
|
|
10019
|
-
$ref: '#/components/schemas/Problem'
|
|
10020
|
-
description: Bad Request
|
|
10021
|
-
'401':
|
|
10022
|
-
content:
|
|
10023
|
-
application/problem+json:
|
|
10024
|
-
example:
|
|
10025
|
-
code: ERROR_AUTHENTICATION
|
|
10026
|
-
detail: Additional error context.
|
|
10027
|
-
status: 401
|
|
10028
|
-
title: Authentication Error
|
|
10029
|
-
type: authentication
|
|
10030
|
-
schema:
|
|
10031
|
-
$ref: '#/components/schemas/Problem'
|
|
10032
|
-
description: Unauthorized
|
|
10033
|
-
'404':
|
|
10034
|
-
content:
|
|
10035
|
-
application/problem+json:
|
|
10036
|
-
example:
|
|
10037
|
-
code: ERROR_USER_VERIFICATION_NOT_FOUND
|
|
10038
|
-
detail: 'No user verification found for user: user_id=Additional error
|
|
10039
|
-
context.'
|
|
10040
|
-
status: 404
|
|
10041
|
-
title: User Management Error
|
|
10042
|
-
type: user-verification-not-found
|
|
10043
|
-
schema:
|
|
10044
|
-
$ref: '#/components/schemas/Problem'
|
|
10045
|
-
description: Not Found
|
|
10046
|
-
'422':
|
|
10047
|
-
content:
|
|
10048
|
-
application/problem+json:
|
|
10049
|
-
schema:
|
|
10050
|
-
$ref: '#/components/schemas/HTTPValidationError'
|
|
10051
|
-
description: Validation Error
|
|
10052
|
-
security:
|
|
10053
|
-
- OAuth2PasswordBearer: []
|
|
10054
|
-
summary: Update Verification
|
|
10055
|
-
tags:
|
|
10056
|
-
- user
|
|
10057
|
-
post:
|
|
10058
|
-
operationId: create_verification_v1_users__user_id__verification_post
|
|
10059
|
-
parameters:
|
|
10060
|
-
- in: path
|
|
10061
|
-
name: user_id
|
|
10062
|
-
required: true
|
|
10063
|
-
schema:
|
|
10064
|
-
examples:
|
|
10065
|
-
- user_01h45ytscbebyvny4gc8cr8ma2
|
|
10066
|
-
format: typeid
|
|
10067
|
-
pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
10068
|
-
title: User Id
|
|
10069
|
-
type: string
|
|
10070
|
-
x-typeid-prefix: user
|
|
10071
|
-
- in: query
|
|
10072
|
-
name: type
|
|
10073
|
-
required: true
|
|
10074
|
-
schema:
|
|
10075
|
-
$ref: '#/components/schemas/VerificationType'
|
|
10076
|
-
responses:
|
|
10077
|
-
'201':
|
|
10078
|
-
content:
|
|
10079
|
-
application/json:
|
|
10080
|
-
schema:
|
|
10081
|
-
anyOf:
|
|
10082
|
-
- $ref: '#/components/schemas/UserVerificationEmailResponse'
|
|
10083
|
-
- $ref: '#/components/schemas/UserVerificationApiResponse'
|
|
10084
|
-
title: Response Create Verification V1 Users User Id Verification
|
|
10085
|
-
Post
|
|
10086
|
-
description: Successful Response
|
|
10087
|
-
'401':
|
|
10088
|
-
content:
|
|
10089
|
-
application/problem+json:
|
|
10090
|
-
example:
|
|
10091
|
-
code: ERROR_AUTHENTICATION
|
|
10092
|
-
detail: Additional error context.
|
|
10093
|
-
status: 401
|
|
10094
|
-
title: Authentication Error
|
|
10095
|
-
type: authentication
|
|
10096
|
-
schema:
|
|
10097
|
-
$ref: '#/components/schemas/Problem'
|
|
10098
|
-
description: Unauthorized
|
|
10099
|
-
'404':
|
|
10100
|
-
content:
|
|
10101
|
-
application/problem+json:
|
|
10102
|
-
example:
|
|
10103
|
-
code: ERROR_USER_NOT_FOUND
|
|
10104
|
-
detail: Additional error context.
|
|
10105
|
-
status: 404
|
|
10106
|
-
title: User Management Error
|
|
10107
|
-
type: user-not-found
|
|
10108
|
-
schema:
|
|
10109
|
-
$ref: '#/components/schemas/Problem'
|
|
10110
|
-
description: Not Found
|
|
10111
|
-
'405':
|
|
10112
|
-
content:
|
|
10113
|
-
application/problem+json:
|
|
10114
|
-
example:
|
|
10115
|
-
code: ERROR_USER_VERIFICATION_INVALID_TYPE
|
|
10116
|
-
detail: 'Invalid verification type: Additional error context.'
|
|
10117
|
-
status: 405
|
|
10118
|
-
title: User Management Error
|
|
10119
|
-
type: user-verification-type-invalid
|
|
10120
|
-
schema:
|
|
10121
|
-
$ref: '#/components/schemas/Problem'
|
|
10122
|
-
description: Method Not Allowed
|
|
10123
|
-
'422':
|
|
10124
|
-
content:
|
|
10125
|
-
application/problem+json:
|
|
10126
|
-
schema:
|
|
10127
|
-
$ref: '#/components/schemas/HTTPValidationError'
|
|
10128
|
-
description: Validation Error
|
|
10129
|
-
security:
|
|
10130
|
-
- OAuth2PasswordBearer: []
|
|
10131
|
-
summary: Create Verification
|
|
10132
|
-
tags:
|
|
10133
|
-
- user
|
|
10134
9043
|
servers:
|
|
10135
9044
|
- description: Production environment
|
|
10136
9045
|
url: https://api.opusdns.com
|
|
@@ -10182,11 +9091,6 @@ tags:
|
|
|
10182
9091
|
'
|
|
10183
9092
|
name: nameserver
|
|
10184
9093
|
x-displayName: Nameservers
|
|
10185
|
-
- description: 'Endpoints for creating and managing notifications.
|
|
10186
|
-
|
|
10187
|
-
'
|
|
10188
|
-
name: notification
|
|
10189
|
-
x-displayName: Notifications
|
|
10190
9094
|
- description: 'Endpoints for creating and managing organizations.
|
|
10191
9095
|
|
|
10192
9096
|
'
|
|
@@ -10225,4 +9129,3 @@ x-tagGroups:
|
|
|
10225
9129
|
- email_forward
|
|
10226
9130
|
- rdap
|
|
10227
9131
|
- domain_search
|
|
10228
|
-
- notification
|