@workos/openapi-spec 0.94.0 → 0.95.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.
@@ -3649,7 +3649,7 @@ paths:
3649
3649
  summary: Check authorization
3650
3650
  tags:
3651
3651
  - authorization
3652
- x-mutually-exclusive-body-groups: &ref_4
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: &ref_5
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: &ref_6
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: &ref_7
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: &ref_8
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: &ref_11
10156
+ x-mutually-exclusive-body-groups: &ref_12
10157
10157
  protocol_options:
10158
10158
  optional: true
10159
10159
  variants:
@@ -10806,14 +10806,31 @@ paths:
10806
10806
  properties:
10807
10807
  user_id:
10808
10808
  type: string
10809
- description: The ID of the user to authorize.
10809
+ description: >-
10810
+ The ID of the user to authorize. When `connection_owner` is
10811
+ `organization`, this is the user authorizing on behalf of
10812
+ the organization; they must be an active member of the
10813
+ organization and do not become the owner of the resulting
10814
+ connected account.
10810
10815
  example: user_01EHZNVPK3SFK441A1RGBFSHRT
10811
10816
  organization_id:
10812
10817
  type: string
10813
10818
  description: >-
10814
10819
  An organization ID to scope the authorization to a specific
10815
- organization.
10820
+ organization. Required when `connection_owner` is
10821
+ `organization`.
10816
10822
  example: org_01EHZNVPK3SFK441A1RGBFSHRT
10823
+ connection_owner:
10824
+ type: string
10825
+ enum:
10826
+ - user
10827
+ - organization
10828
+ description: >-
10829
+ Who will own the connected account. `user` (the default)
10830
+ connects the user's own account. `organization` connects the
10831
+ organization's shared account and requires
10832
+ `organization_id`.
10833
+ example: user
10817
10834
  return_to:
10818
10835
  type: string
10819
10836
  format: uri
@@ -13600,7 +13617,7 @@ paths:
13600
13617
  summary: Set Retention
13601
13618
  tags:
13602
13619
  - audit-logs
13603
- x-mutually-exclusive-body-groups: &ref_3
13620
+ x-mutually-exclusive-body-groups: &ref_4
13604
13621
  retention:
13605
13622
  optional: false
13606
13623
  variants:
@@ -14690,6 +14707,623 @@ paths:
14690
14707
  summary: List authorized applications
14691
14708
  tags:
14692
14709
  - organizations.authorized-applications
