Teams.Members
Overview
Available Operations
add - Add Team Member
bulkAdd - Add Bulk Team Member
remove - Remove Team Member
update - Update Team Member
add
Add team member to the team. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.
Example Usage
import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript";
const squadcastSDK = new SquadcastSDK({
refreshTokenAuth: "<YOUR_REFRESH_TOKEN_AUTH_HERE>",
});
async function run() {
const result = await squadcastSDK.teams.members.add({
teamId: "<id>",
v3TeamsAddTeamMemberRequest: {
userId: "<id>",
roleIds: [],
},
});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
Parameters
options
RequestOptions
➖
Used to set various options for making HTTP requests.
options.fetchOptions
➖
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.TeamsAddTeamMemberResponse>
Errors
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
*/*
bulkAdd
Add team member to the team. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.
Example Usage
Standalone function
The standalone function version of this method:
Parameters
options
RequestOptions
➖
Used to set various options for making HTTP requests.
options.fetchOptions
➖
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.TeamsAddBulkTeamMemberResponse>
Errors
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 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
Standalone function
The standalone function version of this method:
Parameters
options
RequestOptions
➖
Used to set various options for making HTTP requests.
options.fetchOptions
➖
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<Uint8Array>
Errors
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 team member. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.
Example Usage
Standalone function
The standalone function version of this method:
Parameters
options
RequestOptions
➖
Used to set various options for making HTTP requests.
options.fetchOptions
➖
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.TeamsUpdateTeamMemberResponse>
Errors
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
*/*
Last updated