Add Team Member

Adds a new member to a team. The user_login must be unique within the team.

POST /api/metrics/developer/teams/members/add

cURL

github

curl --request POST \ --url https://api.codeant.ai/api/metrics/developer/teams/members/add \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "platform": "github", "org": "my-org", "team_id": "15884668-91e2-4def-9d20-b7cf4698117d", "user_login": "[e-mail]", "user_name": "Jane Doe", "role": "member" } '

200

Example

{ "status": "success", "message": "Member added successfully", "member": { "user_login": "[e-mail]", "user_name": "Jane Doe", "joined_at": "2023-11-07T05:31:56Z", "role": "member" }, "team": { "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "name": "Backend Team", "description": "Responsible for API services", "color": "#1570EF", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "created_by": "<string>", "team_leads": [ "<string>" ], "members": [ { "user_login": "[e-mail]", "user_name": "Jane Doe", "joined_at": "2023-11-07T05:31:56Z", "role": "member" } ], "tags": [ "<string>" ], "parent_team_id": "<string>", "repositories": [ "my-org/backend-api" ], "is_active": true } }

Authorizations

Authorization · string · header · required

Access token for the git provider (GitHub PAT, GitLab PAT, Bitbucket App Password, Azure DevOps PAT). Pass via Authorization: Bearer <token> header.

Body

application/json

platform · enum<string> · required

Version control platform

Available options: github, gitlab, bitbucket, azure_devops, azuredevops

Example:

"github"

org · string · required

Organization, workspace, or group name on the platform

Example:

"my-org"

team_id · string<uuid> · required

user_login · string · required

Login/email of the member

Example:

"[e-mail]"

github_base_url · string · default: https://github.com

Base URL for GitHub (use for GitHub Enterprise Server)

Example:

"https://github.com"

gitlab_base_url · string · default: https://gitlab.com

Base URL for GitLab (use for self-hosted GitLab instances)

Example:

"https://gitlab.com"

azure_devops_base_url · string · default: https://dev.azure.com

Base URL for Azure DevOps (use for Azure DevOps Server)

Example:

"https://dev.azure.com"

bitbucket_base_url · string · default: https://api.bitbucket.org/2.0

Base URL for Bitbucket (use for Bitbucket Data Center/Server)

Example:

"https://api.bitbucket.org/2.0"

user_name · string

Display name (for add/update)

Example:

"Jane Doe"

role · enum<string> · default: member

Member role (for add/update)

Available options: member, lead

Response

200

application/json

Member added

status · string

Example:

"success"

message · string

Example:

"Member added successfully"

member · object

A member of a team

Show child attributes

team · object

A developer team with members, metadata, and repository assignments

Show child attributes