• Teams Public API
    • Teams Members Public API
    • Externally Linked Teams Public API
    Platform
    Teams / / Schemas

    Externally Linked Teams Public API

    Postman Collection
    OpenAPI
    POST

    Create an external linked team.

    Creates an external linked team, and membership will be synced with the external reference.

    Request

    Path parameters

    orgId

    string

    Required

    Request bodyapplication/json

    Details of the team to be created.

    description

    string

    Required
    externalReference

    PublicApiExternalReference

    Required
    siteId

    string

    Responses

    Team created successfully. The details of the team are in the response, including the team ID, which can be used to reference the team for other operations.

    application/json

    PublicApiTeamResponse
    POST/public/teams/v1/org/{orgId}/teams/external
    1 2 3 4 5 6 7 8 9 10 11 12 curl --request POST \ --url 'https://api.atlassian.com/public/teams/v1/org/{orgId}/teams/external' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "description": "<string>", "externalReference": { "id": "<string>", "source": "ATLASSIAN_GROUP" }, "siteId": "<string>" }'
    201Response
    1 2 3 4 5 6 7 8 9 10 11 12 13 { "description": "<string>", "displayName": "<string>", "organizationId": "<string>", "teamId": "<string>", "teamType": "OPEN", "userPermissions": { "ADD_MEMBERS": true, "DELETE_TEAM": true, "REMOVE_MEMBERS": true, "UPDATE_TEAM": true } }
    POST

    Link an existing team to an external reference.

    Links an existing team to an external reference, and membership and team name will be synced with the external reference.

    Request

    Path parameters

    orgId

    string

    Required
    teamId

    string

    Required

    Request bodyapplication/json

    externalReference

    PublicApiExternalReference

    Required
    siteId

    string

    Responses

    Team linked to external reference successfully.

    POST/public/teams/v1/org/{orgId}/teams/{teamId}/external/link
    1 2 3 4 5 6 7 8 9 10 curl --request POST \ --url 'https://api.atlassian.com/public/teams/v1/org/{orgId}/teams/{teamId}/external/link' \ --header 'Content-Type: application/json' \ --data '{ "externalReference": { "id": "<string>", "source": "ATLASSIAN_GROUP" }, "siteId": "<string>" }'

    Rate this page: