@@ -7701,6 +7701,13 @@ components:
77017701 required:
77027702 - 'data'
77037703 type: 'object'
7704+ CreateScimSyncJobResponse:
7705+ properties:
7706+ data:
7707+ $ref: '#/components/schemas/ScimSyncJob'
7708+ required:
7709+ - 'data'
7710+ type: 'object'
77047711 CreateWorkspaceRequest:
77057712 example:
77067713 default_image_model: 'openai/dall-e-3'
@@ -10073,6 +10080,13 @@ components:
1007310080 required:
1007410081 - 'data'
1007510082 type: 'object'
10083+ GetScimSyncJobResponse:
10084+ properties:
10085+ data:
10086+ $ref: '#/components/schemas/ScimSyncJob'
10087+ required:
10088+ - 'data'
10089+ type: 'object'
1007610090 GetWorkspaceBudgetResponse:
1007710091 example:
1007810092 data:
@@ -23377,6 +23391,58 @@ components:
2337723391 - 'created_at'
2337823392 - 'updated_at'
2337923393 type: 'object'
23394+ ScimSyncJob:
23395+ properties:
23396+ created_at:
23397+ description: 'Time when the sync job was created.'
23398+ type: 'string'
23399+ deleted_groups:
23400+ description: 'Number of groups deleted, when the job completed successfully.'
23401+ type:
23402+ - 'integer'
23403+ - 'null'
23404+ error_message:
23405+ description: 'Stable error message when the job failed.'
23406+ type:
23407+ - 'string'
23408+ - 'null'
23409+ finished_at:
23410+ description: 'Time when synchronization finished.'
23411+ type:
23412+ - 'string'
23413+ - 'null'
23414+ id:
23415+ description: 'Unique identifier for the sync job.'
23416+ format: 'uuid'
23417+ type: 'string'
23418+ started_at:
23419+ description: 'Time when synchronization started.'
23420+ type:
23421+ - 'string'
23422+ - 'null'
23423+ status:
23424+ description: 'Current status of the sync job: queued, running, succeeded, or failed.'
23425+ enum:
23426+ - 'queued'
23427+ - 'running'
23428+ - 'succeeded'
23429+ - 'failed'
23430+ type: 'string'
23431+ synced_groups:
23432+ description: 'Number of groups synchronized, when the job completed successfully.'
23433+ type:
23434+ - 'integer'
23435+ - 'null'
23436+ required:
23437+ - 'id'
23438+ - 'status'
23439+ - 'synced_groups'
23440+ - 'deleted_groups'
23441+ - 'error_message'
23442+ - 'created_at'
23443+ - 'started_at'
23444+ - 'finished_at'
23445+ type: 'object'
2338023446 SearchContextSizeEnum:
2338123447 description: 'Size of the search context for web search tools'
2338223448 enum:
@@ -39380,6 +39446,110 @@ paths:
3938039446 outputs:
3938139447 results: '$.data'
3938239448 type: 'offsetLimit'
39449+ /scim/sync-jobs:
39450+ post:
39451+ description: 'Start a SCIM directory sync. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
39452+ operationId: 'createScimSyncJob'
39453+ responses:
39454+ '202':
39455+ content:
39456+ application/json:
39457+ schema:
39458+ $ref: '#/components/schemas/CreateScimSyncJobResponse'
39459+ description: 'SCIM directory sync job queued'
39460+ headers:
39461+ Location:
39462+ description: 'Poll URL for the created sync job.'
39463+ required: true
39464+ schema:
39465+ description: 'Poll URL for the created sync job.'
39466+ type: 'string'
39467+ '401':
39468+ content:
39469+ application/json:
39470+ example:
39471+ error:
39472+ code: 401
39473+ message: 'Missing Authentication header'
39474+ schema:
39475+ $ref: '#/components/schemas/UnauthorizedResponse'
39476+ description: 'Unauthorized - Authentication required or invalid credentials'
39477+ '404':
39478+ content:
39479+ application/json:
39480+ example:
39481+ error:
39482+ code: 404
39483+ message: 'Resource not found'
39484+ schema:
39485+ $ref: '#/components/schemas/NotFoundResponse'
39486+ description: 'Not Found - Resource does not exist'
39487+ '500':
39488+ content:
39489+ application/json:
39490+ example:
39491+ error:
39492+ code: 500
39493+ message: 'Internal Server Error'
39494+ schema:
39495+ $ref: '#/components/schemas/InternalServerResponse'
39496+ description: 'Internal Server Error - Unexpected server error'
39497+ summary: 'Start a SCIM directory sync'
39498+ tags:
39499+ - 'SCIM'
39500+ x-speakeasy-name-override: 'createSyncJob'
39501+ /scim/sync-jobs/{id}:
39502+ get:
39503+ description: 'Get SCIM directory sync status. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
39504+ operationId: 'getScimSyncJob'
39505+ parameters:
39506+ - in: 'path'
39507+ name: 'id'
39508+ required: true
39509+ schema:
39510+ format: 'uuid'
39511+ type: 'string'
39512+ responses:
39513+ '200':
39514+ content:
39515+ application/json:
39516+ schema:
39517+ $ref: '#/components/schemas/GetScimSyncJobResponse'
39518+ description: 'SCIM directory sync job'
39519+ '401':
39520+ content:
39521+ application/json:
39522+ example:
39523+ error:
39524+ code: 401
39525+ message: 'Missing Authentication header'
39526+ schema:
39527+ $ref: '#/components/schemas/UnauthorizedResponse'
39528+ description: 'Unauthorized - Authentication required or invalid credentials'
39529+ '404':
39530+ content:
39531+ application/json:
39532+ example:
39533+ error:
39534+ code: 404
39535+ message: 'Resource not found'
39536+ schema:
39537+ $ref: '#/components/schemas/NotFoundResponse'
39538+ description: 'Not Found - Resource does not exist'
39539+ '500':
39540+ content:
39541+ application/json:
39542+ example:
39543+ error:
39544+ code: 500
39545+ message: 'Internal Server Error'
39546+ schema:
39547+ $ref: '#/components/schemas/InternalServerResponse'
39548+ description: 'Internal Server Error - Unexpected server error'
39549+ summary: 'Get SCIM directory sync status'
39550+ tags:
39551+ - 'SCIM'
39552+ x-speakeasy-name-override: 'getSyncJob'
3938339553 /videos:
3938439554 post:
3938539555 description: 'Submits a video generation request and returns a polling URL to check status'
0 commit comments