Teams

Overview

Available Operations

get_all - Get All Teams
create - Create Team
get - Get Team By ID
update - Update Team
remove - Remove Team
add_bulk_member - Add Bulk Team Member
remove_member - Remove Team Member
update_member - Update Team Member
remove_role - Remove Team Role

get_all

Returns all the teams of the organization. Requires access_token as a Bearer {{token}} in the Authorization header with read scope.

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.teams.get_all()

    # Handle response
    print(res)

Parameters

Parameter

Type

Required

Description

retries

Optional[utils.RetryConfig]

➖

Configuration to override the default retry behavior of the client.

Response

models.TeamsGetAllTeamsResponse

Errors

Error Type

Status Code

Content Type

errors.BadRequestError

400

application/json

errors.UnauthorizedError

401

application/json

errors.PaymentRequiredError

402

application/json

errors.ForbiddenError

403

application/json

errors.NotFoundError

404

application/json

errors.ConflictError

409

application/json

errors.UnprocessableEntityError

422

application/json

errors.InternalServerError

500

application/json

errors.BadGatewayError

502

application/json

errors.ServiceUnavailableError

503

application/json

errors.GatewayTimeoutError

504

application/json

errors.SDKDefaultError

4XX, 5XX

*/*

create

Add team to the organization. Returns the team object in response. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.teams.create(name="<value>", member_ids=[
        "<value 1>",
        "<value 2>",
    ])

    # Handle response
    print(res)

Parameters

Parameter

Type

Required

Description

name

str

✔️

N/A

member_ids

List[str]

✔️

N/A

description

Optional[str]

➖

N/A

retries

Optional[utils.RetryConfig]

➖

Configuration to override the default retry behavior of the client.

Response

models.TeamsCreateTeamResponse

Errors

Error Type

Status Code

Content Type

errors.BadRequestError

400

application/json

errors.UnauthorizedError

401

application/json

errors.PaymentRequiredError

402

application/json

errors.ForbiddenError

403

application/json

errors.NotFoundError

404

application/json

errors.ConflictError

409

application/json

errors.UnprocessableEntityError

422

application/json

errors.InternalServerError

500

application/json

errors.BadGatewayError

502

application/json

errors.ServiceUnavailableError

503

application/json

errors.GatewayTimeoutError

504

application/json

errors.SDKDefaultError

4XX, 5XX

*/*

get