14710
+ /organizations/{organization_id}/connected_accounts/{slug}:
14711
+ get:
14712
+ description: >-
14713
+ Retrieves an organization's [connected
14714
+ account](/reference/pipes/connected-account) for a specific provider.
14715
+ operationId: DataIntegrationsOrganizationController_getOrganizationDataInstallation
14716
+ parameters:
14717
+ - name: organization_id
14718
+ required: true
14719
+ in: path
14720
+ description: An [Organization](/reference/organization) identifier.
14721
+ schema:
14722
+ example: org_01EHZNVPK3SFK441A1RGBFSHRT
14723
+ type: string
14724
+ - name: slug
14725
+ required: true
14726
+ in: path
14727
+ description: >-
14728
+ The slug identifier of the provider (e.g., `github`, `slack`,
14729
+ `notion`).
14730
+ schema:
14731
+ example: github
14732
+ type: string
14733
+ - name: supports_multiple_connections
14734
+ required: false
14735
+ in: query
14736
+ description: >-
14737
+ Set to `true` to use the plural connection contract. When omitted or
14738
+ `false`, only the compatibility connection is considered.
14739
+ schema:
14740
+ example: true
14741
+ type: boolean
14742
+ - name: connected_account_id
14743
+ required: false
14744
+ in: query
14745
+ description: >-
14746
+ A [connected account](/reference/pipes/connected-account)
14747
+ identifier. Use this to select a specific connection when the
14748
+ organization has several for this provider.
14749
+ schema:
14750
+ minLength: 1
14751
+ example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
14752
+ type: string
14753
+ responses:
14754
+ '200':
14755
+ description: The connected account was retrieved successfully.
14756
+ content:
14757
+ application/json:
14758
+ schema:
14759
+ $ref: '#/components/schemas/ConnectedAccount'
14760
+ example:
14761
+ object: connected_account
14762
+ id: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
14763
+ user_id: null
14764
+ organization_id: org_01EHZNVPK3SFK441A1RGBFSHRT
14765
+ scopes:
14766
+ - repo
14767
+ - user:email
14768
+ auth_method: oauth
14769
+ api_key_last_4: null
14770
+ client_id: 3MVG9dZJodJWxft2VoStSCVwPFsx0eDcpVc
14771
+ client_secret_last_4: cdef
14772
+ config:
14773
+ instance_url: https://example.my.salesforce.com
14774
+ state: connected
14775
+ created_at: '2024-01-16T14:20:00.000Z'
14776
+ updated_at: '2024-01-16T14:20:00.000Z'
14777
+ '400':
14778
+ description: The connected account selector is malformed.
14779
+ content:
14780
+ application/json:
14781
+ schema:
14782
+ type: object
14783
+ properties:
14784
+ message:
14785
+ type: string
14786
+ description: A human-readable description of the error.
14787
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
14788
+ required:
14789
+ - message
14790
+ '401':
14791
+ description: The request is missing a valid API key.
14792
+ '404':
14793
+ description: The organization or connected account was not found.
14794
+ content:
14795
+ application/json:
14796
+ schema:
14797
+ type: object
14798
+ properties:
14799
+ message:
14800
+ type: string
14801
+ description: A human-readable description of the error.
14802
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
14803
+ required:
14804
+ - message
14805
+ '409':
14806
+ description: >-
14807
+ Several connected accounts match this organization for the provider;
14808
+ one must be named.
14809
+ content:
14810
+ application/json:
14811
+ schema:
14812
+ $ref: '#/components/schemas/AccountSelectionRequiredError'
14813
+ summary: Get an organization connected account
14814
+ tags:
14815
+ - organizations.data-providers
14816
+ x-feature-flag: pipes-org-integrations
14817
+ delete:
14818
+ description: >-
14819
+ Disconnects the organization's account for the provider, including
14820
+ removing any stored access and refresh tokens. A member will need to
14821
+ reauthorize if the organization wants to reconnect. This does not revoke
14822
+ access on the provider side.
14823
+ operationId: >-
14824
+ DataIntegrationsOrganizationController_deleteOrganizationDataInstallation
14825
+ parameters:
14826
+ - name: organization_id
14827
+ required: true
14828
+ in: path
14829
+ description: An [Organization](/reference/organization) identifier.
14830
+ schema:
14831
+ example: org_01EHZNVPK3SFK441A1RGBFSHRT
14832
+ type: string
14833
+ - name: slug
14834
+ required: true
14835
+ in: path
14836
+ description: >-
14837
+ The slug identifier of the provider (e.g., `github`, `slack`,
14838
+ `notion`).
14839
+ schema:
14840
+ example: github
14841
+ type: string
14842
+ - name: supports_multiple_connections
14843
+ required: false
14844
+ in: query
14845
+ description: >-
14846
+ Set to `true` to use the plural connection contract. When omitted or
14847
+ `false`, only the compatibility connection is considered.
14848
+ schema:
14849
+ example: true
14850
+ type: boolean
14851
+ - name: connected_account_id
14852
+ required: false
14853
+ in: query
14854
+ description: >-
14855
+ A [connected account](/reference/pipes/connected-account)
14856
+ identifier. Use this to select the connection to delete.
14857
+ schema:
14858
+ minLength: 1
14859
+ example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
14860
+ type: string
14861
+ responses:
14862
+ '204':
14863
+ description: The connected account was deleted successfully.
14864
+ '400':
14865
+ description: The connected account selector is malformed.
14866
+ content:
14867
+ application/json:
14868
+ schema:
14869
+ type: object
14870
+ properties:
14871
+ message:
14872
+ type: string
14873
+ description: A human-readable description of the error.
14874
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
14875
+ required:
14876
+ - message
14877
+ '401':
14878
+ description: The request is missing a valid API key.
14879
+ '404':
14880
+ description: The organization or connected account was not found.
14881
+ content:
14882
+ application/json:
14883
+ schema:
14884
+ type: object
14885
+ properties:
14886
+ message:
14887
+ type: string
14888
+ description: A human-readable description of the error.
14889
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
14890
+ required:
14891
+ - message
14892
+ '409':
14893
+ description: >-
14894
+ Several connected accounts match this organization for the provider;
14895
+ one must be named.
14896
+ content:
14897
+ application/json:
14898
+ schema:
14899
+ $ref: '#/components/schemas/AccountSelectionRequiredError'
14900
+ '503':
14901
+ description: >-
14902
+ The connected account or its WorkOS OAuth grant is being changed by
14903
+ another request. Retry the request.
14904
+ content:
14905
+ application/json:
14906
+ schema:
14907
+ type: object
14908
+ properties:
14909
+ code:
14910
+ type: string
14911
+ description: The error code identifying the type of error.
14912
+ example: concurrent_request
14913
+ const: concurrent_request
14914
+ message:
14915
+ type: string
14916
+ description: A human-readable description of the error.
14917
+ example: Request could not be processed.
14918
+ required:
14919
+ - code
14920
+ - message
14921
+ summary: Delete an organization connected account
14922
+ tags:
14923
+ - organizations.data-providers
14924
+ x-feature-flag: pipes-org-integrations
14925
+ post:
14926
+ description: >-
14927
+ Imports an organization-owned [connected
14928
+ account](/reference/pipes/connected-account) by providing OAuth tokens
14929
+ directly. Use this to migrate existing connections or set up connections
14930
+ without going through the OAuth flow.
14931
+ operationId: >-
14932
+ DataIntegrationsOrganizationController_createOrganizationDataInstallation
14933
+ parameters:
14934
+ - name: organization_id
14935
+ required: true
14936
+ in: path
14937
+ description: An [Organization](/reference/organization) identifier.
14938
+ schema:
14939
+ example: org_01EHZNVPK3SFK441A1RGBFSHRT
14940
+ type: string
14941
+ - name: slug
14942
+ required: true
14943
+ in: path
14944
+ description: >-
14945
+ The slug identifier of the provider (e.g., `github`, `slack`,
14946
+ `notion`).
14947
+ schema:
14948
+ example: github
14949
+ type: string
14950
+ requestBody:
14951
+ required: true
14952
+ content:
14953
+ application/json:
14954
+ schema:
14955
+ $ref: '#/components/schemas/ConnectedAccountDto'
14956
+ responses:
14957
+ '201':
14958
+ description: The connected account was created successfully.
14959
+ content:
14960
+ application/json:
14961
+ schema:
14962
+ $ref: '#/components/schemas/ConnectedAccount'
14963
+ example:
14964
+ object: connected_account
14965
+ id: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
14966
+ user_id: null
14967
+ organization_id: org_01EHZNVPK3SFK441A1RGBFSHRT
14968
+ scopes:
14969
+ - repo
14970
+ - user:email
14971
+ auth_method: oauth
14972
+ api_key_last_4: null
14973
+ client_id: 3MVG9dZJodJWxft2VoStSCVwPFsx0eDcpVc
14974
+ client_secret_last_4: cdef
14975
+ config:
14976
+ instance_url: https://example.my.salesforce.com
14977
+ state: connected
14978
+ created_at: '2024-01-16T14:20:00.000Z'
14979
+ updated_at: '2024-01-16T14:20:00.000Z'
14980
+ '401':
14981
+ description: The request is missing a valid API key.
14982
+ '404':
14983
+ description: The organization or data integration was not found.
14984
+ content:
14985
+ application/json:
14986
+ schema:
14987
+ type: object
14988
+ properties:
14989
+ message:
14990
+ type: string
14991
+ description: A human-readable description of the error.
14992
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
14993
+ required:
14994
+ - message
14995
+ '409':
14996
+ description: >-
14997
+ A connected account already exists for this organization and
14998
+ integration.
14999
+ content:
15000
+ application/json:
15001
+ schema:
15002
+ type: object
15003
+ properties:
15004
+ message:
15005
+ type: string
15006
+ description: A human-readable description of the error.
15007
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
15008
+ required:
15009
+ - message
15010
+ '422':
15011
+ description: >-
15012
+ The request body is malformed (`invalid_request_parameters`), the
15013
+ data integration is not in a valid state
15014
+ (`invalid_data_integration_state`), the token combination is invalid
15015
+ (`invalid_token_combination`), or no client credentials are
15016
+ configured for the data integration
15017
+ (`client_credentials_not_configured`).
15018
+ content:
15019
+ application/json:
15020
+ schema:
15021
+ oneOf:
15022
+ - type: object
15023
+ properties:
15024
+ code:
15025
+ type: string
15026
+ enum:
15027
+ - invalid_token_combination
15028
+ - invalid_data_integration_state
15029
+ - client_credentials_not_configured
15030
+ description: The error code identifying the type of error.
15031
+ example: invalid_token_combination
15032
+ message:
15033
+ type: string
15034
+ description: A human-readable description of the error.
15035
+ example: Request could not be processed.
15036
+ required:
15037
+ - code
15038
+ - message
15039
+ - type: object
15040
+ properties:
15041
+ code:
15042
+ type: string
15043
+ description: The error code identifying the type of error.
15044
+ example: invalid_request_parameters
15045
+ const: invalid_request_parameters
15046
+ message:
15047
+ type: string
15048
+ description: A human-readable description of the error.
15049
+ example: Validation failed.
15050
+ errors:
15051
+ type: array
15052
+ items:
15053
+ type: object
15054
+ properties:
15055
+ code:
15056
+ type: string
15057
+ description: The validation error code.
15058
+ example: unknown_event_type
15059
+ message:
15060
+ type: string
15061
+ description: >-
15062
+ A human-readable description of the validation
15063
+ error.
15064
+ example: Invalid enum value.
15065
+ required:
15066
+ - code
15067
+ - message
15068
+ description: The list of validation errors.
15069
+ required:
15070
+ - code
15071
+ - message
15072
+ - errors
15073
+ summary: Import an organization connected account
15074
+ tags:
15075
+ - organizations.data-providers
15076
+ x-feature-flag: pipes-management-api
15077
+ put:
15078
+ description: >-
15079
+ Updates an organization's [connected
15080
+ account](/reference/pipes/connected-account) tokens, scopes, or state
15081
+ for a specific provider.
15082
+ operationId: >-
15083
+ DataIntegrationsOrganizationController_updateOrganizationDataInstallation
15084
+ parameters:
15085
+ - name: organization_id
15086
+ required: true
15087
+ in: path
15088
+ description: An [Organization](/reference/organization) identifier.
15089
+ schema:
15090
+ example: org_01EHZNVPK3SFK441A1RGBFSHRT
15091
+ type: string
15092
+ - name: slug
15093
+ required: true
15094
+ in: path
15095
+ description: >-
15096
+ The slug identifier of the provider (e.g., `github`, `slack`,
15097
+ `notion`).
15098
+ schema:
15099
+ example: github
15100
+ type: string
15101
+ - name: supports_multiple_connections
15102
+ required: false
15103
+ in: query
15104
+ description: >-
15105
+ Set to `true` to use the plural connection contract. When omitted or
15106
+ `false`, only the compatibility connection is considered.
15107
+ schema:
15108
+ example: true
15109
+ type: boolean
15110
+ - name: connected_account_id
15111
+ required: false
15112
+ in: query
15113
+ description: >-
15114
+ A [connected account](/reference/pipes/connected-account)
15115
+ identifier. Use this to select the connection to update.
15116
+ schema:
15117
+ minLength: 1
15118
+ example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
15119
+ type: string
15120
+ requestBody:
15121
+ required: true
15122
+ content:
15123
+ application/json:
15124
+ schema:
15125
+ $ref: '#/components/schemas/ConnectedAccountDto'
15126
+ responses:
15127
+ '200':
15128
+ description: The connected account was updated successfully.
15129
+ content:
15130
+ application/json:
15131
+ schema:
15132
+ $ref: '#/components/schemas/ConnectedAccount'
15133
+ example:
15134
+ object: connected_account
15135
+ id: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
15136
+ user_id: null
15137
+ organization_id: org_01EHZNVPK3SFK441A1RGBFSHRT
15138
+ scopes:
15139
+ - repo
15140
+ - user:email
15141
+ auth_method: oauth
15142
+ api_key_last_4: null
15143
+ client_id: 3MVG9dZJodJWxft2VoStSCVwPFsx0eDcpVc
15144
+ client_secret_last_4: cdef
15145
+ config:
15146
+ instance_url: https://example.my.salesforce.com
15147
+ state: connected
15148
+ created_at: '2024-01-16T14:20:00.000Z'
15149
+ updated_at: '2024-01-16T14:20:00.000Z'
15150
+ '400':
15151
+ description: The connected account selector is malformed.
15152
+ content:
15153
+ application/json:
15154
+ schema:
15155
+ type: object
15156
+ properties:
15157
+ message:
15158
+ type: string
15159
+ description: A human-readable description of the error.
15160
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
15161
+ required:
15162
+ - message
15163
+ '401':
15164
+ description: The request is missing a valid API key.
15165
+ '404':
15166
+ description: The organization or connected account was not found.
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
+ '409':
15179
+ description: >-
15180
+ Several connected accounts match this organization for the provider;
15181
+ one must be named.
15182
+ content:
15183
+ application/json:
15184
+ schema:
15185
+ $ref: '#/components/schemas/AccountSelectionRequiredError'
15186
+ '422':
15187
+ description: The request body is malformed (`invalid_request_parameters`).
15188
+ content:
15189
+ application/json:
15190
+ schema:
15191
+ type: object
15192
+ properties:
15193
+ code:
15194
+ type: string
15195
+ description: The error code identifying the type of error.
15196
+ example: invalid_request_parameters
15197
+ const: invalid_request_parameters
15198
+ message:
15199
+ type: string
15200
+ description: A human-readable description of the error.
15201
+ example: Validation failed.
15202
+ errors:
15203
+ type: array
15204
+ items:
15205
+ type: object
15206
+ properties:
15207
+ code:
15208
+ type: string
15209
+ description: The validation error code.
15210
+ example: unknown_event_type
15211
+ message:
15212
+ type: string
15213
+ description: >-
15214
+ A human-readable description of the validation
15215
+ error.
15216
+ example: Invalid enum value.
15217
+ required:
15218
+ - code
15219
+ - message
15220
+ description: The list of validation errors.
15221
+ required:
15222
+ - code
15223
+ - message
15224
+ - errors
15225
+ summary: Update an organization connected account
15226
+ tags:
15227
+ - organizations.data-providers
15228
+ x-feature-flag: pipes-management-api
15229
+ /organizations/{organization_id}/data_providers:
15230
+ get:
15231
+ description: >-
15232
+ Retrieves the organization-owned providers configured for your
15233
+ environment and the organization's [connected
15234
+ account](/reference/pipes/connected-account) information for each.
15235
+ Providers owned by individual users are not included.
15236
+ operationId: DataIntegrationsOrganizationController_getOrganizationDataIntegrations
15237
+ parameters:
15238
+ - name: organization_id
15239
+ required: true
15240
+ in: path
15241
+ description: >-
15242
+ An [Organization](/reference/organization) identifier to list
15243
+ providers and connected accounts for.
15244
+ schema:
15245
+ example: org_01EHZNVPK3SFK441A1RGBFSHRT
15246
+ type: string
15247
+ - name: supports_multiple_connections
15248
+ required: false
15249
+ in: query
15250
+ description: >-
15251
+ Set to `true` to use the plural connection contract. When omitted or
15252
+ `false`, only the compatibility connection is considered.
15253
+ schema:
15254
+ example: true
15255
+ type: boolean
15256
+ responses:
15257
+ '200':
15258
+ description: The list of data providers was retrieved successfully.
15259
+ content:
15260
+ application/json:
15261
+ schema:
15262
+ $ref: '#/components/schemas/DataIntegrationsListResponse'
15263
+ example:
15264
+ object: list
15265
+ data:
15266
+ - object: data_provider
15267
+ id: data_integration_01EHZNVPK3SFK441A1RGBFSHRT
15268
+ name: GitHub
15269
+ description: Connect your GitHub account to access repositories.
15270
+ slug: github
15271
+ integration_type: github
15272
+ credentials_type: oauth2
15273
+ scopes:
15274
+ - repo
15275
+ - user:email
15276
+ auth_methods:
15277
+ - oauth
15278
+ ownership: organization
15279
+ created_at: '2024-01-15T10:30:00.000Z'
15280
+ updated_at: '2024-01-15T10:30:00.000Z'
15281
+ integrationType: github
15282
+ credentialsType: oauth2
15283
+ createdAt: '2024-01-15T10:30:00.000Z'
15284
+ updatedAt: '2024-01-15T10:30:00.000Z'
15285
+ connected_account: &ref_1
15286
+ object: connected_account
15287
+ id: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
15288
+ user_id: null
15289
+ organization_id: org_01EHZNVPK3SFK441A1RGBFSHRT
15290
+ scopes:
15291
+ - repo
15292
+ - user:email
15293
+ auth_method: oauth
15294
+ api_key_last_4: null
15295
+ client_id: 3MVG9dZJodJWxft2VoStSCVwPFsx0eDcpVc
15296
+ client_secret_last_4: cdef
15297
+ config:
15298
+ instance_url: https://example.my.salesforce.com
15299
+ state: connected
15300
+ created_at: '2024-01-16T14:20:00.000Z'
15301
+ updated_at: '2024-01-16T14:20:00.000Z'
15302
+ userlandUserId: null
15303
+ organizationId: org_01EHZNVPK3SFK441A1RGBFSHRT
15304
+ createdAt: '2024-01-16T14:20:00.000Z'
15305
+ updatedAt: '2024-01-16T14:20:00.000Z'
15306
+ connected_accounts:
15307
+ - *ref_1
15308
+ '401':
15309
+ description: The request is missing a valid API key.
15310
+ '404':
15311
+ description: The organization was not found.
15312
+ content:
15313
+ application/json:
15314
+ schema:
15315
+ type: object
15316
+ properties:
15317
+ message:
15318
+ type: string
15319
+ description: A human-readable description of the error.
15320
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
15321
+ required:
15322
+ - message
15323
+ summary: List providers for an organization
15324
+ tags:
15325
+ - organizations.data-providers
15326
+ x-feature-flag: pipes-org-integrations
14693
15327
  /organizations/{organization_id}/it_contacts:
