Skip to content

Latest commit

 

History

History
683 lines (475 loc) · 33.1 KB

File metadata and controls

683 lines (475 loc) · 33.1 KB

Workspaces

Overview

REST APIs for managing Workspaces (speakeasy tenancy)

Available Operations

Create

Creates a workspace

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Shared;
using System;

var sdk = new SDK(security: new Security() {
    APIKey = "<YOUR_API_KEY_HERE>",
});

Workspace req = new Workspace() {
    CreatedAt = System.DateTime.Parse("2024-11-17T13:41:10.525Z").ToUniversalTime(),
    Id = "<id>",
    Name = "<value>",
    OrganizationId = "<id>",
    Slug = "<value>",
    UpdatedAt = System.DateTime.Parse("2025-11-21T08:36:32.740Z").ToUniversalTime(),
    Verified = true,
};

var res = await sdk.Workspaces.CreateAsync(req);

// handle response

Parameters

Parameter Type Required Description
request Workspace ✔️ The request object to use for the request.

Response

CreateWorkspaceResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 4XX application/json
SpeakeasySDK.Models.Errors.SDKException 5XX */*

CreateToken

Create a token for a particular workspace

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Operations;
using SpeakeasySDK.Models.Shared;
using System;

var sdk = new SDK(
    workspaceId: "<id>",
    security: new Security() {
        APIKey = "<YOUR_API_KEY_HERE>",
    }
);

CreateWorkspaceTokenRequest req = new CreateWorkspaceTokenRequest() {
    WorkspaceToken = new WorkspaceToken() {
        Alg = "<value>",
        CreatedAt = System.DateTime.Parse("2025-10-04T10:23:04.522Z").ToUniversalTime(),
        Id = "<id>",
        Key = "<key>",
        Name = "<value>",
        WorkspaceId = "<id>",
    },
};

var res = await sdk.Workspaces.CreateTokenAsync(req);

// handle response

Parameters

Parameter Type Required Description
request CreateWorkspaceTokenRequest ✔️ The request object to use for the request.

Response

CreateWorkspaceTokenResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 4XX application/json
SpeakeasySDK.Models.Errors.SDKException 5XX */*

DeleteToken

Delete a token for a particular workspace

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Operations;
using SpeakeasySDK.Models.Shared;

var sdk = new SDK(
    workspaceId: "<id>",
    security: new Security() {
        APIKey = "<YOUR_API_KEY_HERE>",
    }
);

DeleteWorkspaceTokenRequest req = new DeleteWorkspaceTokenRequest() {
    TokenID = "<id>",
};

var res = await sdk.Workspaces.DeleteTokenAsync(req);

// handle response

Parameters

Parameter Type Required Description
request DeleteWorkspaceTokenRequest ✔️ The request object to use for the request.

Response

DeleteWorkspaceTokenResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 4XX application/json
SpeakeasySDK.Models.Errors.SDKException 5XX */*

Get

Get information about a particular workspace by context.

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Shared;

var sdk = new SDK(security: new Security() {
    APIKey = "<YOUR_API_KEY_HERE>",
});

var res = await sdk.Workspaces.GetAsync();

// handle response

Response

GetWorkspaceByContextResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 4XX application/json
SpeakeasySDK.Models.Errors.SDKException 5XX */*

GetAll

Returns a list of workspaces a user has access too

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Shared;

var sdk = new SDK(security: new Security() {
    APIKey = "<YOUR_API_KEY_HERE>",
});

var res = await sdk.Workspaces.GetAllAsync();

// handle response

Response

GetWorkspacesResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 4XX application/json
SpeakeasySDK.Models.Errors.SDKException 5XX */*

GetByID

Get information about a particular workspace.

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Operations;
using SpeakeasySDK.Models.Shared;

var sdk = new SDK(
    workspaceId: "<id>",
    security: new Security() {
        APIKey = "<YOUR_API_KEY_HERE>",
    }
);

GetWorkspaceRequest req = new GetWorkspaceRequest() {};

var res = await sdk.Workspaces.GetByIDAsync(req);

// handle response

Parameters

Parameter Type Required Description
request GetWorkspaceRequest ✔️ The request object to use for the request.

Response

GetWorkspaceResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 4XX application/json
SpeakeasySDK.Models.Errors.SDKException 5XX */*

GetFeatureFlags

Get workspace feature flags

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Operations;
using SpeakeasySDK.Models.Shared;

var sdk = new SDK(
    workspaceId: "<id>",
    security: new Security() {
        APIKey = "<YOUR_API_KEY_HERE>",
    }
);

GetWorkspaceFeatureFlagsRequest req = new GetWorkspaceFeatureFlagsRequest() {};

var res = await sdk.Workspaces.GetFeatureFlagsAsync(req);

// handle response

Parameters

Parameter Type Required Description
request GetWorkspaceFeatureFlagsRequest ✔️ The request object to use for the request.

Response

GetWorkspaceFeatureFlagsResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 5XX application/json
SpeakeasySDK.Models.Errors.SDKException 4XX */*

GetSettings

Get settings about a particular workspace.

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Operations;
using SpeakeasySDK.Models.Shared;

var sdk = new SDK(
    workspaceId: "<id>",
    security: new Security() {
        APIKey = "<YOUR_API_KEY_HERE>",
    }
);

GetWorkspaceSettingsRequest req = new GetWorkspaceSettingsRequest() {};

var res = await sdk.Workspaces.GetSettingsAsync(req);

// handle response

Parameters

Parameter Type Required Description
request GetWorkspaceSettingsRequest ✔️ The request object to use for the request.

Response

GetWorkspaceSettingsResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 4XX application/json
SpeakeasySDK.Models.Errors.SDKException 5XX */*

GetTeam

Get team members for a particular workspace

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Operations;
using SpeakeasySDK.Models.Shared;

var sdk = new SDK(
    workspaceId: "<id>",
    security: new Security() {
        APIKey = "<YOUR_API_KEY_HERE>",
    }
);

GetWorkspaceTeamRequest req = new GetWorkspaceTeamRequest() {};

var res = await sdk.Workspaces.GetTeamAsync(req);

// handle response

Parameters

Parameter Type Required Description
request GetWorkspaceTeamRequest ✔️ The request object to use for the request.

Response

GetWorkspaceTeamResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 4XX application/json
SpeakeasySDK.Models.Errors.SDKException 5XX */*

GetTokens

Get tokens for a particular workspace

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Operations;
using SpeakeasySDK.Models.Shared;

var sdk = new SDK(
    workspaceId: "<id>",
    security: new Security() {
        APIKey = "<YOUR_API_KEY_HERE>",
    }
);

GetWorkspaceTokensRequest req = new GetWorkspaceTokensRequest() {};

var res = await sdk.Workspaces.GetTokensAsync(req);

// handle response

Parameters

Parameter Type Required Description
request GetWorkspaceTokensRequest ✔️ The request object to use for the request.

Response

GetWorkspaceTokensResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 4XX application/json
SpeakeasySDK.Models.Errors.SDKException 5XX */*

GrantAccess

Grant a user access to a particular workspace

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Operations;
using SpeakeasySDK.Models.Shared;

var sdk = new SDK(
    workspaceId: "<id>",
    security: new Security() {
        APIKey = "<YOUR_API_KEY_HERE>",
    }
);

GrantUserAccessToWorkspaceRequest req = new GrantUserAccessToWorkspaceRequest() {
    Email = "Idella24@gmail.com",
};

var res = await sdk.Workspaces.GrantAccessAsync(req);

// handle response

Parameters

Parameter Type Required Description
request GrantUserAccessToWorkspaceRequest ✔️ The request object to use for the request.

Response

GrantUserAccessToWorkspaceResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 4XX application/json
SpeakeasySDK.Models.Errors.SDKException 5XX */*

RevokeAccess

Revoke a user's access to a particular workspace

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Operations;
using SpeakeasySDK.Models.Shared;

var sdk = new SDK(
    workspaceId: "<id>",
    security: new Security() {
        APIKey = "<YOUR_API_KEY_HERE>",
    }
);

RevokeUserAccessToWorkspaceRequest req = new RevokeUserAccessToWorkspaceRequest() {
    UserId = "<id>",
};

var res = await sdk.Workspaces.RevokeAccessAsync(req);

// handle response

Parameters

Parameter Type Required Description
request RevokeUserAccessToWorkspaceRequest ✔️ The request object to use for the request.

Response

RevokeUserAccessToWorkspaceResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 4XX application/json
SpeakeasySDK.Models.Errors.SDKException 5XX */*

SetFeatureFlags

Set workspace feature flags

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Shared;
using System.Collections.Generic;

var sdk = new SDK(security: new Security() {
    APIKey = "<YOUR_API_KEY_HERE>",
});

WorkspaceFeatureFlagRequest req = new WorkspaceFeatureFlagRequest() {
    FeatureFlags = new List<WorkspaceFeatureFlag>() {},
};

var res = await sdk.Workspaces.SetFeatureFlagsAsync(req);

// handle response

Parameters

Parameter Type Required Description
request WorkspaceFeatureFlagRequest ✔️ The request object to use for the request.

Response

SetWorkspaceFeatureFlagsResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 5XX application/json
SpeakeasySDK.Models.Errors.SDKException 4XX */*

Update

Update information about a particular workspace.

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Operations;
using SpeakeasySDK.Models.Shared;
using System;

var sdk = new SDK(
    workspaceId: "<id>",
    security: new Security() {
        APIKey = "<YOUR_API_KEY_HERE>",
    }
);

UpdateWorkspaceDetailsRequest req = new UpdateWorkspaceDetailsRequest() {
    Workspace = new Workspace() {
        CreatedAt = System.DateTime.Parse("2024-08-01T22:30:24.264Z").ToUniversalTime(),
        Id = "<id>",
        Name = "<value>",
        OrganizationId = "<id>",
        Slug = "<value>",
        UpdatedAt = System.DateTime.Parse("2026-01-24T03:53:13.581Z").ToUniversalTime(),
        Verified = true,
    },
};

var res = await sdk.Workspaces.UpdateAsync(req);

// handle response

Parameters

Parameter Type Required Description
request UpdateWorkspaceDetailsRequest ✔️ The request object to use for the request.

Response

UpdateWorkspaceDetailsResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 4XX application/json
SpeakeasySDK.Models.Errors.SDKException 5XX */*

UpdateSettings

Update settings about a particular workspace.

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Operations;
using SpeakeasySDK.Models.Shared;
using System;

var sdk = new SDK(
    workspaceId: "<id>",
    security: new Security() {
        APIKey = "<YOUR_API_KEY_HERE>",
    }
);

UpdateWorkspaceSettingsRequest req = new UpdateWorkspaceSettingsRequest() {
    WorkspaceSettings = new WorkspaceSettings() {
        CreatedAt = System.DateTime.Parse("2026-03-09T15:48:09.330Z").ToUniversalTime(),
        UpdatedAt = System.DateTime.Parse("2026-11-24T16:37:53.492Z").ToUniversalTime(),
        WebhookUrl = "https://wobbly-lid.org",
        WorkspaceId = "<id>",
    },
};

var res = await sdk.Workspaces.UpdateSettingsAsync(req);

// handle response

Parameters

Parameter Type Required Description
request UpdateWorkspaceSettingsRequest ✔️ The request object to use for the request.

Response

UpdateWorkspaceSettingsResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 4XX application/json
SpeakeasySDK.Models.Errors.SDKException 5XX */*