Users

Overview

Available Operations

• get_all - Get All Users

• add - Add User

• update_org_level_permissions - Update Org Level Permissions

• delete - Delete User

• get_roles - Get User Roles

• remove_from_org - Remove User From Org

• get_by_id - Get User By ID

• update_by_id - Update User by userID

get_all

Returns all the users 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.users.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.UsersGetAllUsersResponse

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

Add user to the organization with given role if not exists. Returns the user 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.users.add(email="[email protected]", role="account_owner", first_name="Yvonne", last_name="Kozey")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
email	str	✔️	N/A
role	models.V3UsersAddUserRequestRole	✔️	N/A
first_name	str	✔️	N/A
last_name	str	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.UsersAddUserResponse

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_org_level_permissions

Update Org Level Permissions

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.users.update_org_level_permissions(data=[])

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
data	List[models.V3UsersUpdateUserAbilitiesRequestData]	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.UsersUpdateOrgLevelPermissionsResponse

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	*/*

delete

This API replaces the swap_user for all the entities in Squadcast with user_id provided and deletes the user.

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.users.delete(user_id="<id>", swap_user_id="<id>", suppress_incidents=True, reassign_incidents=True)

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
user_id	str	✔️	N/A
swap_user_id	str	✔️	N/A
suppress_incidents	bool	✔️	N/A
reassign_incidents	bool	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.UsersDeleteUserResponse

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_roles

Returns all available user roles. 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.users.get_roles()

    # 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.UsersGetUserRolesResponse

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_from_org

Remove user from organization. Upon sccess the user 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.users.remove_from_org(user_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
user_id	str	✔️	(Required) user id
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	*/*

get_by_id

Returns a users details of the given userID 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.users.get_by_id(user_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
user_id	str	✔️	(Required) user id
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.UsersGetUserByIDResponse

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_by_id

Update User by userID. 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.users.update_by_id(user_id="<id>", role="user")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
user_id	str	✔️	(Required) user id
role	models.V3UsersUpdateUserRequestRole	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.UsersUpdateUserByIDResponse

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	*/*