14694
15328
  get:
14695
15329
  description: Get the IT contacts for an organization.
@@ -19568,7 +20202,7 @@ paths:
19568
20202
  summary: Create an organization membership
19569
20203
  tags:
19570
20204
  - user-management.organization-membership
19571
- x-mutually-exclusive-body-groups: &ref_15
20205
+ x-mutually-exclusive-body-groups: &ref_16
19572
20206
  role:
19573
20207
  optional: true
19574
20208
  variants:
@@ -19752,7 +20386,7 @@ paths:
19752
20386
  summary: Update an organization membership
19753
20387
  tags:
19754
20388
  - user-management.organization-membership
19755
- x-mutually-exclusive-body-groups: &ref_16
20389
+ x-mutually-exclusive-body-groups: &ref_17
19756
20390
  role:
19757
20391
  optional: true
19758
20392
  variants:
@@ -21072,7 +21706,7 @@ paths:
21072
21706
  summary: Create a user
21073
21707
  tags:
21074
21708
  - user-management.users
21075
- x-mutually-exclusive-body-groups: &ref_17
21709
+ x-mutually-exclusive-body-groups: &ref_18
21076
21710
  password:
21077
21711
  optional: true
21078
21712
  variants:
@@ -21365,7 +21999,7 @@ paths:
21365
21999
  summary: Update a user
