Skip to content
Scenario Docs
Get started
API Reference
Teams

Members

Create
client.teams.members.create(stringteamID, MemberCreateParams { email, projectIds, role } body, RequestOptionsoptions?): MemberCreateResponse { team }
POST/teams/{teamId}/members
Delete
client.teams.members.delete(stringmemberID, MemberDeleteParams { teamId } params, RequestOptionsoptions?): MemberDeleteResponse
DELETE/teams/{teamId}/members/{memberId}
Update
client.teams.members.update(stringmemberID, MemberUpdateParams { teamId, maxConsumption, role } params, RequestOptionsoptions?): MemberUpdateResponse
PUT/teams/{teamId}/members/{memberId}
ModelsExpand Collapse
MemberCreateResponse { team }
team: Team { id, context, createdAt, 10 more }
id: string

The team ID (example: “eyVcnFJcR92BxBkz7N6g5w”)

context: Context { invitationsCount, keysCount, userRole, usersCount }

The context of the team for the current authenticated user

invitationsCount: number

The number of invitations on this team

keysCount: number

The number of API keys on this team

userRole: "admin" | "key" | "member"

The authenticated user’s role for this team

One of the following:
"admin"
"key"
"member"
usersCount: number

The number of users on this team

createdAt: string

The team creation date as an ISO string (example: “2023-02-03T11:19:41.579Z”)

name: string

The team name (example: “Scenario”)

plan: "cu-basic" | "cu-creator" | "cu-max" | 9 more

The team plan

One of the following:
"cu-basic"
"cu-creator"
"cu-max"
"cu-pro"
"cu-pro-q3-25"
"cu-team"
"cu-team-v2"
"enterprise"
"essential"
"free"
"premium"
"pro"
projects: Array<Project>

Projects of the team

id: string
createdAt: string
name: string
updatedAt: string
avatar?: Avatar { assetId, url }
assetId?: string

ID of the asset used as thumbnail if provided, otherwise undefined

url?: string

Signed URL of the assetId or free url if assetId is undefined

disableIpDetection?: boolean

When true, IP detection is switched off for this project.

qualityGateAutoDetect?: boolean

Whether Quality Gate auto-detection runs on generation for this project.

type: "personal" | "shared"

The team type

One of the following:
"personal"
"shared"
updatedAt: string

The team update date as an ISO string (example: “2023-02-03T11:19:41.579Z”)

avatar?: Avatar { assetId, url }

The team’s avatar

assetId?: string

ID of the asset used as thumbnail if provided, otherwise undefined

url?: string

Signed URL of the assetId or free url if assetId is undefined

byok?: Byok { markupMultiplier, updatedAt, updatedBy }

BYOK pricing override. Admin-only — omitted for non-admin callers.

markupMultiplier: number
updatedAt?: string

ISO timestamp of the last update. Optional — legacy rows may lack it.

updatedBy?: string

Human-readable handle of who last updated the markup (display name).

defaultUserMaxConsumption?: number

Team-wide default max consumption (CU) applied to every member over the billing period, unless overridden per member. Absent when no team-wide default is set.

ipDetectionEnforcement?: "active-fail-closed" | "active-fail-open" | "disabled"

The IP detection enforcement posture for the team. ‘disabled’: IP detection is not performed. ‘active-fail-open’: IP detection runs; on detector error the request is allowed through. ‘active-fail-closed’: IP detection runs; on detector error the request is blocked.

One of the following:
"active-fail-closed"
"active-fail-open"
"disabled"
qualityGateAutoDetect?: boolean

Quality Gate auto-detection default for the team.

MemberDeleteResponse = unknown
MemberUpdateResponse = unknown