Deactivate a Connection

Deactivates a Connection. Either the source or destination organization may deactivate a connection that is currently pending or active. Deactivation prevents further access through the connection but maintains the connection record. Connections that are already inactive cannot be deactivated again.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

connection-idstringRequired

ID of the connect connection

Response

This endpoint returns a Connection.

dataobject

A Connect Connection object. This object represents a connection between organizations for sharing access to Persona objects.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error

Bearer authentication of the form Bearer <token>, where token is your auth token.

ID of the connect connection

Determines casing for the API response.

Ensures the request is idempotent.

Server API version. More info on versioning can be found here.

Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).

This endpoint returns a Connection.

A Connect Connection object. This object represents a connection between organizations for sharing access to Persona objects.

Server API version. More info on versioning can be found here.

1	{
2	"data": {
3	"type": "connect/connection",
4	"id": "cxn_ABC123",
5	"attributes": {
6	"status": "inactive",
7	"destination-organization-id": "org_XYZ789",
8	"source-organization-id": "org_ABC123",
9	"created-at": "2018-06-01T00:00:00.000Z",
10	"updated-at": "2018-06-01T00:00:00.000Z"
11	}
12	}
13	}

1	{
2	"data": {
3	"type": "connect/connection",
4	"id": "cxn_ABC123",
5	"attributes": {
6	"status": "inactive",
7	"destination-organization-id": "org_XYZ789",
8	"source-organization-id": "org_ABC123",
9	"created-at": "2018-06-01T00:00:00.000Z",
10	"updated-at": "2018-06-01T00:00:00.000Z"
11	}
12	}
13	}

Deactivate a Connection

Deactivate a Connection

Authentication

Path parameters

Headers

Response

Errors

Authentication

Path parameters

Headers

Response

Errors

$	curl -X POST https://api.withpersona.com/api/v1/connect/connections/connection-id/deactivate \
>	-H "Authorization: Bearer <token>"