21366
22000
  tags:
21367
22001
  - user-management.users
21368
- x-mutually-exclusive-body-groups: &ref_21
22002
+ x-mutually-exclusive-body-groups: &ref_22
21369
22003
  password:
21370
22004
  optional: true
21371
22005
  variants:
@@ -23087,8 +23721,10 @@ paths:
23087
23721
  The request body is malformed (`invalid_request_parameters`), the
23088
23722
  data integration is not in a valid state
23089
23723
  (`invalid_data_integration_state`), the token combination is invalid
23090
- (`invalid_token_combination`), or `refresh_token` is not an active
23091
- WorkOS OAuth grant of this user (`invalid_refresh_token`).
23724
+ (`invalid_token_combination`), no client credentials are configured
23725
+ for the data integration (`client_credentials_not_configured`), or
23726
+ `refresh_token` is not an active WorkOS OAuth grant of this user
23727
+ (`invalid_refresh_token`).
23092
23728
  content:
23093
23729
  application/json:
23094
23730
  schema:
@@ -23101,6 +23737,7 @@ paths:
23101
23737
  - invalid_refresh_token
23102
23738
  - invalid_token_combination
23103
23739
  - invalid_data_integration_state
23740
+ - client_credentials_not_configured
23104
23741
  description: The error code identifying the type of error.
