Auth Integration Connections

Get all Auth Integration connections

Get all Auth Integration connection resources that are related to the user who makes the request.

GET /api/v2/auth-integrations/

Query Parameters

Fields	Required	Description
search	No	Filter search queries by integration type.
page_size	No	Page size of the returned response. Set to 10 by default.

GET /api/v2/auth-integrations/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 1,
            "integration_type": "GITHUB_OAUTH_2_0",
            "user": 1
        }
    ]
}

Get a specific Auth Integration connection

Returns a single Auth Integration connection resource that is related to the user who makes the request.

GET /api/v2/auth-integrations/<id>/

URL Parameters

Parameter	Description
id	The id of the auth integration to retrieve

GET /api/v2/auth-integrations/1/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
{
    "id": 1,
    "integration_type": "GITHUB_OAUTH_2_0",
    "user": 1
}

Create a new Auth Integration connection

Creates a new Auth Integration connection resource for the request user.

POST /api/v2/auth-integrations/

Payload

Fields	Required	Description
integration_type	Yes	Enum that identifies the type of third-party authentication provider. Can be one of the following: GITHUB_OAUTH_2_0 GITLAB_OAUTH_2_0
access_token	Yes	The access token received from a third-party authentication provider such as GitHub OAuth 2.0

POST /api/v2/auth-integrations/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

{
    "integration_type": "GITHUB_OAUTH_2_0",
    "access_token": "example_access_token"
}

HTTP/1.1 201 CREATED
Content-Type: application/json

{
    "id": 1,
    "integration_type": "GITHUB_OAUTH_2_0",
    "user": 1
}

Delete an Auth Integration connection

Deletes an Auth Integration connection resource.

DELETE /api/v2/auth-integrations/<id>/

Parameter	Description
id	The id of the auth integration to delete

DELETE /api/v2/auth-integrations/1/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

HTTP/1.1 204 NO CONTENT

Auth Integrations