Returns a team details of the given teamID in the request param. Requires access_token as a Bearer {{token}} in the Authorization header with read scope.

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.teams.get(team_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter

Type

Required

Description

team_id

str

✔️

N/A

retries

Optional[utils.RetryConfig]

➖

Configuration to override the default retry behavior of the client.

Response

models.TeamsGetTeamByIDResponse

Errors

Error Type

Status Code

Content Type

errors.BadRequestError

400

application/json

errors.UnauthorizedError

401

application/json

errors.PaymentRequiredError

402

application/json

errors.ForbiddenError

403

application/json

errors.NotFoundError

404

application/json

errors.ConflictError

409

application/json

errors.UnprocessableEntityError

422

application/json

errors.InternalServerError

500

application/json

errors.BadGatewayError

502

application/json

errors.ServiceUnavailableError

503

application/json

errors.GatewayTimeoutError

504

application/json

errors.SDKDefaultError

4XX, 5XX

*/*

update

Update organization team details. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.teams.update(team_id="<id>", members=[])

    # Handle response
    print(res)

Parameters

Parameter

Type

Required

Description

team_id

str

✔️

N/A

members

List[models.V3TeamsUpdateTeamRequestMember]

✔️

N/A

name

Optional[str]

➖

N/A

description

Optional[str]

➖

N/A

retries

Optional[utils.RetryConfig]

➖

Configuration to override the default retry behavior of the client.

Response

models.TeamsUpdateTeamResponse

Errors

Error Type

Status Code

Content Type

errors.BadRequestError

400

application/json

errors.UnauthorizedError

401

application/json

errors.PaymentRequiredError

402

application/json

errors.ForbiddenError

403

application/json

errors.NotFoundError

404

application/json

errors.ConflictError

409

application/json

errors.UnprocessableEntityError

422

application/json

errors.InternalServerError

500

application/json

errors.BadGatewayError

502

application/json

errors.ServiceUnavailableError

503

application/json

errors.GatewayTimeoutError

504

application/json

errors.SDKDefaultError

4XX, 5XX

*/*

remove

Remove team from the organization. Upon success, the team will be removed from the organization. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.teams.remove(team_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter

Type

Required

Description

team_id

str

✔️

N/A

retries

Optional[utils.RetryConfig]

➖

Configuration to override the default retry behavior of the client.

Response

bytes

Errors

Error Type

Status Code

Content Type

errors.BadRequestError

400

application/json

errors.UnauthorizedError

401

application/json

errors.PaymentRequiredError

402

application/json

errors.ForbiddenError

403

application/json

errors.NotFoundError

404

application/json

errors.ConflictError

409

application/json

errors.UnprocessableEntityError

422

application/json

errors.InternalServerError

500

application/json

errors.BadGatewayError

502

application/json

errors.ServiceUnavailableError

503

application/json

errors.GatewayTimeoutError

504

application/json

errors.SDKDefaultError

4XX, 5XX

*/*

add_bulk_member

Add team member to the team. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.teams.add_bulk_member(team_id="<id>", members=[
        {
            "user_id": "<id>",
            "role_ids": [
                "<value 1>",
                "<value 2>",
            ],
        },
    ])

    # Handle response
    print(res)

Parameters

Parameter

Type

Required

Description

team_id

str

✔️

N/A

members

List[models.V3TeamsAddBulkTeamMemberRequestMember]

✔️

N/A

retries

Optional[utils.RetryConfig]

➖

Configuration to override the default retry behavior of the client.

Response

models.TeamsAddBulkTeamMemberResponse

Errors

Error Type

Status Code

Content Type

errors.BadRequestError

400

application/json

errors.UnauthorizedError

401

application/json

errors.PaymentRequiredError

402

application/json

errors.ForbiddenError

403

application/json

errors.NotFoundError

404

application/json

errors.ConflictError

409

application/json

errors.UnprocessableEntityError

422

application/json

errors.InternalServerError

500

application/json

errors.BadGatewayError

502

application/json

errors.ServiceUnavailableError

503

application/json

errors.GatewayTimeoutError

504

application/json

errors.SDKDefaultError

4XX, 5XX

*/*

remove_member

Remove team member from the team. Upon success, the team member will be removed from the team. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.teams.remove_member(team_id="<id>", member_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter

Type

Required

Description

team_id

str

✔️

N/A

member_id

str

✔️

N/A

retries

Optional[utils.RetryConfig]

➖

Configuration to override the default retry behavior of the client.

Response

bytes

Errors

Error Type

Status Code

Content Type

errors.BadRequestError

400

application/json

errors.UnauthorizedError

401

application/json

errors.PaymentRequiredError

402

application/json

errors.ForbiddenError

403

application/json

errors.NotFoundError

404

application/json

errors.ConflictError

409

application/json

errors.UnprocessableEntityError

422

application/json

errors.InternalServerError

500

application/json

errors.BadGatewayError

502

application/json

errors.ServiceUnavailableError

503

application/json

errors.GatewayTimeoutError

504

application/json

errors.SDKDefaultError

4XX, 5XX

*/*

update_member

Update team member. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.teams.update_member(team_id="<id>", member_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter

Type

Required

Description

team_id

str

✔️

N/A

member_id

str

✔️

N/A

role_ids

List[str]

➖

this field is required if you are using RBAC permission model

role

Optional[str]

➖

this field is required if you are using OBAC permission model

retries

Optional[utils.RetryConfig]

➖

Configuration to override the default retry behavior of the client.

Response

models.TeamsUpdateTeamMemberResponse

Errors

Error Type

Status Code

Content Type

errors.BadRequestError

400

application/json

errors.UnauthorizedError

401

application/json

errors.PaymentRequiredError

402

application/json

errors.ForbiddenError

403

application/json

errors.NotFoundError

404

application/json

errors.ConflictError

409

application/json

errors.UnprocessableEntityError

422

application/json

errors.InternalServerError

500

application/json

errors.BadGatewayError

502

application/json

errors.ServiceUnavailableError

503

application/json

errors.GatewayTimeoutError

504

application/json

errors.SDKDefaultError

4XX, 5XX

*/*

remove_role

Remove team's role from the team. Upon success, the team's role will be removed from the team. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.teams.remove_role(team_id="<id>", role_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter

Type

Required

Description

team_id

str

✔️

N/A

role_id

str

✔️

N/A

retries

Optional[utils.RetryConfig]

➖

Configuration to override the default retry behavior of the client.

Response

bytes

Errors

Error Type

Status Code

Content Type

errors.BadRequestError

400

application/json

errors.UnauthorizedError

401

application/json

errors.PaymentRequiredError

402

application/json

errors.ForbiddenError

403

application/json

errors.NotFoundError

404

application/json

errors.ConflictError

409

application/json

errors.UnprocessableEntityError

422

application/json

errors.InternalServerError

500

application/json

errors.BadGatewayError

502

application/json

errors.ServiceUnavailableError

503

application/json

errors.GatewayTimeoutError

504

application/json

errors.SDKDefaultError

4XX, 5XX

*/*

PreviousServices.TaggingRules NextTeams.Members

Last updated 8 days ago

Good morning

hashtagOverview

hashtagAvailable Operations

hashtagget_all

hashtagExample Usage

hashtagParameters

hashtagResponse

hashtagErrors

hashtagcreate

hashtagExample Usage

hashtagParameters

hashtagResponse

hashtagErrors

hashtagget

hashtagExample Usage

hashtagParameters

hashtagResponse

hashtagErrors

hashtagupdate

hashtagExample Usage

hashtagParameters

hashtagResponse

hashtagErrors

hashtagremove

hashtagExample Usage

hashtagParameters

hashtagResponse

hashtagErrors

hashtagadd_bulk_member

hashtagExample Usage

hashtagParameters

hashtagResponse

hashtagErrors

hashtagremove_member

hashtagExample Usage

hashtagParameters

hashtagResponse

hashtagErrors

hashtagupdate_member

hashtagExample Usage

hashtagParameters

hashtagResponse

hashtagErrors

hashtagremove_role

hashtagExample Usage

hashtagParameters

hashtagResponse

hashtagErrors

Overview

Available Operations

get_all

Example Usage

Parameters

Response

Errors

create

Example Usage

Parameters

Response

Errors

get

Example Usage

Parameters

Response

Errors

update

Example Usage

Parameters

Response

Errors

remove

Example Usage

Parameters

Response

Errors

add_bulk_member

Example Usage

Parameters

Response

Errors

remove_member

Example Usage

Parameters

Response

Errors

update_member

Example Usage

Parameters

Response

Errors

remove_role

Example Usage

Parameters

Response

Errors