23105
23742
  example: invalid_refresh_token
23106
23743
  message:
@@ -25061,6 +25698,8 @@ tags:
25061
25698
  description: Manage organization-scoped API keys.
25062
25699
  - name: organizations.authorized-applications
25063
25700
  description: Manage authorized applications for organizations.
25701
+ - name: organizations.data-providers
25702
+ description: Manage organization-owned data providers and connected accounts.
25064
25703
  - name: organizations.feature-flags
25065
25704
  description: Manage organization-scoped feature flags.
25066
25705
  - name: organizations.it-contacts
@@ -25302,7 +25941,7 @@ components:
25302
25941
  example: An application for managing user access
25303
25942
  scopes:
25304
25943
  description: The OAuth scopes granted to the application.
25305
- example: &ref_1
25944
+ example: &ref_2
25306
25945
  - openid
25307
25946
  - profile
25308
25947
  - email
@@ -25364,7 +26003,7 @@ components:
25364
26003
  example: An application for managing user access
25365
26004
  scopes:
25366
26005
  description: The OAuth scopes granted to the application.
25367
- example: *ref_1
26006
+ example: *ref_2
25368
26007
  type:
25369
26008
  - array
25370
26009
  - 'null'
@@ -25437,7 +26076,7 @@ components:
25437
26076
  owner: user_01GBTCQ2
25438
26077
  maxProperties: 50
25439
26078
  additionalProperties: false
25440
- patternProperties: &ref_2
26079
+ patternProperties: &ref_3
25441
26080
  ^[a-zA-Z0-9_-]{0,40}$:
25442
26081
  anyOf:
25443
26082
  - type: string
@@ -25469,7 +26108,7 @@ components:
25469
26108
  owner: user_01GBTCQ2
25470
26109
  maxProperties: 50
25471
26110
  additionalProperties: false
25472
- patternProperties: *ref_2
26111
+ patternProperties: *ref_3
25473
26112
  required:
25474
26113
  - id
25475
26114
  - type
@@ -25516,7 +26155,7 @@ components:
25516
26155
  owner: user_01GBTCQ2
25517
26156
  maxProperties: 50
25518
26157
  additionalProperties: false
25519
- patternProperties: *ref_2
26158
+ patternProperties: *ref_3
25520
26159
  version:
25521
26160
  type: integer
25522
26161
  description: What schema version the event is associated with.
@@ -25598,7 +26237,7 @@ components:
25598
26237
  - range_start
25599
26238
  - range_end
25600
26239
  UpdateAuditLogsRetentionDto:
25601
- x-mutually-exclusive-body-groups: *ref_3
26240
+ x-mutually-exclusive-body-groups: *ref_4
25602
26241
  oneOf:
25603
26242
  - type: object
25604
26243
  properties:
@@ -25783,7 +26422,7 @@ components:
25783
26422
  x-exclude-from-lint: true
25784
26423
  required:
25785
26424
  - resource_id
25786
- x-mutually-exclusive-body-groups: *ref_4
26425
+ x-mutually-exclusive-body-groups: *ref_5
25787
26426
  CreateGroupRoleAssignmentDto:
25788
26427
  type: object
25789
26428
  properties:
@@ -25924,7 +26563,7 @@ components:
25924
26563
  x-exclude-from-lint: true
25925
26564
  required:
25926
26565
  - resource_id
25927
- x-mutually-exclusive-body-groups: *ref_5
26566
+ x-mutually-exclusive-body-groups: *ref_6
25928
26567
  RemoveRoleDto:
25929
26568
  allOf:
25930
26569
  - type: object
@@ -25983,7 +26622,7 @@ components:
25983
26622
  x-exclude-from-lint: true
25984
26623
  required:
25985
26624
  - resource_id
25986
- x-mutually-exclusive-body-groups: *ref_6
26625
+ x-mutually-exclusive-body-groups: *ref_7
25987
26626
  SetRolePermissionsDto:
25988
26627
  type: object
25989
26628
  properties:
@@ -26333,7 +26972,7 @@ components:
26333
26972
  x-exclude-from-lint: true
26334
26973
  required:
26335
26974
  - parent_resource_id
26336
- x-mutually-exclusive-body-groups: *ref_7
26975
+ x-mutually-exclusive-body-groups: *ref_8
26337
26976
  CreateConnectionKeyPairDto:
26338
26977
  type: object
26339
26978
  properties:
@@ -26451,7 +27090,7 @@ components:
26451
27090
  default: true
26452
27091
  token_authentication_method:
26453
27092
  type: string
26454
- enum: &ref_9
27093
+ enum: &ref_10
26455
27094
  - client_secret_post
26456
27095
  - client_secret_basic
26457
27096
  - private_key_jwt
@@ -26467,7 +27106,7 @@ components:
26467
27106
  $ref: '#/components/schemas/CreateConnectionKeyPairDto'
26468
27107
  id_token_signature_algorithm:
26469
27108
  type: string
26470
- enum: &ref_10
27109
+ enum: &ref_11
26471
27110
  - ES256
26472
27111
  - ES384
26473
27112
  - ES512
@@ -26623,7 +27262,7 @@ components:
26623
27262
  x-exclude-from-lint: true
26624
27263
  required:
26625
27264
  - saml_options
26626
- x-mutually-exclusive-body-groups: *ref_8
27265
+ x-mutually-exclusive-body-groups: *ref_9
26627
27266
  PatchConnectionSamlOptionsDto:
26628
27267
  type: object
26629
27268
  properties:
@@ -26699,7 +27338,7 @@ components:
26699
27338
  example: true
26700
27339
  token_authentication_method:
26701
27340
  type: string
26702
- enum: *ref_9
27341
+ enum: *ref_10
26703
27342
  description: >-
26704
27343
  The token-endpoint client authentication method. Moving to
26705
27344
  `private_key_jwt` generates a signing key pair if the connection has
@@ -26709,7 +27348,7 @@ components:
26709
27348
  example: client_secret_basic
26710
27349
  id_token_signature_algorithm:
26711
27350
  type: string
26712
- enum: *ref_10
27351
+ enum: *ref_11
26713
27352
  description: The ID-token signing algorithm.
26714
27353
  example: RS256
26715
27354
  fetch_user_info:
@@ -26853,7 +27492,7 @@ components:
26853
27492
  x-exclude-from-lint: true
26854
27493
  required:
26855
27494
  - saml_options
26856
- x-mutually-exclusive-body-groups: *ref_11
27495
+ x-mutually-exclusive-body-groups: *ref_12
26857
27496
  CreateCorsOriginDto:
26858
27497
  type: object
26859
27498
  properties:
@@ -27035,11 +27674,11 @@ components:
27035
27674
  type:
27036
27675
  - object
27037
27676
  - 'null'
27038
- additionalProperties: &ref_12
27677
+ additionalProperties: &ref_13
27039
27678
  type: string
27040
27679
  maxLength: 600
27041
27680
  maxProperties: 50
27042
- example: &ref_13
27681
+ example: &ref_14
27043
27682
  tier: diamond
27044
27683
  description: >-
27045
27684
  Object containing [metadata](/authkit/metadata) key/value pairs
@@ -27094,9 +27733,9 @@ components:
27094
27733
  type:
27095
27734
  - object
27096
27735
  - 'null'
27097
- additionalProperties: *ref_12
27736
+ additionalProperties: *ref_13
27098
27737
  maxProperties: 50
27099
- example: *ref_13
27738
+ example: *ref_14
27100
27739
  description: >-
27101
27740
  Object containing [metadata](/authkit/metadata) key/value pairs
27102
27741
  associated with the Organization.
@@ -27230,7 +27869,7 @@ components:
27230
27869
  example: application/x-www-form-urlencoded
27231
27870
  authenticate_via:
27232
27871
  type: string
27233
- enum: &ref_14
27872
+ enum: &ref_15
27234
27873
  - request_body
27235
27874
  - basic_auth_header
27236
27875
  description: >-
@@ -27398,7 +28037,7 @@ components:
27398
28037
  example: application/x-www-form-urlencoded
27399
28038
  authenticate_via:
27400
28039
  type: string
27401
- enum: *ref_14
28040
+ enum: *ref_15
27402
28041
  description: >-
27403
28042
  How client credentials are sent when exchanging authorization codes
27404
28043
  and refreshing tokens.
@@ -27983,9 +28622,9 @@ components:
27983
28622
  x-exclude-from-lint: true
27984
28623
  required:
27985
28624
  - role_slug
27986
- x-mutually-exclusive-body-groups: *ref_15
27987
- UpdateUserlandUserOrganizationMembershipDto:
27988
28625
  x-mutually-exclusive-body-groups: *ref_16
28626
+ UpdateUserlandUserOrganizationMembershipDto:
28627
+ x-mutually-exclusive-body-groups: *ref_17
27989
28628
  oneOf:
27990
28629
  - type: object
27991
28630
  not:
@@ -28107,9 +28746,9 @@ components:
28107
28746
  type:
28108
28747
  - object
28109
28748
  - 'null'
28110
- additionalProperties: *ref_12
28749
+ additionalProperties: *ref_13
28111
28750
  maxProperties: 50
28112
- example: &ref_18
28751
+ example: &ref_19
28113
28752
  timezone: America/New_York
28114
28753
  description: >-
28115
28754
  Object containing metadata key/value pairs associated with the
@@ -28208,7 +28847,7 @@ components:
28208
28847
  example: $2a$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy
28209
28848
  password_hash_type:
28210
28849
  type: string
28211
- enum: &ref_19
28850
+ enum: &ref_20
28212
28851
  - bcrypt
28213
28852
  - firebase-scrypt
28214
28853
  - ssha
@@ -28223,7 +28862,7 @@ components:
28223
28862
  example: bcrypt
28224
28863
  password_salt_position:
28225
28864
  type: string
28226
- enum: &ref_20
28865
+ enum: &ref_21
28227
28866
  - prefix
28228
28867
  - suffix
28229
28868
  description: >-
@@ -28244,7 +28883,7 @@ components:
28244
28883
  x-exclude-from-lint: true
28245
28884
  required:
28246
28885
  - password
28247
- x-mutually-exclusive-body-groups: *ref_17
28886
+ x-mutually-exclusive-body-groups: *ref_18
28248
28887
  UpdateUserlandUserDto:
28249
28888
  allOf:
28250
28889
  - type: object
@@ -28274,9 +28913,9 @@ components:
28274
28913
  type:
28275
28914
  - object
28276
28915
  - 'null'
28277
- additionalProperties: *ref_12
28916
+ additionalProperties: *ref_13
28278
28917
  maxProperties: 50
28279
- example: *ref_18
28918
+ example: *ref_19
28280
28919
  description: >-
28281
28920
  Object containing metadata key/value pairs associated with the
28282
28921
  user.
@@ -28358,7 +28997,7 @@ components:
28358
28997
  example: $2a$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy
28359
28998
  password_hash_type:
28360
28999
  type: string
28361
- enum: *ref_19
29000
+ enum: *ref_20
28362
29001
  description: >-
28363
29002
  The algorithm originally used to hash the password, used
28364
29003
  when providing a `password_hash`. Required with
@@ -28366,7 +29005,7 @@ components:
28366
29005
  example: bcrypt
28367
29006
  password_salt_position:
28368
29007
  type: string
28369
- enum: *ref_20
29008
+ enum: *ref_21
28370
29009
  description: >-
28371
29010
  The position of the salt relative to the password when the
