@workos/openapi-spec 0.94.0 → 0.96.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/dist/open-api-spec.yaml +1079 -228
- package/dist/services.d.mts +1 -1
- package/dist/services.mjs +28 -0
- package/dist/types.d.ts +780 -4
- package/package.json +1 -1
package/dist/open-api-spec.yaml
CHANGED
|
@@ -3649,7 +3649,7 @@ paths:
|
|
|
3649
3649
|
summary: Check authorization
|
|
3650
3650
|
tags:
|
|
3651
3651
|
- authorization
|
|
3652
|
-
x-mutually-exclusive-body-groups: &
|
|
3652
|
+
x-mutually-exclusive-body-groups: &ref_5
|
|
3653
3653
|
resource_target:
|
|
3654
3654
|
optional: false
|
|
3655
3655
|
variants:
|
|
@@ -4292,7 +4292,7 @@ paths:
|
|
|
4292
4292
|
summary: Assign a role
|
|
4293
4293
|
tags:
|
|
4294
4294
|
- authorization
|
|
4295
|
-
x-mutually-exclusive-body-groups: &
|
|
4295
|
+
x-mutually-exclusive-body-groups: &ref_6
|
|
4296
4296
|
resource_target:
|
|
4297
4297
|
optional: false
|
|
4298
4298
|
variants:
|
|
@@ -4363,7 +4363,7 @@ paths:
|
|
|
4363
4363
|
summary: Remove a role assignment
|
|
4364
4364
|
tags:
|
|
4365
4365
|
- authorization
|
|
4366
|
-
x-mutually-exclusive-body-groups: &
|
|
4366
|
+
x-mutually-exclusive-body-groups: &ref_7
|
|
4367
4367
|
resource_target:
|
|
4368
4368
|
optional: false
|
|
4369
4369
|
variants:
|
|
@@ -6786,7 +6786,7 @@ paths:
|
|
|
6786
6786
|
summary: Create an authorization resource
|
|
6787
6787
|
tags:
|
|
6788
6788
|
- authorization
|
|
6789
|
-
x-mutually-exclusive-body-groups: &
|
|
6789
|
+
x-mutually-exclusive-body-groups: &ref_8
|
|
6790
6790
|
parent_resource:
|
|
6791
6791
|
optional: true
|
|
6792
6792
|
variants:
|
|
@@ -8925,7 +8925,7 @@ paths:
|
|
|
8925
8925
|
tags:
|
|
8926
8926
|
- connections
|
|
8927
8927
|
x-feature-flag: connections-api-migrations-capabilities-api
|
|
8928
|
-
x-mutually-exclusive-body-groups: &
|
|
8928
|
+
x-mutually-exclusive-body-groups: &ref_9
|
|
8929
8929
|
protocol_options:
|
|
8930
8930
|
optional: false
|
|
8931
8931
|
variants:
|
|
@@ -10153,7 +10153,7 @@ paths:
|
|
|
10153
10153
|
tags:
|
|
10154
10154
|
- connections
|
|
10155
10155
|
x-feature-flag: connections-api-migrations-capabilities-api
|
|
10156
|
-
x-mutually-exclusive-body-groups: &
|
|
10156
|
+
x-mutually-exclusive-body-groups: &ref_12
|
|
10157
10157
|
protocol_options:
|
|
10158
10158
|
optional: true
|
|
10159
10159
|
variants:
|
|
@@ -10712,6 +10712,9 @@ paths:
|
|
|
10712
10712
|
example:
|
|
10713
10713
|
object: connected_account
|
|
10714
10714
|
id: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
|
|
10715
|
+
connection_role: compatibility
|
|
10716
|
+
account_identifier: null
|
|
10717
|
+
account_display_name: null
|
|
10715
10718
|
user_id: user_01EHZNVPK3SFK441A1RGBFSHRT
|
|
10716
10719
|
organization_id: org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
10717
10720
|
scopes: []
|
|
@@ -10806,14 +10809,31 @@ paths:
|
|
|
10806
10809
|
properties:
|
|
10807
10810
|
user_id:
|
|
10808
10811
|
type: string
|
|
10809
|
-
description:
|
|
10812
|
+
description: >-
|
|
10813
|
+
The ID of the user to authorize. When `connection_owner` is
|
|
10814
|
+
`organization`, this is the user authorizing on behalf of
|
|
10815
|
+
the organization; they must be an active member of the
|
|
10816
|
+
organization and do not become the owner of the resulting
|
|
10817
|
+
connected account.
|
|
10810
10818
|
example: user_01EHZNVPK3SFK441A1RGBFSHRT
|
|
10811
10819
|
organization_id:
|
|
10812
10820
|
type: string
|
|
10813
10821
|
description: >-
|
|
10814
10822
|
An organization ID to scope the authorization to a specific
|
|
10815
|
-
organization.
|
|
10823
|
+
organization. Required when `connection_owner` is
|
|
10824
|
+
`organization`.
|
|
10816
10825
|
example: org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
10826
|
+
connection_owner:
|
|
10827
|
+
type: string
|
|
10828
|
+
enum:
|
|
10829
|
+
- user
|
|
10830
|
+
- organization
|
|
10831
|
+
description: >-
|
|
10832
|
+
Who will own the connected account. `user` (the default)
|
|
10833
|
+
connects the user's own account. `organization` connects the
|
|
10834
|
+
organization's shared account and requires
|
|
10835
|
+
`organization_id`.
|
|
10836
|
+
example: user
|
|
10817
10837
|
return_to:
|
|
10818
10838
|
type: string
|
|
10819
10839
|
format: uri
|
|
@@ -10974,6 +10994,9 @@ paths:
|
|
|
10974
10994
|
example:
|
|
10975
10995
|
object: connected_account
|
|
10976
10996
|
id: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
|
|
10997
|
+
connection_role: compatibility
|
|
10998
|
+
account_identifier: null
|
|
10999
|
+
account_display_name: null
|
|
10977
11000
|
user_id: user_01EHZNVPK3SFK441A1RGBFSHRT
|
|
10978
11001
|
organization_id: org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
10979
11002
|
scopes: []
|
|
@@ -13600,7 +13623,7 @@ paths:
|
|
|
13600
13623
|
summary: Set Retention
|
|
13601
13624
|
tags:
|
|
13602
13625
|
- audit-logs
|
|
13603
|
-
x-mutually-exclusive-body-groups: &
|
|
13626
|
+
x-mutually-exclusive-body-groups: &ref_4
|
|
13604
13627
|
retention:
|
|
13605
13628
|
optional: false
|
|
13606
13629
|
variants:
|
|
@@ -14690,6 +14713,635 @@ paths:
|
|
|
14690
14713
|
summary: List authorized applications
|
|
14691
14714
|
tags:
|
|
14692
14715
|
- organizations.authorized-applications
|
|
14716
|
+
/organizations/{organization_id}/connected_accounts/{slug}:
|
|
14717
|
+
get:
|
|
14718
|
+
description: >-
|
|
14719
|
+
Retrieves an organization's [connected
|
|
14720
|
+
account](/reference/pipes/connected-account) for a specific provider.
|
|
14721
|
+
operationId: DataIntegrationsOrganizationController_getOrganizationDataInstallation
|
|
14722
|
+
parameters:
|
|
14723
|
+
- name: organization_id
|
|
14724
|
+
required: true
|
|
14725
|
+
in: path
|
|
14726
|
+
description: An [Organization](/reference/organization) identifier.
|
|
14727
|
+
schema:
|
|
14728
|
+
example: org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
14729
|
+
type: string
|
|
14730
|
+
- name: slug
|
|
14731
|
+
required: true
|
|
14732
|
+
in: path
|
|
14733
|
+
description: >-
|
|
14734
|
+
The slug identifier of the provider (e.g., `github`, `slack`,
|
|
14735
|
+
`notion`).
|
|
14736
|
+
schema:
|
|
14737
|
+
example: github
|
|
14738
|
+
type: string
|
|
14739
|
+
- name: supports_multiple_connections
|
|
14740
|
+
required: false
|
|
14741
|
+
in: query
|
|
14742
|
+
description: >-
|
|
14743
|
+
Set to `true` to use the plural connection contract. When omitted or
|
|
14744
|
+
`false`, only the compatibility connection is considered.
|
|
14745
|
+
schema:
|
|
14746
|
+
example: true
|
|
14747
|
+
type: boolean
|
|
14748
|
+
- name: connected_account_id
|
|
14749
|
+
required: false
|
|
14750
|
+
in: query
|
|
14751
|
+
description: >-
|
|
14752
|
+
A [connected account](/reference/pipes/connected-account)
|
|
14753
|
+
identifier. Use this to select a specific connection when the
|
|
14754
|
+
organization has several for this provider.
|
|
14755
|
+
schema:
|
|
14756
|
+
minLength: 1
|
|
14757
|
+
example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
|
|
14758
|
+
type: string
|
|
14759
|
+
responses:
|
|
14760
|
+
'200':
|
|
14761
|
+
description: The connected account was retrieved successfully.
|
|
14762
|
+
content:
|
|
14763
|
+
application/json:
|
|
14764
|
+
schema:
|
|
14765
|
+
$ref: '#/components/schemas/ConnectedAccount'
|
|
14766
|
+
example:
|
|
14767
|
+
object: connected_account
|
|
14768
|
+
id: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
|
|
14769
|
+
user_id: null
|
|
14770
|
+
organization_id: org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
14771
|
+
connection_role: compatibility
|
|
14772
|
+
account_identifier: acme-workspace
|
|
14773
|
+
account_display_name: Acme production
|
|
14774
|
+
scopes:
|
|
14775
|
+
- repo
|
|
14776
|
+
- user:email
|
|
14777
|
+
auth_method: oauth
|
|
14778
|
+
api_key_last_4: null
|
|
14779
|
+
client_id: 3MVG9dZJodJWxft2VoStSCVwPFsx0eDcpVc
|
|
14780
|
+
client_secret_last_4: cdef
|
|
14781
|
+
config:
|
|
14782
|
+
instance_url: https://example.my.salesforce.com
|
|
14783
|
+
state: connected
|
|
14784
|
+
created_at: '2024-01-16T14:20:00.000Z'
|
|
14785
|
+
updated_at: '2024-01-16T14:20:00.000Z'
|
|
14786
|
+
'400':
|
|
14787
|
+
description: The connected account selector is malformed.
|
|
14788
|
+
content:
|
|
14789
|
+
application/json:
|
|
14790
|
+
schema:
|
|
14791
|
+
type: object
|
|
14792
|
+
properties:
|
|
14793
|
+
message:
|
|
14794
|
+
type: string
|
|
14795
|
+
description: A human-readable description of the error.
|
|
14796
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
14797
|
+
required:
|
|
14798
|
+
- message
|
|
14799
|
+
'401':
|
|
14800
|
+
description: The request is missing a valid API key.
|
|
14801
|
+
'404':
|
|
14802
|
+
description: The organization or connected account was not found.
|
|
14803
|
+
content:
|
|
14804
|
+
application/json:
|
|
14805
|
+
schema:
|
|
14806
|
+
type: object
|
|
14807
|
+
properties:
|
|
14808
|
+
message:
|
|
14809
|
+
type: string
|
|
14810
|
+
description: A human-readable description of the error.
|
|
14811
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
14812
|
+
required:
|
|
14813
|
+
- message
|
|
14814
|
+
'409':
|
|
14815
|
+
description: >-
|
|
14816
|
+
Several connected accounts match this organization for the provider;
|
|
14817
|
+
one must be named.
|
|
14818
|
+
content:
|
|
14819
|
+
application/json:
|
|
14820
|
+
schema:
|
|
14821
|
+
$ref: '#/components/schemas/AccountSelectionRequiredError'
|
|
14822
|
+
summary: Get an organization connected account
|
|
14823
|
+
tags:
|
|
14824
|
+
- organizations.data-providers
|
|
14825
|
+
x-feature-flag: pipes-org-integrations
|
|
14826
|
+
delete:
|
|
14827
|
+
description: >-
|
|
14828
|
+
Disconnects the organization's account for the provider, including
|
|
14829
|
+
removing any stored access and refresh tokens. A member will need to
|
|
14830
|
+
reauthorize if the organization wants to reconnect. This does not revoke
|
|
14831
|
+
access on the provider side.
|
|
14832
|
+
operationId: >-
|
|
14833
|
+
DataIntegrationsOrganizationController_deleteOrganizationDataInstallation
|
|
14834
|
+
parameters:
|
|
14835
|
+
- name: organization_id
|
|
14836
|
+
required: true
|
|
14837
|
+
in: path
|
|
14838
|
+
description: An [Organization](/reference/organization) identifier.
|
|
14839
|
+
schema:
|
|
14840
|
+
example: org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
14841
|
+
type: string
|
|
14842
|
+
- name: slug
|
|
14843
|
+
required: true
|
|
14844
|
+
in: path
|
|
14845
|
+
description: >-
|
|
14846
|
+
The slug identifier of the provider (e.g., `github`, `slack`,
|
|
14847
|
+
`notion`).
|
|
14848
|
+
schema:
|
|
14849
|
+
example: github
|
|
14850
|
+
type: string
|
|
14851
|
+
- name: supports_multiple_connections
|
|
14852
|
+
required: false
|
|
14853
|
+
in: query
|
|
14854
|
+
description: >-
|
|
14855
|
+
Set to `true` to use the plural connection contract. When omitted or
|
|
14856
|
+
`false`, only the compatibility connection is considered.
|
|
14857
|
+
schema:
|
|
14858
|
+
example: true
|
|
14859
|
+
type: boolean
|
|
14860
|
+
- name: connected_account_id
|
|
14861
|
+
required: false
|
|
14862
|
+
in: query
|
|
14863
|
+
description: >-
|
|
14864
|
+
A [connected account](/reference/pipes/connected-account)
|
|
14865
|
+
identifier. Use this to select the connection to delete.
|
|
14866
|
+
schema:
|
|
14867
|
+
minLength: 1
|
|
14868
|
+
example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
|
|
14869
|
+
type: string
|
|
14870
|
+
responses:
|
|
14871
|
+
'204':
|
|
14872
|
+
description: The connected account was deleted successfully.
|
|
14873
|
+
'400':
|
|
14874
|
+
description: The connected account selector is malformed.
|
|
14875
|
+
content:
|
|
14876
|
+
application/json:
|
|
14877
|
+
schema:
|
|
14878
|
+
type: object
|
|
14879
|
+
properties:
|
|
14880
|
+
message:
|
|
14881
|
+
type: string
|
|
14882
|
+
description: A human-readable description of the error.
|
|
14883
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
14884
|
+
required:
|
|
14885
|
+
- message
|
|
14886
|
+
'401':
|
|
14887
|
+
description: The request is missing a valid API key.
|
|
14888
|
+
'404':
|
|
14889
|
+
description: The organization or connected account was not found.
|
|
14890
|
+
content:
|
|
14891
|
+
application/json:
|
|
14892
|
+
schema:
|
|
14893
|
+
type: object
|
|
14894
|
+
properties:
|
|
14895
|
+
message:
|
|
14896
|
+
type: string
|
|
14897
|
+
description: A human-readable description of the error.
|
|
14898
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
14899
|
+
required:
|
|
14900
|
+
- message
|
|
14901
|
+
'409':
|
|
14902
|
+
description: >-
|
|
14903
|
+
Several connected accounts match this organization for the provider;
|
|
14904
|
+
one must be named.
|
|
14905
|
+
content:
|
|
14906
|
+
application/json:
|
|
14907
|
+
schema:
|
|
14908
|
+
$ref: '#/components/schemas/AccountSelectionRequiredError'
|
|
14909
|
+
'503':
|
|
14910
|
+
description: >-
|
|
14911
|
+
The connected account or its WorkOS OAuth grant is being changed by
|
|
14912
|
+
another request. Retry the request.
|
|
14913
|
+
content:
|
|
14914
|
+
application/json:
|
|
14915
|
+
schema:
|
|
14916
|
+
type: object
|
|
14917
|
+
properties:
|
|
14918
|
+
code:
|
|
14919
|
+
type: string
|
|
14920
|
+
description: The error code identifying the type of error.
|
|
14921
|
+
example: concurrent_request
|
|
14922
|
+
const: concurrent_request
|
|
14923
|
+
message:
|
|
14924
|
+
type: string
|
|
14925
|
+
description: A human-readable description of the error.
|
|
14926
|
+
example: Request could not be processed.
|
|
14927
|
+
required:
|
|
14928
|
+
- code
|
|
14929
|
+
- message
|
|
14930
|
+
summary: Delete an organization connected account
|
|
14931
|
+
tags:
|
|
14932
|
+
- organizations.data-providers
|
|
14933
|
+
x-feature-flag: pipes-org-integrations
|
|
14934
|
+
post:
|
|
14935
|
+
description: >-
|
|
14936
|
+
Imports an organization-owned [connected
|
|
14937
|
+
account](/reference/pipes/connected-account) by providing OAuth tokens
|
|
14938
|
+
directly. Use this to migrate existing connections or set up connections
|
|
14939
|
+
without going through the OAuth flow.
|
|
14940
|
+
operationId: >-
|
|
14941
|
+
DataIntegrationsOrganizationController_createOrganizationDataInstallation
|
|
14942
|
+
parameters:
|
|
14943
|
+
- name: organization_id
|
|
14944
|
+
required: true
|
|
14945
|
+
in: path
|
|
14946
|
+
description: An [Organization](/reference/organization) identifier.
|
|
14947
|
+
schema:
|
|
14948
|
+
example: org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
14949
|
+
type: string
|
|
14950
|
+
- name: slug
|
|
14951
|
+
required: true
|
|
14952
|
+
in: path
|
|
14953
|
+
description: >-
|
|
14954
|
+
The slug identifier of the provider (e.g., `github`, `slack`,
|
|
14955
|
+
`notion`).
|
|
14956
|
+
schema:
|
|
14957
|
+
example: github
|
|
14958
|
+
type: string
|
|
14959
|
+
requestBody:
|
|
14960
|
+
required: true
|
|
14961
|
+
content:
|
|
14962
|
+
application/json:
|
|
14963
|
+
schema:
|
|
14964
|
+
$ref: '#/components/schemas/ConnectedAccountDto'
|
|
14965
|
+
responses:
|
|
14966
|
+
'201':
|
|
14967
|
+
description: The connected account was created successfully.
|
|
14968
|
+
content:
|
|
14969
|
+
application/json:
|
|
14970
|
+
schema:
|
|
14971
|
+
$ref: '#/components/schemas/ConnectedAccount'
|
|
14972
|
+
example:
|
|
14973
|
+
object: connected_account
|
|
14974
|
+
id: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
|
|
14975
|
+
user_id: null
|
|
14976
|
+
organization_id: org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
14977
|
+
connection_role: compatibility
|
|
14978
|
+
account_identifier: acme-workspace
|
|
14979
|
+
account_display_name: Acme production
|
|
14980
|
+
scopes:
|
|
14981
|
+
- repo
|
|
14982
|
+
- user:email
|
|
14983
|
+
auth_method: oauth
|
|
14984
|
+
api_key_last_4: null
|
|
14985
|
+
client_id: 3MVG9dZJodJWxft2VoStSCVwPFsx0eDcpVc
|
|
14986
|
+
client_secret_last_4: cdef
|
|
14987
|
+
config:
|
|
14988
|
+
instance_url: https://example.my.salesforce.com
|
|
14989
|
+
state: connected
|
|
14990
|
+
created_at: '2024-01-16T14:20:00.000Z'
|
|
14991
|
+
updated_at: '2024-01-16T14:20:00.000Z'
|
|
14992
|
+
'401':
|
|
14993
|
+
description: The request is missing a valid API key.
|
|
14994
|
+
'404':
|
|
14995
|
+
description: The organization or data integration was not found.
|
|
14996
|
+
content:
|
|
14997
|
+
application/json:
|
|
14998
|
+
schema:
|
|
14999
|
+
type: object
|
|
15000
|
+
properties:
|
|
15001
|
+
message:
|
|
15002
|
+
type: string
|
|
15003
|
+
description: A human-readable description of the error.
|
|
15004
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
15005
|
+
required:
|
|
15006
|
+
- message
|
|
15007
|
+
'409':
|
|
15008
|
+
description: >-
|
|
15009
|
+
A connected account already exists for this organization and
|
|
15010
|
+
integration.
|
|
15011
|
+
content:
|
|
15012
|
+
application/json:
|
|
15013
|
+
schema:
|
|
15014
|
+
type: object
|
|
15015
|
+
properties:
|
|
15016
|
+
message:
|
|
15017
|
+
type: string
|
|
15018
|
+
description: A human-readable description of the error.
|
|
15019
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
15020
|
+
required:
|
|
15021
|
+
- message
|
|
15022
|
+
'422':
|
|
15023
|
+
description: >-
|
|
15024
|
+
The request body is malformed (`invalid_request_parameters`), the
|
|
15025
|
+
data integration is not in a valid state
|
|
15026
|
+
(`invalid_data_integration_state`), the token combination is invalid
|
|
15027
|
+
(`invalid_token_combination`), or no client credentials are
|
|
15028
|
+
configured for the data integration
|
|
15029
|
+
(`client_credentials_not_configured`).
|
|
15030
|
+
content:
|
|
15031
|
+
application/json:
|
|
15032
|
+
schema:
|
|
15033
|
+
oneOf:
|
|
15034
|
+
- type: object
|
|
15035
|
+
properties:
|
|
15036
|
+
code:
|
|
15037
|
+
type: string
|
|
15038
|
+
enum:
|
|
15039
|
+
- invalid_token_combination
|
|
15040
|
+
- invalid_data_integration_state
|
|
15041
|
+
- client_credentials_not_configured
|
|
15042
|
+
description: The error code identifying the type of error.
|
|
15043
|
+
example: invalid_token_combination
|
|
15044
|
+
message:
|
|
15045
|
+
type: string
|
|
15046
|
+
description: A human-readable description of the error.
|
|
15047
|
+
example: Request could not be processed.
|
|
15048
|
+
required:
|
|
15049
|
+
- code
|
|
15050
|
+
- message
|
|
15051
|
+
- type: object
|
|
15052
|
+
properties:
|
|
15053
|
+
code:
|
|
15054
|
+
type: string
|
|
15055
|
+
description: The error code identifying the type of error.
|
|
15056
|
+
example: invalid_request_parameters
|
|
15057
|
+
const: invalid_request_parameters
|
|
15058
|
+
message:
|
|
15059
|
+
type: string
|
|
15060
|
+
description: A human-readable description of the error.
|
|
15061
|
+
example: Validation failed.
|
|
15062
|
+
errors:
|
|
15063
|
+
type: array
|
|
15064
|
+
items:
|
|
15065
|
+
type: object
|
|
15066
|
+
properties:
|
|
15067
|
+
code:
|
|
15068
|
+
type: string
|
|
15069
|
+
description: The validation error code.
|
|
15070
|
+
example: unknown_event_type
|
|
15071
|
+
message:
|
|
15072
|
+
type: string
|
|
15073
|
+
description: >-
|
|
15074
|
+
A human-readable description of the validation
|
|
15075
|
+
error.
|
|
15076
|
+
example: Invalid enum value.
|
|
15077
|
+
required:
|
|
15078
|
+
- code
|
|
15079
|
+
- message
|
|
15080
|
+
description: The list of validation errors.
|
|
15081
|
+
required:
|
|
15082
|
+
- code
|
|
15083
|
+
- message
|
|
15084
|
+
- errors
|
|
15085
|
+
summary: Import an organization connected account
|
|
15086
|
+
tags:
|
|
15087
|
+
- organizations.data-providers
|
|
15088
|
+
x-feature-flag: pipes-management-api
|
|
15089
|
+
put:
|
|
15090
|
+
description: >-
|
|
15091
|
+
Updates an organization's [connected
|
|
15092
|
+
account](/reference/pipes/connected-account) tokens, scopes, or state
|
|
15093
|
+
for a specific provider.
|
|
15094
|
+
operationId: >-
|
|
15095
|
+
DataIntegrationsOrganizationController_updateOrganizationDataInstallation
|
|
15096
|
+
parameters:
|
|
15097
|
+
- name: organization_id
|
|
15098
|
+
required: true
|
|
15099
|
+
in: path
|
|
15100
|
+
description: An [Organization](/reference/organization) identifier.
|
|
15101
|
+
schema:
|
|
15102
|
+
example: org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
15103
|
+
type: string
|
|
15104
|
+
- name: slug
|
|
15105
|
+
required: true
|
|
15106
|
+
in: path
|
|
15107
|
+
description: >-
|
|
15108
|
+
The slug identifier of the provider (e.g., `github`, `slack`,
|
|
15109
|
+
`notion`).
|
|
15110
|
+
schema:
|
|
15111
|
+
example: github
|
|
15112
|
+
type: string
|
|
15113
|
+
- name: supports_multiple_connections
|
|
15114
|
+
required: false
|
|
15115
|
+
in: query
|
|
15116
|
+
description: >-
|
|
15117
|
+
Set to `true` to use the plural connection contract. When omitted or
|
|
15118
|
+
`false`, only the compatibility connection is considered.
|
|
15119
|
+
schema:
|
|
15120
|
+
example: true
|
|
15121
|
+
type: boolean
|
|
15122
|
+
- name: connected_account_id
|
|
15123
|
+
required: false
|
|
15124
|
+
in: query
|
|
15125
|
+
description: >-
|
|
15126
|
+
A [connected account](/reference/pipes/connected-account)
|
|
15127
|
+
identifier. Use this to select the connection to update.
|
|
15128
|
+
schema:
|
|
15129
|
+
minLength: 1
|
|
15130
|
+
example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
|
|
15131
|
+
type: string
|
|
15132
|
+
requestBody:
|
|
15133
|
+
required: true
|
|
15134
|
+
content:
|
|
15135
|
+
application/json:
|
|
15136
|
+
schema:
|
|
15137
|
+
$ref: '#/components/schemas/ConnectedAccountDto'
|
|
15138
|
+
responses:
|
|
15139
|
+
'200':
|
|
15140
|
+
description: The connected account was updated successfully.
|
|
15141
|
+
content:
|
|
15142
|
+
application/json:
|
|
15143
|
+
schema:
|
|
15144
|
+
$ref: '#/components/schemas/ConnectedAccount'
|
|
15145
|
+
example:
|
|
15146
|
+
object: connected_account
|
|
15147
|
+
id: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
|
|
15148
|
+
user_id: null
|
|
15149
|
+
organization_id: org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
15150
|
+
connection_role: compatibility
|
|
15151
|
+
account_identifier: acme-workspace
|
|
15152
|
+
account_display_name: Acme production
|
|
15153
|
+
scopes:
|
|
15154
|
+
- repo
|
|
15155
|
+
- user:email
|
|
15156
|
+
auth_method: oauth
|
|
15157
|
+
api_key_last_4: null
|
|
15158
|
+
client_id: 3MVG9dZJodJWxft2VoStSCVwPFsx0eDcpVc
|
|
15159
|
+
client_secret_last_4: cdef
|
|
15160
|
+
config:
|
|
15161
|
+
instance_url: https://example.my.salesforce.com
|
|
15162
|
+
state: connected
|
|
15163
|
+
created_at: '2024-01-16T14:20:00.000Z'
|
|
15164
|
+
updated_at: '2024-01-16T14:20:00.000Z'
|
|
15165
|
+
'400':
|
|
15166
|
+
description: The connected account selector is malformed.
|
|
15167
|
+
content:
|
|
15168
|
+
application/json:
|
|
15169
|
+
schema:
|
|
15170
|
+
type: object
|
|
15171
|
+
properties:
|
|
15172
|
+
message:
|
|
15173
|
+
type: string
|
|
15174
|
+
description: A human-readable description of the error.
|
|
15175
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
15176
|
+
required:
|
|
15177
|
+
- message
|
|
15178
|
+
'401':
|
|
15179
|
+
description: The request is missing a valid API key.
|
|
15180
|
+
'404':
|
|
15181
|
+
description: The organization or connected account was not found.
|
|
15182
|
+
content:
|
|
15183
|
+
application/json:
|
|
15184
|
+
schema:
|
|
15185
|
+
type: object
|
|
15186
|
+
properties:
|
|
15187
|
+
message:
|
|
15188
|
+
type: string
|
|
15189
|
+
description: A human-readable description of the error.
|
|
15190
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
15191
|
+
required:
|
|
15192
|
+
- message
|
|
15193
|
+
'409':
|
|
15194
|
+
description: >-
|
|
15195
|
+
Several connected accounts match this organization for the provider;
|
|
15196
|
+
one must be named.
|
|
15197
|
+
content:
|
|
15198
|
+
application/json:
|
|
15199
|
+
schema:
|
|
15200
|
+
$ref: '#/components/schemas/AccountSelectionRequiredError'
|
|
15201
|
+
'422':
|
|
15202
|
+
description: The request body is malformed (`invalid_request_parameters`).
|
|
15203
|
+
content:
|
|
15204
|
+
application/json:
|
|
15205
|
+
schema:
|
|
15206
|
+
type: object
|
|
15207
|
+
properties:
|
|
15208
|
+
code:
|
|
15209
|
+
type: string
|
|
15210
|
+
description: The error code identifying the type of error.
|
|
15211
|
+
example: invalid_request_parameters
|
|
15212
|
+
const: invalid_request_parameters
|
|
15213
|
+
message:
|
|
15214
|
+
type: string
|
|
15215
|
+
description: A human-readable description of the error.
|
|
15216
|
+
example: Validation failed.
|
|
15217
|
+
errors:
|
|
15218
|
+
type: array
|
|
15219
|
+
items:
|
|
15220
|
+
type: object
|
|
15221
|
+
properties:
|
|
15222
|
+
code:
|
|
15223
|
+
type: string
|
|
15224
|
+
description: The validation error code.
|
|
15225
|
+
example: unknown_event_type
|
|
15226
|
+
message:
|
|
15227
|
+
type: string
|
|
15228
|
+
description: >-
|
|
15229
|
+
A human-readable description of the validation
|
|
15230
|
+
error.
|
|
15231
|
+
example: Invalid enum value.
|
|
15232
|
+
required:
|
|
15233
|
+
- code
|
|
15234
|
+
- message
|
|
15235
|
+
description: The list of validation errors.
|
|
15236
|
+
required:
|
|
15237
|
+
- code
|
|
15238
|
+
- message
|
|
15239
|
+
- errors
|
|
15240
|
+
summary: Update an organization connected account
|
|
15241
|
+
tags:
|
|
15242
|
+
- organizations.data-providers
|
|
15243
|
+
x-feature-flag: pipes-management-api
|
|
15244
|
+
/organizations/{organization_id}/data_providers:
|
|
15245
|
+
get:
|
|
15246
|
+
description: >-
|
|
15247
|
+
Retrieves the organization-owned providers configured for your
|
|
15248
|
+
environment and the organization's [connected
|
|
15249
|
+
account](/reference/pipes/connected-account) information for each.
|
|
15250
|
+
Providers owned by individual users are not included.
|
|
15251
|
+
operationId: DataIntegrationsOrganizationController_getOrganizationDataIntegrations
|
|
15252
|
+
parameters:
|
|
15253
|
+
- name: organization_id
|
|
15254
|
+
required: true
|
|
15255
|
+
in: path
|
|
15256
|
+
description: >-
|
|
15257
|
+
An [Organization](/reference/organization) identifier to list
|
|
15258
|
+
providers and connected accounts for.
|
|
15259
|
+
schema:
|
|
15260
|
+
example: org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
15261
|
+
type: string
|
|
15262
|
+
- name: supports_multiple_connections
|
|
15263
|
+
required: false
|
|
15264
|
+
in: query
|
|
15265
|
+
description: >-
|
|
15266
|
+
Set to `true` to use the plural connection contract. When omitted or
|
|
15267
|
+
`false`, only the compatibility connection is considered.
|
|
15268
|
+
schema:
|
|
15269
|
+
example: true
|
|
15270
|
+
type: boolean
|
|
15271
|
+
responses:
|
|
15272
|
+
'200':
|
|
15273
|
+
description: The list of data providers was retrieved successfully.
|
|
15274
|
+
content:
|
|
15275
|
+
application/json:
|
|
15276
|
+
schema:
|
|
15277
|
+
$ref: '#/components/schemas/DataIntegrationsListResponse'
|
|
15278
|
+
example:
|
|
15279
|
+
object: list
|
|
15280
|
+
data:
|
|
15281
|
+
- object: data_provider
|
|
15282
|
+
id: data_integration_01EHZNVPK3SFK441A1RGBFSHRT
|
|
15283
|
+
name: GitHub
|
|
15284
|
+
description: Connect your GitHub account to access repositories.
|
|
15285
|
+
slug: github
|
|
15286
|
+
integration_type: github
|
|
15287
|
+
credentials_type: oauth2
|
|
15288
|
+
scopes:
|
|
15289
|
+
- repo
|
|
15290
|
+
- user:email
|
|
15291
|
+
auth_methods:
|
|
15292
|
+
- oauth
|
|
15293
|
+
ownership: organization
|
|
15294
|
+
created_at: '2024-01-15T10:30:00.000Z'
|
|
15295
|
+
updated_at: '2024-01-15T10:30:00.000Z'
|
|
15296
|
+
integrationType: github
|
|
15297
|
+
credentialsType: oauth2
|
|
15298
|
+
createdAt: '2024-01-15T10:30:00.000Z'
|
|
15299
|
+
updatedAt: '2024-01-15T10:30:00.000Z'
|
|
15300
|
+
connected_account: &ref_1
|
|
15301
|
+
object: connected_account
|
|
15302
|
+
id: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
|
|
15303
|
+
user_id: null
|
|
15304
|
+
organization_id: org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
15305
|
+
connection_role: compatibility
|
|
15306
|
+
account_identifier: acme-workspace
|
|
15307
|
+
account_display_name: Acme production
|
|
15308
|
+
scopes:
|
|
15309
|
+
- repo
|
|
15310
|
+
- user:email
|
|
15311
|
+
auth_method: oauth
|
|
15312
|
+
api_key_last_4: null
|
|
15313
|
+
client_id: 3MVG9dZJodJWxft2VoStSCVwPFsx0eDcpVc
|
|
15314
|
+
client_secret_last_4: cdef
|
|
15315
|
+
config:
|
|
15316
|
+
instance_url: https://example.my.salesforce.com
|
|
15317
|
+
state: connected
|
|
15318
|
+
created_at: '2024-01-16T14:20:00.000Z'
|
|
15319
|
+
updated_at: '2024-01-16T14:20:00.000Z'
|
|
15320
|
+
userlandUserId: null
|
|
15321
|
+
organizationId: org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
15322
|
+
createdAt: '2024-01-16T14:20:00.000Z'
|
|
15323
|
+
updatedAt: '2024-01-16T14:20:00.000Z'
|
|
15324
|
+
connected_accounts:
|
|
15325
|
+
- *ref_1
|
|
15326
|
+
'401':
|
|
15327
|
+
description: The request is missing a valid API key.
|
|
15328
|
+
'404':
|
|
15329
|
+
description: The organization was not found.
|
|
15330
|
+
content:
|
|
15331
|
+
application/json:
|
|
15332
|
+
schema:
|
|
15333
|
+
type: object
|
|
15334
|
+
properties:
|
|
15335
|
+
message:
|
|
15336
|
+
type: string
|
|
15337
|
+
description: A human-readable description of the error.
|
|
15338
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
15339
|
+
required:
|
|
15340
|
+
- message
|
|
15341
|
+
summary: List providers for an organization
|
|
15342
|
+
tags:
|
|
15343
|
+
- organizations.data-providers
|
|
15344
|
+
x-feature-flag: pipes-org-integrations
|
|
14693
15345
|
/organizations/{organization_id}/it_contacts:
|
|
14694
15346
|
get:
|
|
14695
15347
|
description: Get the IT contacts for an organization.
|
|
@@ -19568,7 +20220,7 @@ paths:
|
|
|
19568
20220
|
summary: Create an organization membership
|
|
19569
20221
|
tags:
|
|
19570
20222
|
- user-management.organization-membership
|
|
19571
|
-
x-mutually-exclusive-body-groups: &
|
|
20223
|
+
x-mutually-exclusive-body-groups: &ref_16
|
|
19572
20224
|
role:
|
|
19573
20225
|
optional: true
|
|
19574
20226
|
variants:
|
|
@@ -19752,7 +20404,7 @@ paths:
|
|
|
19752
20404
|
summary: Update an organization membership
|
|
19753
20405
|
tags:
|
|
19754
20406
|
- user-management.organization-membership
|
|
19755
|
-
x-mutually-exclusive-body-groups: &
|
|
20407
|
+
x-mutually-exclusive-body-groups: &ref_17
|
|
19756
20408
|
role:
|
|
19757
20409
|
optional: true
|
|
19758
20410
|
variants:
|
|
@@ -21072,7 +21724,7 @@ paths:
|
|
|
21072
21724
|
summary: Create a user
|
|
21073
21725
|
tags:
|
|
21074
21726
|
- user-management.users
|
|
21075
|
-
x-mutually-exclusive-body-groups: &
|
|
21727
|
+
x-mutually-exclusive-body-groups: &ref_18
|
|
21076
21728
|
password:
|
|
21077
21729
|
optional: true
|
|
21078
21730
|
variants:
|
|
@@ -21365,7 +22017,7 @@ paths:
|
|
|
21365
22017
|
summary: Update a user
|
|
21366
22018
|
tags:
|
|
21367
22019
|
- user-management.users
|
|
21368
|
-
x-mutually-exclusive-body-groups: &
|
|
22020
|
+
x-mutually-exclusive-body-groups: &ref_22
|
|
21369
22021
|
password:
|
|
21370
22022
|
optional: true
|
|
21371
22023
|
variants:
|
|
@@ -23087,8 +23739,10 @@ paths:
|
|
|
23087
23739
|
The request body is malformed (`invalid_request_parameters`), the
|
|
23088
23740
|
data integration is not in a valid state
|
|
23089
23741
|
(`invalid_data_integration_state`), the token combination is invalid
|
|
23090
|
-
(`invalid_token_combination`),
|
|
23091
|
-
|
|
23742
|
+
(`invalid_token_combination`), no client credentials are configured
|
|
23743
|
+
for the data integration (`client_credentials_not_configured`), or
|
|
23744
|
+
`refresh_token` is not an active WorkOS OAuth grant of this user
|
|
23745
|
+
(`invalid_refresh_token`).
|
|
23092
23746
|
content:
|
|
23093
23747
|
application/json:
|
|
23094
23748
|
schema:
|
|
@@ -23101,6 +23755,7 @@ paths:
|
|
|
23101
23755
|
- invalid_refresh_token
|
|
23102
23756
|
- invalid_token_combination
|
|
23103
23757
|
- invalid_data_integration_state
|
|
23758
|
+
- client_credentials_not_configured
|
|
23104
23759
|
description: The error code identifying the type of error.
|
|
23105
23760
|
example: invalid_refresh_token
|
|
23106
23761
|
message:
|
|
@@ -25061,6 +25716,8 @@ tags:
|
|
|
25061
25716
|
description: Manage organization-scoped API keys.
|
|
25062
25717
|
- name: organizations.authorized-applications
|
|
25063
25718
|
description: Manage authorized applications for organizations.
|
|
25719
|
+
- name: organizations.data-providers
|
|
25720
|
+
description: Manage organization-owned data providers and connected accounts.
|
|
25064
25721
|
- name: organizations.feature-flags
|
|
25065
25722
|
description: Manage organization-scoped feature flags.
|
|
25066
25723
|
- name: organizations.it-contacts
|
|
@@ -25302,7 +25959,7 @@ components:
|
|
|
25302
25959
|
example: An application for managing user access
|
|
25303
25960
|
scopes:
|
|
25304
25961
|
description: The OAuth scopes granted to the application.
|
|
25305
|
-
example: &
|
|
25962
|
+
example: &ref_2
|
|
25306
25963
|
- openid
|
|
25307
25964
|
- profile
|
|
25308
25965
|
- email
|
|
@@ -25364,7 +26021,7 @@ components:
|
|
|
25364
26021
|
example: An application for managing user access
|
|
25365
26022
|
scopes:
|
|
25366
26023
|
description: The OAuth scopes granted to the application.
|
|
25367
|
-
example: *
|
|
26024
|
+
example: *ref_2
|
|
25368
26025
|
type:
|
|
25369
26026
|
- array
|
|
25370
26027
|
- 'null'
|
|
@@ -25437,7 +26094,7 @@ components:
|
|
|
25437
26094
|
owner: user_01GBTCQ2
|
|
25438
26095
|
maxProperties: 50
|
|
25439
26096
|
additionalProperties: false
|
|
25440
|
-
patternProperties: &
|
|
26097
|
+
patternProperties: &ref_3
|
|
25441
26098
|
^[a-zA-Z0-9_-]{0,40}$:
|
|
25442
26099
|
anyOf:
|
|
25443
26100
|
- type: string
|
|
@@ -25469,7 +26126,7 @@ components:
|
|
|
25469
26126
|
owner: user_01GBTCQ2
|
|
25470
26127
|
maxProperties: 50
|
|
25471
26128
|
additionalProperties: false
|
|
25472
|
-
patternProperties: *
|
|
26129
|
+
patternProperties: *ref_3
|
|
25473
26130
|
required:
|
|
25474
26131
|
- id
|
|
25475
26132
|
- type
|
|
@@ -25516,7 +26173,7 @@ components:
|
|
|
25516
26173
|
owner: user_01GBTCQ2
|
|
25517
26174
|
maxProperties: 50
|
|
25518
26175
|
additionalProperties: false
|
|
25519
|
-
patternProperties: *
|
|
26176
|
+
patternProperties: *ref_3
|
|
25520
26177
|
version:
|
|
25521
26178
|
type: integer
|
|
25522
26179
|
description: What schema version the event is associated with.
|
|
@@ -25598,7 +26255,7 @@ components:
|
|
|
25598
26255
|
- range_start
|
|
25599
26256
|
- range_end
|
|
25600
26257
|
UpdateAuditLogsRetentionDto:
|
|
25601
|
-
x-mutually-exclusive-body-groups: *
|
|
26258
|
+
x-mutually-exclusive-body-groups: *ref_4
|
|
25602
26259
|
oneOf:
|
|
25603
26260
|
- type: object
|
|
25604
26261
|
properties:
|
|
@@ -25783,7 +26440,7 @@ components:
|
|
|
25783
26440
|
x-exclude-from-lint: true
|
|
25784
26441
|
required:
|
|
25785
26442
|
- resource_id
|
|
25786
|
-
x-mutually-exclusive-body-groups: *
|
|
26443
|
+
x-mutually-exclusive-body-groups: *ref_5
|
|
25787
26444
|
CreateGroupRoleAssignmentDto:
|
|
25788
26445
|
type: object
|
|
25789
26446
|
properties:
|
|
@@ -25924,7 +26581,7 @@ components:
|
|
|
25924
26581
|
x-exclude-from-lint: true
|
|
25925
26582
|
required:
|
|
25926
26583
|
- resource_id
|
|
25927
|
-
x-mutually-exclusive-body-groups: *
|
|
26584
|
+
x-mutually-exclusive-body-groups: *ref_6
|
|
25928
26585
|
RemoveRoleDto:
|
|
25929
26586
|
allOf:
|
|
25930
26587
|
- type: object
|
|
@@ -25983,7 +26640,7 @@ components:
|
|
|
25983
26640
|
x-exclude-from-lint: true
|
|
25984
26641
|
required:
|
|
25985
26642
|
- resource_id
|
|
25986
|
-
x-mutually-exclusive-body-groups: *
|
|
26643
|
+
x-mutually-exclusive-body-groups: *ref_7
|
|
25987
26644
|
SetRolePermissionsDto:
|
|
25988
26645
|
type: object
|
|
25989
26646
|
properties:
|
|
@@ -26333,7 +26990,7 @@ components:
|
|
|
26333
26990
|
x-exclude-from-lint: true
|
|
26334
26991
|
required:
|
|
26335
26992
|
- parent_resource_id
|
|
26336
|
-
x-mutually-exclusive-body-groups: *
|
|
26993
|
+
x-mutually-exclusive-body-groups: *ref_8
|
|
26337
26994
|
CreateConnectionKeyPairDto:
|
|
26338
26995
|
type: object
|
|
26339
26996
|
properties:
|
|
@@ -26451,7 +27108,7 @@ components:
|
|
|
26451
27108
|
default: true
|
|
26452
27109
|
token_authentication_method:
|
|
26453
27110
|
type: string
|
|
26454
|
-
enum: &
|
|
27111
|
+
enum: &ref_10
|
|
26455
27112
|
- client_secret_post
|
|
26456
27113
|
- client_secret_basic
|
|
26457
27114
|
- private_key_jwt
|
|
@@ -26467,7 +27124,7 @@ components:
|
|
|
26467
27124
|
$ref: '#/components/schemas/CreateConnectionKeyPairDto'
|
|
26468
27125
|
id_token_signature_algorithm:
|
|
26469
27126
|
type: string
|
|
26470
|
-
enum: &
|
|
27127
|
+
enum: &ref_11
|
|
26471
27128
|
- ES256
|
|
26472
27129
|
- ES384
|
|
26473
27130
|
- ES512
|
|
@@ -26623,7 +27280,7 @@ components:
|
|
|
26623
27280
|
x-exclude-from-lint: true
|
|
26624
27281
|
required:
|
|
26625
27282
|
- saml_options
|
|
26626
|
-
x-mutually-exclusive-body-groups: *
|
|
27283
|
+
x-mutually-exclusive-body-groups: *ref_9
|
|
26627
27284
|
PatchConnectionSamlOptionsDto:
|
|
26628
27285
|
type: object
|
|
26629
27286
|
properties:
|
|
@@ -26699,7 +27356,7 @@ components:
|
|
|
26699
27356
|
example: true
|
|
26700
27357
|
token_authentication_method:
|
|
26701
27358
|
type: string
|
|
26702
|
-
enum: *
|
|
27359
|
+
enum: *ref_10
|
|
26703
27360
|
description: >-
|
|
26704
27361
|
The token-endpoint client authentication method. Moving to
|
|
26705
27362
|
`private_key_jwt` generates a signing key pair if the connection has
|
|
@@ -26709,7 +27366,7 @@ components:
|
|
|
26709
27366
|
example: client_secret_basic
|
|
26710
27367
|
id_token_signature_algorithm:
|
|
26711
27368
|
type: string
|
|
26712
|
-
enum: *
|
|
27369
|
+
enum: *ref_11
|
|
26713
27370
|
description: The ID-token signing algorithm.
|
|
26714
27371
|
example: RS256
|
|
26715
27372
|
fetch_user_info:
|
|
@@ -26853,7 +27510,7 @@ components:
|
|
|
26853
27510
|
x-exclude-from-lint: true
|
|
26854
27511
|
required:
|
|
26855
27512
|
- saml_options
|
|
26856
|
-
x-mutually-exclusive-body-groups: *
|
|
27513
|
+
x-mutually-exclusive-body-groups: *ref_12
|
|
26857
27514
|
CreateCorsOriginDto:
|
|
26858
27515
|
type: object
|
|
26859
27516
|
properties:
|
|
@@ -27035,11 +27692,11 @@ components:
|
|
|
27035
27692
|
type:
|
|
27036
27693
|
- object
|
|
27037
27694
|
- 'null'
|
|
27038
|
-
additionalProperties: &
|
|
27695
|
+
additionalProperties: &ref_13
|
|
27039
27696
|
type: string
|
|
27040
27697
|
maxLength: 600
|
|
27041
27698
|
maxProperties: 50
|
|
27042
|
-
example: &
|
|
27699
|
+
example: &ref_14
|
|
27043
27700
|
tier: diamond
|
|
27044
27701
|
description: >-
|
|
27045
27702
|
Object containing [metadata](/authkit/metadata) key/value pairs
|
|
@@ -27094,9 +27751,9 @@ components:
|
|
|
27094
27751
|
type:
|
|
27095
27752
|
- object
|
|
27096
27753
|
- 'null'
|
|
27097
|
-
additionalProperties: *
|
|
27754
|
+
additionalProperties: *ref_13
|
|
27098
27755
|
maxProperties: 50
|
|
27099
|
-
example: *
|
|
27756
|
+
example: *ref_14
|
|
27100
27757
|
description: >-
|
|
27101
27758
|
Object containing [metadata](/authkit/metadata) key/value pairs
|
|
27102
27759
|
associated with the Organization.
|
|
@@ -27230,7 +27887,7 @@ components:
|
|
|
27230
27887
|
example: application/x-www-form-urlencoded
|
|
27231
27888
|
authenticate_via:
|
|
27232
27889
|
type: string
|
|
27233
|
-
enum: &
|
|
27890
|
+
enum: &ref_15
|
|
27234
27891
|
- request_body
|
|
27235
27892
|
- basic_auth_header
|
|
27236
27893
|
description: >-
|
|
@@ -27398,7 +28055,7 @@ components:
|
|
|
27398
28055
|
example: application/x-www-form-urlencoded
|
|
27399
28056
|
authenticate_via:
|
|
27400
28057
|
type: string
|
|
27401
|
-
enum: *
|
|
28058
|
+
enum: *ref_15
|
|
27402
28059
|
description: >-
|
|
27403
28060
|
How client credentials are sent when exchanging authorization codes
|
|
27404
28061
|
and refreshing tokens.
|
|
@@ -27983,9 +28640,9 @@ components:
|
|
|
27983
28640
|
x-exclude-from-lint: true
|
|
27984
28641
|
required:
|
|
27985
28642
|
- role_slug
|
|
27986
|
-
x-mutually-exclusive-body-groups: *ref_15
|
|
27987
|
-
UpdateUserlandUserOrganizationMembershipDto:
|
|
27988
28643
|
x-mutually-exclusive-body-groups: *ref_16
|
|
28644
|
+
UpdateUserlandUserOrganizationMembershipDto:
|
|
28645
|
+
x-mutually-exclusive-body-groups: *ref_17
|
|
27989
28646
|
oneOf:
|
|
27990
28647
|
- type: object
|
|
27991
28648
|
not:
|
|
@@ -28107,9 +28764,9 @@ components:
|
|
|
28107
28764
|
type:
|
|
28108
28765
|
- object
|
|
28109
28766
|
- 'null'
|
|
28110
|
-
additionalProperties: *
|
|
28767
|
+
additionalProperties: *ref_13
|
|
28111
28768
|
maxProperties: 50
|
|
28112
|
-
example: &
|
|
28769
|
+
example: &ref_19
|
|
28113
28770
|
timezone: America/New_York
|
|
28114
28771
|
description: >-
|
|
28115
28772
|
Object containing metadata key/value pairs associated with the
|
|
@@ -28208,165 +28865,165 @@ components:
|
|
|
28208
28865
|
example: $2a$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy
|
|
28209
28866
|
password_hash_type:
|
|
28210
28867
|
type: string
|
|
28211
|
-
enum: &
|
|
28212
|
-
- bcrypt
|
|
28213
|
-
- firebase-scrypt
|
|
28214
|
-
- ssha
|
|
28215
|
-
- ssha256
|
|
28216
|
-
- scrypt
|
|
28217
|
-
- pbkdf2
|
|
28218
|
-
- argon2
|
|
28219
|
-
description: >-
|
|
28220
|
-
The algorithm originally used to hash the password, used
|
|
28221
|
-
when providing a `password_hash`. Required with
|
|
28222
|
-
`password_hash`. Mutually exclusive with `password`.
|
|
28223
|
-
example: bcrypt
|
|
28224
|
-
password_salt_position:
|
|
28225
|
-
type: string
|
|
28226
|
-
enum: &ref_20
|
|
28227
|
-
- prefix
|
|
28228
|
-
- suffix
|
|
28229
|
-
description: >-
|
|
28230
|
-
The position of the salt relative to the password when the
|
|
28231
|
-
`password_hash` digest was computed: `prefix` for `hash(salt
|
|
28232
|
-
+ password)` or `suffix` for `hash(password + salt)`. Only
|
|
28233
|
-
supported with the `ssha256` hash type and only valid when a
|
|
28234
|
-
`password_hash` is provided. Defaults to `suffix`. Mutually
|
|
28235
|
-
exclusive with `password`.
|
|
28236
|
-
example: prefix
|
|
28237
|
-
required:
|
|
28238
|
-
- password_hash
|
|
28239
|
-
- password_hash_type
|
|
28240
|
-
not:
|
|
28241
|
-
anyOf:
|
|
28242
|
-
- properties:
|
|
28243
|
-
password:
|
|
28244
|
-
x-exclude-from-lint: true
|
|
28245
|
-
required:
|
|
28246
|
-
- password
|
|
28247
|
-
x-mutually-exclusive-body-groups: *ref_17
|
|
28248
|
-
UpdateUserlandUserDto:
|
|
28249
|
-
allOf:
|
|
28250
|
-
- type: object
|
|
28251
|
-
properties:
|
|
28252
|
-
email:
|
|
28253
|
-
type: string
|
|
28254
|
-
format: email
|
|
28255
|
-
description: The email address of the user.
|
|
28256
|
-
example: marcelina.davis@example.com
|
|
28257
|
-
first_name:
|
|
28258
|
-
type: string
|
|
28259
|
-
description: The first name of the user.
|
|
28260
|
-
example: Marcelina
|
|
28261
|
-
last_name:
|
|
28262
|
-
type: string
|
|
28263
|
-
description: The last name of the user.
|
|
28264
|
-
example: Davis
|
|
28265
|
-
name:
|
|
28266
|
-
type: string
|
|
28267
|
-
description: The user's full name.
|
|
28268
|
-
example: Marcelina Davis
|
|
28269
|
-
email_verified:
|
|
28270
|
-
type: boolean
|
|
28271
|
-
description: Whether the user's email has been verified.
|
|
28272
|
-
example: true
|
|
28273
|
-
metadata:
|
|
28274
|
-
type:
|
|
28275
|
-
- object
|
|
28276
|
-
- 'null'
|
|
28277
|
-
additionalProperties: *ref_12
|
|
28278
|
-
maxProperties: 50
|
|
28279
|
-
example: *ref_18
|
|
28280
|
-
description: >-
|
|
28281
|
-
Object containing metadata key/value pairs associated with the
|
|
28282
|
-
user.
|
|
28283
|
-
propertyNames:
|
|
28284
|
-
maxLength: 40
|
|
28285
|
-
external_id:
|
|
28286
|
-
type:
|
|
28287
|
-
- string
|
|
28288
|
-
- 'null'
|
|
28289
|
-
maxLength: 128
|
|
28290
|
-
pattern: ^[\x00-\x7F]+$
|
|
28291
|
-
description: The external ID of the user.
|
|
28292
|
-
example: f1ffa2b2-c20b-4d39-be5c-212726e11222
|
|
28293
|
-
locale:
|
|
28294
|
-
type:
|
|
28295
|
-
- string
|
|
28296
|
-
- 'null'
|
|
28297
|
-
description: The user's preferred locale.
|
|
28298
|
-
example: en-US
|
|
28299
|
-
- oneOf:
|
|
28300
|
-
- type: object
|
|
28301
|
-
not:
|
|
28302
|
-
anyOf:
|
|
28303
|
-
- properties:
|
|
28304
|
-
password:
|
|
28305
|
-
x-exclude-from-lint: true
|
|
28306
|
-
required:
|
|
28307
|
-
- password
|
|
28308
|
-
- properties:
|
|
28309
|
-
password_hash:
|
|
28310
|
-
x-exclude-from-lint: true
|
|
28311
|
-
required:
|
|
28312
|
-
- password_hash
|
|
28313
|
-
- properties:
|
|
28314
|
-
password_hash_type:
|
|
28315
|
-
x-exclude-from-lint: true
|
|
28316
|
-
required:
|
|
28317
|
-
- password_hash_type
|
|
28318
|
-
- properties:
|
|
28319
|
-
password_salt_position:
|
|
28320
|
-
x-exclude-from-lint: true
|
|
28321
|
-
required:
|
|
28322
|
-
- password_salt_position
|
|
28323
|
-
- type: object
|
|
28324
|
-
properties:
|
|
28325
|
-
password:
|
|
28326
|
-
type: string
|
|
28327
|
-
description: >-
|
|
28328
|
-
The password to set for the user. Mutually exclusive with
|
|
28329
|
-
`password_hash`, `password_hash_type`, and
|
|
28330
|
-
`password_salt_position`.
|
|
28331
|
-
example: strong_password_123!
|
|
28332
|
-
required:
|
|
28333
|
-
- password
|
|
28334
|
-
not:
|
|
28335
|
-
anyOf:
|
|
28336
|
-
- properties:
|
|
28337
|
-
password_hash:
|
|
28338
|
-
x-exclude-from-lint: true
|
|
28339
|
-
required:
|
|
28340
|
-
- password_hash
|
|
28341
|
-
- properties:
|
|
28342
|
-
password_hash_type:
|
|
28343
|
-
x-exclude-from-lint: true
|
|
28344
|
-
required:
|
|
28345
|
-
- password_hash_type
|
|
28346
|
-
- properties:
|
|
28347
|
-
password_salt_position:
|
|
28348
|
-
x-exclude-from-lint: true
|
|
28349
|
-
required:
|
|
28350
|
-
- password_salt_position
|
|
28351
|
-
- type: object
|
|
28352
|
-
properties:
|
|
28353
|
-
password_hash:
|
|
28354
|
-
type: string
|
|
28355
|
-
description: >-
|
|
28356
|
-
The hashed password to set for the user. Required with
|
|
28357
|
-
`password_hash_type`. Mutually exclusive with `password`.
|
|
28358
|
-
example: $2a$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy
|
|
28359
|
-
password_hash_type:
|
|
28360
|
-
type: string
|
|
28361
|
-
enum: *ref_19
|
|
28868
|
+
enum: &ref_20
|
|
28869
|
+
- bcrypt
|
|
28870
|
+
- firebase-scrypt
|
|
28871
|
+
- ssha
|
|
28872
|
+
- ssha256
|
|
28873
|
+
- scrypt
|
|
28874
|
+
- pbkdf2
|
|
28875
|
+
- argon2
|
|
28362
28876
|
description: >-
|
|
28363
28877
|
The algorithm originally used to hash the password, used
|
|
28364
28878
|
when providing a `password_hash`. Required with
|
|
28365
28879
|
`password_hash`. Mutually exclusive with `password`.
|
|
28366
28880
|
example: bcrypt
|
|
28367
28881
|
password_salt_position:
|
|
28882
|
+
type: string
|
|
28883
|
+
enum: &ref_21
|
|
28884
|
+
- prefix
|
|
28885
|
+
- suffix
|
|
28886
|
+
description: >-
|
|
28887
|
+
The position of the salt relative to the password when the
|
|
28888
|
+
`password_hash` digest was computed: `prefix` for `hash(salt
|
|
28889
|
+
+ password)` or `suffix` for `hash(password + salt)`. Only
|
|
28890
|
+
supported with the `ssha256` hash type and only valid when a
|
|
28891
|
+
`password_hash` is provided. Defaults to `suffix`. Mutually
|
|
28892
|
+
exclusive with `password`.
|
|
28893
|
+
example: prefix
|
|
28894
|
+
required:
|
|
28895
|
+
- password_hash
|
|
28896
|
+
- password_hash_type
|
|
28897
|
+
not:
|
|
28898
|
+
anyOf:
|
|
28899
|
+
- properties:
|
|
28900
|
+
password:
|
|
28901
|
+
x-exclude-from-lint: true
|
|
28902
|
+
required:
|
|
28903
|
+
- password
|
|
28904
|
+
x-mutually-exclusive-body-groups: *ref_18
|
|
28905
|
+
UpdateUserlandUserDto:
|
|
28906
|
+
allOf:
|
|
28907
|
+
- type: object
|
|
28908
|
+
properties:
|
|
28909
|
+
email:
|
|
28910
|
+
type: string
|
|
28911
|
+
format: email
|
|
28912
|
+
description: The email address of the user.
|
|
28913
|
+
example: marcelina.davis@example.com
|
|
28914
|
+
first_name:
|
|
28915
|
+
type: string
|
|
28916
|
+
description: The first name of the user.
|
|
28917
|
+
example: Marcelina
|
|
28918
|
+
last_name:
|
|
28919
|
+
type: string
|
|
28920
|
+
description: The last name of the user.
|
|
28921
|
+
example: Davis
|
|
28922
|
+
name:
|
|
28923
|
+
type: string
|
|
28924
|
+
description: The user's full name.
|
|
28925
|
+
example: Marcelina Davis
|
|
28926
|
+
email_verified:
|
|
28927
|
+
type: boolean
|
|
28928
|
+
description: Whether the user's email has been verified.
|
|
28929
|
+
example: true
|
|
28930
|
+
metadata:
|
|
28931
|
+
type:
|
|
28932
|
+
- object
|
|
28933
|
+
- 'null'
|
|
28934
|
+
additionalProperties: *ref_13
|
|
28935
|
+
maxProperties: 50
|
|
28936
|
+
example: *ref_19
|
|
28937
|
+
description: >-
|
|
28938
|
+
Object containing metadata key/value pairs associated with the
|
|
28939
|
+
user.
|
|
28940
|
+
propertyNames:
|
|
28941
|
+
maxLength: 40
|
|
28942
|
+
external_id:
|
|
28943
|
+
type:
|
|
28944
|
+
- string
|
|
28945
|
+
- 'null'
|
|
28946
|
+
maxLength: 128
|
|
28947
|
+
pattern: ^[\x00-\x7F]+$
|
|
28948
|
+
description: The external ID of the user.
|
|
28949
|
+
example: f1ffa2b2-c20b-4d39-be5c-212726e11222
|
|
28950
|
+
locale:
|
|
28951
|
+
type:
|
|
28952
|
+
- string
|
|
28953
|
+
- 'null'
|
|
28954
|
+
description: The user's preferred locale.
|
|
28955
|
+
example: en-US
|
|
28956
|
+
- oneOf:
|
|
28957
|
+
- type: object
|
|
28958
|
+
not:
|
|
28959
|
+
anyOf:
|
|
28960
|
+
- properties:
|
|
28961
|
+
password:
|
|
28962
|
+
x-exclude-from-lint: true
|
|
28963
|
+
required:
|
|
28964
|
+
- password
|
|
28965
|
+
- properties:
|
|
28966
|
+
password_hash:
|
|
28967
|
+
x-exclude-from-lint: true
|
|
28968
|
+
required:
|
|
28969
|
+
- password_hash
|
|
28970
|
+
- properties:
|
|
28971
|
+
password_hash_type:
|
|
28972
|
+
x-exclude-from-lint: true
|
|
28973
|
+
required:
|
|
28974
|
+
- password_hash_type
|
|
28975
|
+
- properties:
|
|
28976
|
+
password_salt_position:
|
|
28977
|
+
x-exclude-from-lint: true
|
|
28978
|
+
required:
|
|
28979
|
+
- password_salt_position
|
|
28980
|
+
- type: object
|
|
28981
|
+
properties:
|
|
28982
|
+
password:
|
|
28983
|
+
type: string
|
|
28984
|
+
description: >-
|
|
28985
|
+
The password to set for the user. Mutually exclusive with
|
|
28986
|
+
`password_hash`, `password_hash_type`, and
|
|
28987
|
+
`password_salt_position`.
|
|
28988
|
+
example: strong_password_123!
|
|
28989
|
+
required:
|
|
28990
|
+
- password
|
|
28991
|
+
not:
|
|
28992
|
+
anyOf:
|
|
28993
|
+
- properties:
|
|
28994
|
+
password_hash:
|
|
28995
|
+
x-exclude-from-lint: true
|
|
28996
|
+
required:
|
|
28997
|
+
- password_hash
|
|
28998
|
+
- properties:
|
|
28999
|
+
password_hash_type:
|
|
29000
|
+
x-exclude-from-lint: true
|
|
29001
|
+
required:
|
|
29002
|
+
- password_hash_type
|
|
29003
|
+
- properties:
|
|
29004
|
+
password_salt_position:
|
|
29005
|
+
x-exclude-from-lint: true
|
|
29006
|
+
required:
|
|
29007
|
+
- password_salt_position
|
|
29008
|
+
- type: object
|
|
29009
|
+
properties:
|
|
29010
|
+
password_hash:
|
|
29011
|
+
type: string
|
|
29012
|
+
description: >-
|
|
29013
|
+
The hashed password to set for the user. Required with
|
|
29014
|
+
`password_hash_type`. Mutually exclusive with `password`.
|
|
29015
|
+
example: $2a$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy
|
|
29016
|
+
password_hash_type:
|
|
28368
29017
|
type: string
|
|
28369
29018
|
enum: *ref_20
|
|
29019
|
+
description: >-
|
|
29020
|
+
The algorithm originally used to hash the password, used
|
|
29021
|
+
when providing a `password_hash`. Required with
|
|
29022
|
+
`password_hash`. Mutually exclusive with `password`.
|
|
29023
|
+
example: bcrypt
|
|
29024
|
+
password_salt_position:
|
|
29025
|
+
type: string
|
|
29026
|
+
enum: *ref_21
|
|
28370
29027
|
description: >-
|
|
28371
29028
|
The position of the salt relative to the password when the
|
|
28372
29029
|
`password_hash` digest was computed: `prefix` for `hash(salt
|
|
@@ -28385,7 +29042,7 @@ components:
|
|
|
28385
29042
|
x-exclude-from-lint: true
|
|
28386
29043
|
required:
|
|
28387
29044
|
- password
|
|
28388
|
-
x-mutually-exclusive-body-groups: *
|
|
29045
|
+
x-mutually-exclusive-body-groups: *ref_22
|
|
28389
29046
|
VerifyEmailAddressDto:
|
|
28390
29047
|
type: object
|
|
28391
29048
|
properties:
|
|
@@ -28494,7 +29151,7 @@ components:
|
|
|
28494
29151
|
description: The events that the Webhook Endpoint is subscribed to.
|
|
28495
29152
|
items:
|
|
28496
29153
|
type: string
|
|
28497
|
-
enum: &
|
|
29154
|
+
enum: &ref_23
|
|
28498
29155
|
- agent.blueprint.created
|
|
28499
29156
|
- agent.blueprint.deleted
|
|
28500
29157
|
- agent.blueprint.updated
|
|
@@ -28625,7 +29282,7 @@ components:
|
|
|
28625
29282
|
description: The events that the Webhook Endpoint is subscribed to.
|
|
28626
29283
|
items:
|
|
28627
29284
|
type: string
|
|
28628
|
-
enum: *
|
|
29285
|
+
enum: *ref_23
|
|
28629
29286
|
example:
|
|
28630
29287
|
- user.created
|
|
28631
29288
|
- dsync.user.created
|
|
@@ -32280,7 +32937,7 @@ components:
|
|
|
32280
32937
|
description: >-
|
|
32281
32938
|
An object containing the custom attribute mapping for the Directory
|
|
32282
32939
|
Provider.
|
|
32283
|
-
example: &
|
|
32940
|
+
example: &ref_29
|
|
32284
32941
|
department: Engineering
|
|
32285
32942
|
job_title: Software Engineer
|
|
32286
32943
|
role:
|
|
@@ -32324,6 +32981,33 @@ components:
|
|
|
32324
32981
|
type: string
|
|
32325
32982
|
description: The unique ID of the connected account.
|
|
32326
32983
|
example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
|
|
32984
|
+
connection_role:
|
|
32985
|
+
type: string
|
|
32986
|
+
enum:
|
|
32987
|
+
- compatibility
|
|
32988
|
+
- standard
|
|
32989
|
+
description: >-
|
|
32990
|
+
Whether this is the compatibility connection visible to undeclared
|
|
32991
|
+
clients or a standard connection for plural-aware clients.
|
|
32992
|
+
Historical events may omit this field.
|
|
32993
|
+
example: compatibility
|
|
32994
|
+
account_identifier:
|
|
32995
|
+
type:
|
|
32996
|
+
- string
|
|
32997
|
+
- 'null'
|
|
32998
|
+
description: >-
|
|
32999
|
+
A best-effort identifier for the provider account this connection
|
|
33000
|
+
points at. It is not the connection identifier or a selector.
|
|
33001
|
+
Historical events may omit this field.
|
|
33002
|
+
example: workspace_123
|
|
33003
|
+
account_display_name:
|
|
33004
|
+
type:
|
|
33005
|
+
- string
|
|
33006
|
+
- 'null'
|
|
33007
|
+
description: >-
|
|
33008
|
+
A mutable, non-unique display name for the provider account
|
|
33009
|
+
connection. Historical events may omit this field.
|
|
33010
|
+
example: Acme production
|
|
32327
33011
|
data_integration_id:
|
|
32328
33012
|
type: string
|
|
32329
33013
|
description: The unique ID of the data integration.
|
|
@@ -32352,6 +33036,24 @@ components:
|
|
|
32352
33036
|
example:
|
|
32353
33037
|
- repo
|
|
32354
33038
|
- user:email
|
|
33039
|
+
auth_method:
|
|
33040
|
+
type: string
|
|
33041
|
+
enum:
|
|
33042
|
+
- oauth
|
|
33043
|
+
- api_key
|
|
33044
|
+
- client_credentials
|
|
33045
|
+
description: >-
|
|
33046
|
+
How the connection authenticates. Historical events may omit this
|
|
33047
|
+
field.
|
|
33048
|
+
example: oauth
|
|
33049
|
+
api_key_last_4:
|
|
33050
|
+
type:
|
|
33051
|
+
- string
|
|
33052
|
+
- 'null'
|
|
33053
|
+
description: >-
|
|
33054
|
+
The last four characters of the API key, or null for other
|
|
33055
|
+
authentication methods. Historical events may omit this field.
|
|
33056
|
+
example: null
|
|
32355
33057
|
state:
|
|
32356
33058
|
type: string
|
|
32357
33059
|
enum:
|
|
@@ -32474,7 +33176,7 @@ components:
|
|
|
32474
33176
|
type: object
|
|
32475
33177
|
additionalProperties: {}
|
|
32476
33178
|
description: The event payload.
|
|
32477
|
-
example: &
|
|
33179
|
+
example: &ref_24
|
|
32478
33180
|
id: directory_user_01E1JG7J09H96KYP8HM9B0G5SJ
|
|
32479
33181
|
directory_id: directory_01ECAZ4NV9QMV47GW873HDCX74
|
|
32480
33182
|
organization_id: org_01EZTR6WYX1A0DSE2CYMGXQ24Y
|
|
@@ -32509,11 +33211,11 @@ components:
|
|
|
32509
33211
|
- data
|
|
32510
33212
|
- created_at
|
|
32511
33213
|
description: An event emitted by WorkOS.
|
|
32512
|
-
example: &
|
|
33214
|
+
example: &ref_34
|
|
32513
33215
|
object: event
|
|
32514
33216
|
id: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
32515
33217
|
event: dsync.user.created
|
|
32516
|
-
data: *
|
|
33218
|
+
data: *ref_24
|
|
32517
33219
|
created_at: '2021-06-25T19:07:33.155Z'
|
|
32518
33220
|
context: {}
|
|
32519
33221
|
- oneOf:
|
|
@@ -32713,7 +33415,7 @@ components:
|
|
|
32713
33415
|
description: >-
|
|
32714
33416
|
Permission slugs forming the ceiling on what sessions
|
|
32715
33417
|
minted from this blueprint may do.
|
|
32716
|
-
example: &
|
|
33418
|
+
example: &ref_25
|
|
32717
33419
|
- crm:read
|
|
32718
33420
|
- email:send
|
|
32719
33421
|
invocable_by:
|
|
@@ -32726,7 +33428,7 @@ components:
|
|
|
32726
33428
|
description: >-
|
|
32727
33429
|
Role slugs whose members may mint user-delegated
|
|
32728
33430
|
sessions from this blueprint.
|
|
32729
|
-
example: &
|
|
33431
|
+
example: &ref_26
|
|
32730
33432
|
- manager
|
|
32731
33433
|
organization_ids:
|
|
32732
33434
|
type: array
|
|
@@ -32735,7 +33437,7 @@ components:
|
|
|
32735
33437
|
description: >-
|
|
32736
33438
|
Organizations in which autonomous sessions may be
|
|
32737
33439
|
minted from this blueprint.
|
|
32738
|
-
example: &
|
|
33440
|
+
example: &ref_27
|
|
32739
33441
|
- org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
32740
33442
|
required:
|
|
32741
33443
|
- role_slugs
|
|
@@ -32894,7 +33596,7 @@ components:
|
|
|
32894
33596
|
description: >-
|
|
32895
33597
|
Permission slugs forming the ceiling on what sessions
|
|
32896
33598
|
minted from this blueprint may do.
|
|
32897
|
-
example: *
|
|
33599
|
+
example: *ref_25
|
|
32898
33600
|
invocable_by:
|
|
32899
33601
|
type: object
|
|
32900
33602
|
properties:
|
|
@@ -32905,7 +33607,7 @@ components:
|
|
|
32905
33607
|
description: >-
|
|
32906
33608
|
Role slugs whose members may mint user-delegated
|
|
32907
33609
|
sessions from this blueprint.
|
|
32908
|
-
example: *
|
|
33610
|
+
example: *ref_26
|
|
32909
33611
|
organization_ids:
|
|
32910
33612
|
type: array
|
|
32911
33613
|
items:
|
|
@@ -32913,7 +33615,7 @@ components:
|
|
|
32913
33615
|
description: >-
|
|
32914
33616
|
Organizations in which autonomous sessions may be
|
|
32915
33617
|
minted from this blueprint.
|
|
32916
|
-
example: *
|
|
33618
|
+
example: *ref_27
|
|
32917
33619
|
required:
|
|
32918
33620
|
- role_slugs
|
|
32919
33621
|
- organization_ids
|
|
@@ -33949,7 +34651,7 @@ components:
|
|
|
33949
34651
|
items:
|
|
33950
34652
|
type: string
|
|
33951
34653
|
description: The permissions granted to the API key.
|
|
33952
|
-
example: &
|
|
34654
|
+
example: &ref_28
|
|
33953
34655
|
- users:read
|
|
33954
34656
|
- users:write
|
|
33955
34657
|
created_at:
|
|
@@ -34075,7 +34777,7 @@ components:
|
|
|
34075
34777
|
items:
|
|
34076
34778
|
type: string
|
|
34077
34779
|
description: The permissions granted to the API key.
|
|
34078
|
-
example: *
|
|
34780
|
+
example: *ref_28
|
|
34079
34781
|
created_at:
|
|
34080
34782
|
type: string
|
|
34081
34783
|
description: The timestamp when the API key was created.
|
|
@@ -34199,7 +34901,7 @@ components:
|
|
|
34199
34901
|
items:
|
|
34200
34902
|
type: string
|
|
34201
34903
|
description: The permissions granted to the API key.
|
|
34202
|
-
example: *
|
|
34904
|
+
example: *ref_28
|
|
34203
34905
|
created_at:
|
|
34204
34906
|
type: string
|
|
34205
34907
|
description: The timestamp when the API key was created.
|
|
@@ -37066,7 +37768,7 @@ components:
|
|
|
37066
37768
|
description: >-
|
|
37067
37769
|
An object containing the custom attribute mapping for
|
|
37068
37770
|
the Directory Provider.
|
|
37069
|
-
example: *
|
|
37771
|
+
example: *ref_29
|
|
37070
37772
|
role:
|
|
37071
37773
|
$ref: '#/components/schemas/SlimRole'
|
|
37072
37774
|
roles:
|
|
@@ -37256,7 +37958,7 @@ components:
|
|
|
37256
37958
|
description: >-
|
|
37257
37959
|
Labels assigned to the Feature Flag for categorizing and
|
|
37258
37960
|
filtering.
|
|
37259
|
-
example: &
|
|
37961
|
+
example: &ref_30
|
|
37260
37962
|
- reports
|
|
37261
37963
|
enabled:
|
|
37262
37964
|
type: boolean
|
|
@@ -37417,7 +38119,7 @@ components:
|
|
|
37417
38119
|
description: >-
|
|
37418
38120
|
Labels assigned to the Feature Flag for categorizing and
|
|
37419
38121
|
filtering.
|
|
37420
|
-
example: *
|
|
38122
|
+
example: *ref_30
|
|
37421
38123
|
enabled:
|
|
37422
38124
|
type: boolean
|
|
37423
38125
|
description: >-
|
|
@@ -37577,7 +38279,7 @@ components:
|
|
|
37577
38279
|
description: >-
|
|
37578
38280
|
Labels assigned to the Feature Flag for categorizing and
|
|
37579
38281
|
filtering.
|
|
37580
|
-
example: *
|
|
38282
|
+
example: *ref_30
|
|
37581
38283
|
enabled:
|
|
37582
38284
|
type: boolean
|
|
37583
38285
|
description: >-
|
|
@@ -37857,7 +38559,7 @@ components:
|
|
|
37857
38559
|
description: >-
|
|
37858
38560
|
Labels assigned to the Feature Flag for categorizing and
|
|
37859
38561
|
filtering.
|
|
37860
|
-
example: *
|
|
38562
|
+
example: *ref_30
|
|
37861
38563
|
enabled:
|
|
37862
38564
|
type: boolean
|
|
37863
38565
|
description: >-
|
|
@@ -38845,7 +39547,7 @@ components:
|
|
|
38845
39547
|
description: >-
|
|
38846
39548
|
Object containing [metadata](/authkit/metadata)
|
|
38847
39549
|
key/value pairs associated with the Organization.
|
|
38848
|
-
example: &
|
|
39550
|
+
example: &ref_31
|
|
38849
39551
|
tier: diamond
|
|
38850
39552
|
propertyNames:
|
|
38851
39553
|
maxLength: 40
|
|
@@ -38995,7 +39697,7 @@ components:
|
|
|
38995
39697
|
description: >-
|
|
38996
39698
|
Object containing [metadata](/authkit/metadata)
|
|
38997
39699
|
key/value pairs associated with the Organization.
|
|
38998
|
-
example: *
|
|
39700
|
+
example: *ref_31
|
|
38999
39701
|
propertyNames:
|
|
39000
39702
|
maxLength: 40
|
|
39001
39703
|
maxProperties: 50
|
|
@@ -39822,7 +40524,7 @@ components:
|
|
|
39822
40524
|
items:
|
|
39823
40525
|
type: string
|
|
39824
40526
|
description: The permissions granted by the role.
|
|
39825
|
-
example: &
|
|
40527
|
+
example: &ref_32
|
|
39826
40528
|
- users:read
|
|
39827
40529
|
- users:write
|
|
39828
40530
|
created_at:
|
|
@@ -39906,7 +40608,7 @@ components:
|
|
|
39906
40608
|
items:
|
|
39907
40609
|
type: string
|
|
39908
40610
|
description: The permissions granted by the role.
|
|
39909
|
-
example: *
|
|
40611
|
+
example: *ref_32
|
|
39910
40612
|
created_at:
|
|
39911
40613
|
format: date-time
|
|
39912
40614
|
type: string
|
|
@@ -39988,7 +40690,7 @@ components:
|
|
|
39988
40690
|
items:
|
|
39989
40691
|
type: string
|
|
39990
40692
|
description: The permissions granted by the role.
|
|
39991
|
-
example: *
|
|
40693
|
+
example: *ref_32
|
|
39992
40694
|
created_at:
|
|
39993
40695
|
format: date-time
|
|
39994
40696
|
type: string
|
|
@@ -40125,7 +40827,7 @@ components:
|
|
|
40125
40827
|
description: >-
|
|
40126
40828
|
Object containing [metadata](/authkit/metadata)
|
|
40127
40829
|
key/value pairs associated with the Organization.
|
|
40128
|
-
example: *
|
|
40830
|
+
example: *ref_31
|
|
40129
40831
|
propertyNames:
|
|
40130
40832
|
maxLength: 40
|
|
40131
40833
|
maxProperties: 50
|
|
@@ -40581,6 +41283,16 @@ components:
|
|
|
40581
41283
|
The ID of the Organization the connection attempt
|
|
40582
41284
|
belongs to.
|
|
40583
41285
|
example: org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
41286
|
+
account_identifier:
|
|
41287
|
+
type:
|
|
41288
|
+
- string
|
|
41289
|
+
- 'null'
|
|
41290
|
+
description: >-
|
|
41291
|
+
A best-effort identifier for the provider account
|
|
41292
|
+
involved in the attempt. It is not a connection
|
|
41293
|
+
identifier or selector. Historical events may omit this
|
|
41294
|
+
field.
|
|
41295
|
+
example: null
|
|
40584
41296
|
error_code:
|
|
40585
41297
|
type: string
|
|
40586
41298
|
description: A machine-readable error code for the failure.
|
|
@@ -40708,6 +41420,16 @@ components:
|
|
|
40708
41420
|
The ID of the Organization the connection attempt
|
|
40709
41421
|
belongs to.
|
|
40710
41422
|
example: org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
41423
|
+
account_identifier:
|
|
41424
|
+
type:
|
|
41425
|
+
- string
|
|
41426
|
+
- 'null'
|
|
41427
|
+
description: >-
|
|
41428
|
+
A best-effort identifier for the provider account
|
|
41429
|
+
involved in the attempt. It is not a connection
|
|
41430
|
+
identifier or selector. Historical events may omit this
|
|
41431
|
+
field.
|
|
41432
|
+
example: null
|
|
40711
41433
|
error_code:
|
|
40712
41434
|
type: string
|
|
40713
41435
|
description: A machine-readable error code for the failure.
|
|
@@ -40893,6 +41615,16 @@ components:
|
|
|
40893
41615
|
The ID of the Organization the connection attempt
|
|
40894
41616
|
belongs to.
|
|
40895
41617
|
example: org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
41618
|
+
account_identifier:
|
|
41619
|
+
type:
|
|
41620
|
+
- string
|
|
41621
|
+
- 'null'
|
|
41622
|
+
description: >-
|
|
41623
|
+
A best-effort identifier for the provider account
|
|
41624
|
+
involved in the attempt. It is not a connection
|
|
41625
|
+
identifier or selector. Historical events may omit this
|
|
41626
|
+
field.
|
|
41627
|
+
example: null
|
|
40896
41628
|
error_code:
|
|
40897
41629
|
type: string
|
|
40898
41630
|
description: A machine-readable error code for the failure.
|
|
@@ -41287,7 +42019,7 @@ components:
|
|
|
41287
42019
|
items:
|
|
41288
42020
|
type: string
|
|
41289
42021
|
description: The permissions granted by the role.
|
|
41290
|
-
example: &
|
|
42022
|
+
example: &ref_33
|
|
41291
42023
|
- users:read
|
|
41292
42024
|
- users:write
|
|
41293
42025
|
created_at:
|
|
@@ -41353,7 +42085,7 @@ components:
|
|
|
41353
42085
|
items:
|
|
41354
42086
|
type: string
|
|
41355
42087
|
description: The permissions granted by the role.
|
|
41356
|
-
example: *
|
|
42088
|
+
example: *ref_33
|
|
41357
42089
|
created_at:
|
|
41358
42090
|
format: date-time
|
|
41359
42091
|
type: string
|
|
@@ -41417,7 +42149,7 @@ components:
|
|
|
41417
42149
|
items:
|
|
41418
42150
|
type: string
|
|
41419
42151
|
description: The permissions granted by the role.
|
|
41420
|
-
example: *
|
|
42152
|
+
example: *ref_33
|
|
41421
42153
|
created_at:
|
|
41422
42154
|
format: date-time
|
|
41423
42155
|
type: string
|
|
@@ -42557,7 +43289,7 @@ components:
|
|
|
42557
43289
|
- data
|
|
42558
43290
|
- created_at
|
|
42559
43291
|
- object
|
|
42560
|
-
example: *
|
|
43292
|
+
example: *ref_34
|
|
42561
43293
|
description: An event emitted by WorkOS.
|
|
42562
43294
|
EventList:
|
|
42563
43295
|
type: object
|
|
@@ -42592,7 +43324,7 @@ components:
|
|
|
42592
43324
|
example:
|
|
42593
43325
|
object: list
|
|
42594
43326
|
data:
|
|
42595
|
-
- *
|
|
43327
|
+
- *ref_34
|
|
42596
43328
|
list_metadata:
|
|
42597
43329
|
after: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
42598
43330
|
JwtTemplate:
|
|
@@ -43669,6 +44401,30 @@ components:
|
|
|
43669
44401
|
type: string
|
|
43670
44402
|
description: Unique identifier of the installation.
|
|
43671
44403
|
example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
|
|
44404
|
+
connection_role:
|
|
44405
|
+
type: string
|
|
44406
|
+
enum:
|
|
44407
|
+
- compatibility
|
|
44408
|
+
- standard
|
|
44409
|
+
description: >-
|
|
44410
|
+
Whether this is the compatibility connection visible to
|
|
44411
|
+
undeclared clients or a standard connection for plural-aware
|
|
44412
|
+
clients.
|
|
44413
|
+
example: compatibility
|
|
44414
|
+
account_identifier:
|
|
44415
|
+
type:
|
|
44416
|
+
- string
|
|
44417
|
+
- 'null'
|
|
44418
|
+
description: >-
|
|
44419
|
+
A best-effort provider account identifier used for
|
|
44420
|
+
correlation, not connection selection.
|
|
44421
|
+
example: workspace_123
|
|
44422
|
+
account_display_name:
|
|
44423
|
+
type:
|
|
44424
|
+
- string
|
|
44425
|
+
- 'null'
|
|
44426
|
+
description: A mutable, non-unique display name for this connection.
|
|
44427
|
+
example: Acme production
|
|
43672
44428
|
user_id:
|
|
43673
44429
|
type:
|
|
43674
44430
|
- string
|
|
@@ -43697,6 +44453,9 @@ components:
|
|
|
43697
44453
|
example: cdef
|
|
43698
44454
|
required:
|
|
43699
44455
|
- id
|
|
44456
|
+
- connection_role
|
|
44457
|
+
- account_identifier
|
|
44458
|
+
- account_display_name
|
|
43700
44459
|
- user_id
|
|
43701
44460
|
- organization_id
|
|
43702
44461
|
- api_key_last_4
|
|
@@ -44208,6 +44967,33 @@ components:
|
|
|
44208
44967
|
type: string
|
|
44209
44968
|
description: The unique identifier of the connected account.
|
|
44210
44969
|
example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
|
|
44970
|
+
connection_role:
|
|
44971
|
+
type: string
|
|
44972
|
+
enum:
|
|
44973
|
+
- compatibility
|
|
44974
|
+
- standard
|
|
44975
|
+
description: >-
|
|
44976
|
+
Whether this row is the compatibility connection visible to
|
|
44977
|
+
undeclared clients or a standard peer for plural-aware clients. The
|
|
44978
|
+
role does not indicate preference or creation order.
|
|
44979
|
+
example: compatibility
|
|
44980
|
+
account_identifier:
|
|
44981
|
+
type:
|
|
44982
|
+
- string
|
|
44983
|
+
- 'null'
|
|
44984
|
+
description: >-
|
|
44985
|
+
A best-effort identifier for the provider account this connection
|
|
44986
|
+
points at. It is correlation metadata, not the connection identifier
|
|
44987
|
+
or a selector.
|
|
44988
|
+
example: workspace_123
|
|
44989
|
+
account_display_name:
|
|
44990
|
+
type:
|
|
44991
|
+
- string
|
|
44992
|
+
- 'null'
|
|
44993
|
+
description: >-
|
|
44994
|
+
A mutable, non-unique display name for the provider account
|
|
44995
|
+
connection.
|
|
44996
|
+
example: Acme production
|
|
44211
44997
|
user_id:
|
|
44212
44998
|
type:
|
|
44213
44999
|
- string
|
|
@@ -44305,6 +45091,9 @@ components:
|
|
|
44305
45091
|
required:
|
|
44306
45092
|
- object
|
|
44307
45093
|
- id
|
|
45094
|
+
- connection_role
|
|
45095
|
+
- account_identifier
|
|
45096
|
+
- account_display_name
|
|
44308
45097
|
- user_id
|
|
44309
45098
|
- organization_id
|
|
44310
45099
|
- scopes
|
|
@@ -44430,6 +45219,34 @@ components:
|
|
|
44430
45219
|
type: string
|
|
44431
45220
|
description: The unique identifier of the connected account.
|
|
44432
45221
|
example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
|
|
45222
|
+
connection_role:
|
|
45223
|
+
type: string
|
|
45224
|
+
enum:
|
|
45225
|
+
- compatibility
|
|
45226
|
+
- standard
|
|
45227
|
+
description: >-
|
|
45228
|
+
Whether this row is the compatibility connection
|
|
45229
|
+
visible to undeclared clients or a standard peer for
|
|
45230
|
+
plural-aware clients. The role does not indicate
|
|
45231
|
+
preference or creation order.
|
|
45232
|
+
example: compatibility
|
|
45233
|
+
account_identifier:
|
|
45234
|
+
type:
|
|
45235
|
+
- string
|
|
45236
|
+
- 'null'
|
|
45237
|
+
description: >-
|
|
45238
|
+
A best-effort identifier for the provider account this
|
|
45239
|
+
connection points at. It is correlation metadata, not
|
|
45240
|
+
the connection identifier or a selector.
|
|
45241
|
+
example: workspace_123
|
|
45242
|
+
account_display_name:
|
|
45243
|
+
type:
|
|
45244
|
+
- string
|
|
45245
|
+
- 'null'
|
|
45246
|
+
description: >-
|
|
45247
|
+
A mutable, non-unique display name for the provider
|
|
45248
|
+
account connection.
|
|
45249
|
+
example: Acme production
|
|
44433
45250
|
user_id:
|
|
44434
45251
|
type:
|
|
44435
45252
|
- string
|
|
@@ -44452,7 +45269,7 @@ components:
|
|
|
44452
45269
|
items:
|
|
44453
45270
|
type: string
|
|
44454
45271
|
description: The OAuth scopes granted for this connection.
|
|
44455
|
-
example: &
|
|
45272
|
+
example: &ref_35
|
|
44456
45273
|
- repo
|
|
44457
45274
|
- user:email
|
|
44458
45275
|
auth_method:
|
|
@@ -44502,7 +45319,7 @@ components:
|
|
|
44502
45319
|
`installation` scope, excluding any it declares as
|
|
44503
45320
|
secret. Only present when `auth_method` is
|
|
44504
45321
|
`client_credentials`.
|
|
44505
|
-
example: &
|
|
45322
|
+
example: &ref_36
|
|
44506
45323
|
instance_url: https://example.my.salesforce.com
|
|
44507
45324
|
state:
|
|
44508
45325
|
type: string
|
|
@@ -44554,6 +45371,9 @@ components:
|
|
|
44554
45371
|
required:
|
|
44555
45372
|
- object
|
|
44556
45373
|
- id
|
|
45374
|
+
- connection_role
|
|
45375
|
+
- account_identifier
|
|
45376
|
+
- account_display_name
|
|
44557
45377
|
- user_id
|
|
44558
45378
|
- organization_id
|
|
44559
45379
|
- scopes
|
|
@@ -44578,6 +45398,34 @@ components:
|
|
|
44578
45398
|
type: string
|
|
44579
45399
|
description: The unique identifier of the connected account.
|
|
44580
45400
|
example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
|
|
45401
|
+
connection_role:
|
|
45402
|
+
type: string
|
|
45403
|
+
enum:
|
|
45404
|
+
- compatibility
|
|
45405
|
+
- standard
|
|
45406
|
+
description: >-
|
|
45407
|
+
Whether this row is the compatibility connection visible
|
|
45408
|
+
to undeclared clients or a standard peer for
|
|
45409
|
+
plural-aware clients. The role does not indicate
|
|
45410
|
+
preference or creation order.
|
|
45411
|
+
example: compatibility
|
|
45412
|
+
account_identifier:
|
|
45413
|
+
type:
|
|
45414
|
+
- string
|
|
45415
|
+
- 'null'
|
|
45416
|
+
description: >-
|
|
45417
|
+
A best-effort identifier for the provider account this
|
|
45418
|
+
connection points at. It is correlation metadata, not
|
|
45419
|
+
the connection identifier or a selector.
|
|
45420
|
+
example: workspace_123
|
|
45421
|
+
account_display_name:
|
|
45422
|
+
type:
|
|
45423
|
+
- string
|
|
45424
|
+
- 'null'
|
|
45425
|
+
description: >-
|
|
45426
|
+
A mutable, non-unique display name for the provider
|
|
45427
|
+
account connection.
|
|
45428
|
+
example: Acme production
|
|
44581
45429
|
user_id:
|
|
44582
45430
|
type:
|
|
44583
45431
|
- string
|
|
@@ -44600,7 +45448,7 @@ components:
|
|
|
44600
45448
|
items:
|
|
44601
45449
|
type: string
|
|
44602
45450
|
description: The OAuth scopes granted for this connection.
|
|
44603
|
-
example: *
|
|
45451
|
+
example: *ref_35
|
|
44604
45452
|
auth_method:
|
|
44605
45453
|
type: string
|
|
44606
45454
|
enum:
|
|
@@ -44647,7 +45495,7 @@ components:
|
|
|
44647
45495
|
`installation` scope, excluding any it declares as
|
|
44648
45496
|
secret. Only present when `auth_method` is
|
|
44649
45497
|
`client_credentials`.
|
|
44650
|
-
example: *
|
|
45498
|
+
example: *ref_36
|
|
44651
45499
|
state:
|
|
44652
45500
|
type: string
|
|
44653
45501
|
enum:
|
|
@@ -44697,6 +45545,9 @@ components:
|
|
|
44697
45545
|
required:
|
|
44698
45546
|
- object
|
|
44699
45547
|
- id
|
|
45548
|
+
- connection_role
|
|
45549
|
+
- account_identifier
|
|
45550
|
+
- account_display_name
|
|
44700
45551
|
- user_id
|
|
44701
45552
|
- organization_id
|
|
44702
45553
|
- scopes
|