28372
29011
  `password_hash` digest was computed: `prefix` for `hash(salt
@@ -28385,7 +29024,7 @@ components:
28385
29024
  x-exclude-from-lint: true
28386
29025
  required:
28387
29026
  - password
28388
- x-mutually-exclusive-body-groups: *ref_21
29027
+ x-mutually-exclusive-body-groups: *ref_22
28389
29028
  VerifyEmailAddressDto:
28390
29029
  type: object
28391
29030
  properties:
@@ -28494,7 +29133,7 @@ components:
28494
29133
  description: The events that the Webhook Endpoint is subscribed to.
28495
29134
  items:
28496
29135
  type: string
28497
- enum: &ref_22
29136
+ enum: &ref_23
28498
29137
  - agent.blueprint.created
28499
29138
  - agent.blueprint.deleted
28500
29139
  - agent.blueprint.updated
@@ -28625,7 +29264,7 @@ components:
28625
29264
  description: The events that the Webhook Endpoint is subscribed to.
28626
29265
  items:
28627
29266
  type: string
28628
- enum: *ref_22
29267
+ enum: *ref_23
28629
29268
  example:
28630
29269
  - user.created
28631
29270
  - dsync.user.created
@@ -32280,7 +32919,7 @@ components:
32280
32919
  description: >-
32281
32920
  An object containing the custom attribute mapping for the Directory
32282
32921
  Provider.
32283
- example: &ref_28
32922
+ example: &ref_29
32284
32923
  department: Engineering
32285
32924
  job_title: Software Engineer
32286
32925
  role:
@@ -32474,7 +33113,7 @@ components:
32474
33113
  type: object
32475
33114
  additionalProperties: {}
32476
33115
  description: The event payload.
32477
- example: &ref_23
33116
+ example: &ref_24
32478
33117
  id: directory_user_01E1JG7J09H96KYP8HM9B0G5SJ
32479
33118
  directory_id: directory_01ECAZ4NV9QMV47GW873HDCX74
32480
33119
  organization_id: org_01EZTR6WYX1A0DSE2CYMGXQ24Y
@@ -32509,11 +33148,11 @@ components:
32509
33148
  - data
32510
33149
  - created_at
32511
33150
  description: An event emitted by WorkOS.
32512
- example: &ref_33
33151
+ example: &ref_34
32513
33152
  object: event
32514
33153
  id: event_01EHZNVPK3SFK441A1RGBFSHRT
32515
33154
  event: dsync.user.created
32516
- data: *ref_23
33155
+ data: *ref_24
32517
33156
  created_at: '2021-06-25T19:07:33.155Z'
32518
33157
  context: {}
32519
33158
  - oneOf:
@@ -32713,7 +33352,7 @@ components:
32713
33352
  description: >-
32714
33353
  Permission slugs forming the ceiling on what sessions
32715
33354
  minted from this blueprint may do.
32716
- example: &ref_24
33355
+ example: &ref_25
32717
33356
  - crm:read
32718
33357
  - email:send
32719
33358
  invocable_by:
@@ -32726,7 +33365,7 @@ components:
32726
33365
  description: >-
32727
33366
  Role slugs whose members may mint user-delegated
32728
33367
  sessions from this blueprint.
32729
- example: &ref_25
33368
+ example: &ref_26
32730
33369
  - manager
32731
33370
  organization_ids:
32732
33371
  type: array
@@ -32735,7 +33374,7 @@ components:
32735
33374
  description: >-
32736
33375
  Organizations in which autonomous sessions may be
32737
33376
  minted from this blueprint.
32738
- example: &ref_26
33377
+ example: &ref_27
32739
33378
  - org_01EHWNCE74X7JSDV0X3SZ3KJNY
32740
33379
  required:
32741
33380
  - role_slugs
@@ -32894,7 +33533,7 @@ components:
32894
33533
  description: >-
32895
33534
  Permission slugs forming the ceiling on what sessions
32896
33535
  minted from this blueprint may do.
32897
- example: *ref_24
33536
+ example: *ref_25
32898
33537
  invocable_by:
32899
33538
  type: object
32900
33539
  properties:
@@ -32905,7 +33544,7 @@ components:
32905
33544
  description: >-
32906
33545
  Role slugs whose members may mint user-delegated
32907
33546
  sessions from this blueprint.
32908
- example: *ref_25
33547
+ example: *ref_26
32909
33548
  organization_ids:
32910
33549
  type: array
32911
33550
  items:
@@ -32913,7 +33552,7 @@ components:
32913
33552
  description: >-
32914
33553
  Organizations in which autonomous sessions may be
32915
33554
  minted from this blueprint.
32916
- example: *ref_26
33555
+ example: *ref_27
32917
33556
  required:
32918
33557
  - role_slugs
32919
33558
  - organization_ids
@@ -33949,7 +34588,7 @@ components:
33949
34588
  items:
33950
34589
  type: string
33951
34590
  description: The permissions granted to the API key.
33952
- example: &ref_27
34591
+ example: &ref_28
33953
34592
  - users:read
33954
34593
  - users:write
33955
34594
  created_at:
@@ -34075,7 +34714,7 @@ components:
34075
34714
  items:
34076
34715
  type: string
34077
34716
  description: The permissions granted to the API key.
34078
- example: *ref_27
34717
+ example: *ref_28
34079
34718
  created_at:
34080
34719
  type: string
34081
34720
  description: The timestamp when the API key was created.
@@ -34199,7 +34838,7 @@ components:
34199
34838
  items:
34200
34839
  type: string
34201
34840
  description: The permissions granted to the API key.
34202
- example: *ref_27
34841
+ example: *ref_28
34203
34842
  created_at:
34204
34843
  type: string
34205
34844
  description: The timestamp when the API key was created.
@@ -37066,7 +37705,7 @@ components:
37066
37705
  description: >-
37067
37706
  An object containing the custom attribute mapping for
37068
37707
  the Directory Provider.
37069
- example: *ref_28
37708
+ example: *ref_29
37070
37709
  role:
37071
37710
  $ref: '#/components/schemas/SlimRole'
37072
37711
  roles:
@@ -37256,7 +37895,7 @@ components:
37256
37895
  description: >-
37257
37896
  Labels assigned to the Feature Flag for categorizing and
37258
37897
  filtering.
37259
- example: &ref_29
37898
+ example: &ref_30
37260
37899
  - reports
37261
37900
  enabled:
37262
37901
  type: boolean
@@ -37417,7 +38056,7 @@ components:
37417
38056
  description: >-
37418
38057
  Labels assigned to the Feature Flag for categorizing and
37419
38058
  filtering.
37420
- example: *ref_29
38059
+ example: *ref_30
37421
38060
  enabled:
37422
38061
  type: boolean
37423
38062
  description: >-
@@ -37577,7 +38216,7 @@ components:
37577
38216
  description: >-
37578
38217
  Labels assigned to the Feature Flag for categorizing and
37579
38218
  filtering.
37580
- example: *ref_29
38219
+ example: *ref_30
37581
38220
  enabled:
37582
38221
  type: boolean
37583
38222
  description: >-
@@ -37857,7 +38496,7 @@ components:
37857
38496
  description: >-
37858
38497
  Labels assigned to the Feature Flag for categorizing and
37859
38498
  filtering.
37860
- example: *ref_29
38499
+ example: *ref_30
37861
38500
  enabled:
37862
38501
  type: boolean
37863
38502
  description: >-
@@ -38845,7 +39484,7 @@ components:
38845
39484
  description: >-
38846
39485
  Object containing [metadata](/authkit/metadata)
38847
39486
  key/value pairs associated with the Organization.
38848
- example: &ref_30
39487
+ example: &ref_31
38849
39488
  tier: diamond
38850
39489
  propertyNames:
38851
39490
  maxLength: 40
@@ -38995,7 +39634,7 @@ components:
38995
39634
  description: >-
38996
39635
  Object containing [metadata](/authkit/metadata)
38997
39636
  key/value pairs associated with the Organization.
38998
- example: *ref_30
39637
+ example: *ref_31
38999
39638
  propertyNames:
39000
39639
  maxLength: 40
39001
39640
  maxProperties: 50
@@ -39822,7 +40461,7 @@ components:
39822
40461
  items:
39823
40462
  type: string
39824
40463
  description: The permissions granted by the role.
39825
- example: &ref_31
40464
+ example: &ref_32
39826
40465
  - users:read
39827
40466
  - users:write
39828
40467
  created_at:
@@ -39906,7 +40545,7 @@ components:
39906
40545
  items:
39907
40546
  type: string
39908
40547
  description: The permissions granted by the role.
39909
- example: *ref_31
40548
+ example: *ref_32
39910
40549
  created_at:
39911
40550
  format: date-time
39912
40551
  type: string
@@ -39988,7 +40627,7 @@ components:
39988
40627
  items:
39989
40628
  type: string
39990
40629
  description: The permissions granted by the role.
39991
- example: *ref_31
40630
+ example: *ref_32
39992
40631
  created_at:
39993
40632
  format: date-time
39994
40633
  type: string
@@ -40125,7 +40764,7 @@ components:
40125
40764
  description: >-
40126
40765
  Object containing [metadata](/authkit/metadata)
40127
40766
  key/value pairs associated with the Organization.
40128
- example: *ref_30
40767
+ example: *ref_31
40129
40768
  propertyNames:
40130
40769
  maxLength: 40
40131
40770
  maxProperties: 50
@@ -41287,7 +41926,7 @@ components:
41287
41926
  items:
41288
41927
  type: string
41289
41928
  description: The permissions granted by the role.
41290
- example: &ref_32
41929
+ example: &ref_33
41291
41930
  - users:read
41292
41931
  - users:write
41293
41932
  created_at:
@@ -41353,7 +41992,7 @@ components:
41353
41992
  items:
41354
41993
  type: string
41355
41994
  description: The permissions granted by the role.
41356
- example: *ref_32
41995
+ example: *ref_33
41357
41996
  created_at:
41358
41997
  format: date-time
41359
41998
  type: string
@@ -41417,7 +42056,7 @@ components:
41417
42056
  items:
41418
42057
  type: string
41419
42058
  description: The permissions granted by the role.
41420
- example: *ref_32
42059
+ example: *ref_33
41421
42060
  created_at:
41422
42061
  format: date-time
41423
42062
  type: string
@@ -42557,7 +43196,7 @@ components:
42557
43196
  - data
42558
43197
  - created_at
42559
43198
  - object
42560
- example: *ref_33
43199
+ example: *ref_34
42561
43200
  description: An event emitted by WorkOS.
42562
43201
  EventList:
42563
43202
  type: object
@@ -42592,7 +43231,7 @@ components:
42592
43231
  example:
42593
43232
  object: list
42594
43233
  data:
42595
- - *ref_33
43234
+ - *ref_34
42596
43235
  list_metadata:
42597
43236
  after: event_01EHZNVPK3SFK441A1RGBFSHRT
42598
43237
  JwtTemplate:
@@ -44452,7 +45091,7 @@ components:
44452
45091
  items:
44453
45092
  type: string
44454
45093
  description: The OAuth scopes granted for this connection.
44455
- example: &ref_34
45094
+ example: &ref_35
44456
45095
  - repo
44457
45096
  - user:email
44458
45097
  auth_method:
@@ -44502,7 +45141,7 @@ components:
44502
45141
  `installation` scope, excluding any it declares as
44503
45142
  secret. Only present when `auth_method` is
44504
45143
  `client_credentials`.
44505
- example: &ref_35
45144
+ example: &ref_36
44506
45145
  instance_url: https://example.my.salesforce.com
44507
45146
  state:
44508
45147
  type: string
@@ -44600,7 +45239,7 @@ components:
44600
45239
  items:
44601
45240
  type: string
44602
45241
  description: The OAuth scopes granted for this connection.
44603
- example: *ref_34
45242
+ example: *ref_35
44604
45243
  auth_method:
44605
45244
  type: string
44606
45245
  enum:
@@ -44647,7 +45286,7 @@ components:
44647
45286
  `installation` scope, excluding any it declares as
44648
45287
  secret. Only present when `auth_method` is
44649
45288
  `client_credentials`.
44650
- example: *ref_35
45289
+ example: *ref_36
44651
45290
  state:
44652
45291
  type: string
44653
45292
  enum: