Social Connection

An Object

Table of Contents
Note

Drop in one of our language drivers to accelerate your development.
Here are links to some of our popular Cookbooks to help you get started!

Parent

This Social Connection is contained within a Directory.

Properties

The following properties are available:

Property Type Default Read-Only Description
_doc string No The primary ID
_system object No Metadata maintained by the system
accessToken string No
displayName string No
expireTime string No
identity-id string No
imageUrl string No
profileUrl string No
providerId string No
providerUserId string No
refreshToken string No
secret string No

Methods

The following methods are available:

Check Permission

Checks whether one or more authorities against the specified connection are granted for a given set of users
POST /directories/{directoryId}/connections/{connectionId}/permissions/{permissionId}/check

Parameters

Name Required Type Description
directoryId true string
connectionId true string
permissionId true string
id true string

Response

{
  "$ref": "#/components/schemas/checkPermission"
}

Check Single Authority

Checks whether a single authority is granted against the specified connection for the given user
POST /directories/{directoryId}/connections/{connectionId}/authorities/{authorityId}/check

Parameters

Name Required Type Description
directoryId true string
connectionId true string
authorityId true string
id true string

Response

{
  "type": "object",
  "description": "Check",
  "extends": "status",
  "properties": {
    "check": {
      "type": "boolean"
    },
    "ok": null
  }
}

Check multiple Authorities

Checks whether one or more authorities against the specified connection are granted for a given set of users
POST /directories/{directoryId}/connections/authorities/check

Parameters

Name Required Type Description
directoryId true string The ID of the directory

Response

{
  "type": "object",
  "description": "Check Multiple Authorities Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "authorityId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Check multiple Permissions

Checks whether one or more permissions against the specified connection are granted for a given set of users
POST /directories/{directoryId}/connections/permissions/check

Parameters

Name Required Type Description
directoryId true string

Response

{
  "type": "object",
  "description": "Check Multiple Permissions Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "permissionId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Connections

GET /directories/{directoryId}/identities/{identityId}/connections

Parameters

Name Required Type Description
directoryId true string
identityId true string

Response

{}

Create Social Connection

Creates a new Social Connection
POST /directories/{directoryId}/connections

Parameters

Name Required Type Description
directoryId true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Delete Social Connection

Deletes an existing Social Connection
DELETE /directories/{directoryId}/connections/{connectionId}

Parameters

Name Required Type Description
directoryId true string
connectionId true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Finduser

POST /domains/{domainId}/connections/finduser

Parameters

Name Required Type Description
domainId true string
providerId true string
providerUserId true string

Response

{}

Grant Authority

Grants an authority against the specified connection to a given user
POST /directories/{directoryId}/connections/{connectionId}/authorities/{authorityId}/grant

Parameters

Name Required Type Description
directoryId true string
connectionId true string
authorityId true string
id true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Lists Social Connection

Retrieves a list of Social Connection instances
GET /directories/{directoryId}/connections

Parameters

Name Required Type Description
directoryId true string
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_connection"
      }
    }
  }
}

Queries for Social Connection

Queries for instances of type Social Connection
POST /directories/{directoryId}/connections/query

Parameters

Name Required Type Description
directoryId true string
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_connection"
      }
    }
  }
}

Read ACL

Read the Access Control List for the specified connection
GET /directories/{directoryId}/connections/{connectionId}/acl/list

Parameters

Name Required Type Description
directoryId true string
connectionId true string

Response

{
  "type": "object",
  "description": "Result Map of ACL entries",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "_doc": {
            "type": "string",
            "title": "Principal ID"
          },
          "name": {
            "type": "string",
            "title": "Principal Name"
          },
          "type": {
            "type": "string",
            "title": "Principal Type"
          },
          "domainId": {
            "type": "string"
          },
          "domainQualifiedId": {
            "type": "string"
          },
          "domainQualifiedName": {
            "type": "string"
          },
          "principalId": {
            "type": "string",
            "title": "Principal ID"
          },
          "userEmail": {
            "type": "string"
          },
          "userFirstName": {
            "type": "string"
          },
          "userLastName": {
            "type": "string"
          },
          "authorities": {
            "type": "array",
            "title": "Authorities",
            "items": {
              "type": "string",
              "title": "Authority Key"
            }
          }
        }
      }
    }
  }
}

Read ACL for Principal

Reads the ACL for a connection and specific actor
GET /directories/{directoryId}/connections/{connectionId}/acl

Parameters

Name Required Type Description
directoryId true string
connectionId true string
id true string

Response

{
  "type": "object",
  "description": "Result Map of Authority Keys",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "Authority Key"
      }
    }
  }
}

Read Authorities Report

Read the Authorities Report for the specified connection
POST /directories/{directoryId}/connections/{connectionId}/authorities

Parameters

Name Required Type Description
directoryId true string
connectionId true string

Response

{
  "type": "object",
  "description": "Authority Report",
  "properties": {
    "principalId": {
      "type": "object",
      "properties": {
        "id": {
          "type": "object",
          "properties": {
            "role-key": {
              "type": "string"
            },
            "principal": {
              "type": "string"
            },
            "permissioned": {
              "type": "string"
            },
            "inheritsFrom": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "principal": {
                  "type": "string"
                },
                "permissioned": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

Read Social Connection

Reads an instance of a Social Connection
GET /directories/{directoryId}/connections/{connectionId}

Parameters

Name Required Type Description
directoryId true string
connectionId true string

Response

{
  "type": "object",
  "extends": "document",
  "container": "directory",
  "description": "Social Connection",
  "properties": {
    "identity-id": {
      "type": "string"
    },
    "providerUserId": {
      "type": "string"
    },
    "providerId": {
      "type": "string"
    },
    "displayName": {
      "type": "string"
    },
    "profileUrl": {
      "type": "string"
    },
    "imageUrl": {
      "type": "string"
    },
    "accessToken": {
      "type": "string"
    },
    "secret": {
      "type": "string"
    },
    "refreshToken": {
      "type": "string"
    },
    "expireTime": {
      "type": "string"
    },
    "_doc": null,
    "_system": null
  }
}

Revoke Authority

Revokes an authority against the specified connection from a given user
POST /directories/{directoryId}/connections/{connectionId}/authorities/{authorityId}/revoke

Parameters

Name Required Type Description
directoryId true string
connectionId true string
authorityId true string
id true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Starts an export job for this resource

Starts an export job for this resource
POST /directories/{directoryId}/connections/{connectionId}/export

Parameters

Name Required Type Description
directoryId true string
connectionId true string
groupId false string The Group ID to be assigned to the exported archive
artifactId false string The Artifact ID to be assigned to the exported archive
versionId false string The Version ID to be assigned to the exported archive
vaultId false string The ID of the vault where the exported archive should be saved
schedule false string Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous')

Response

{
  "type": "object",
  "description": "Export Configuration",
  "properties": {
    "startDate": {
      "type": "object"
    },
    "endDate": {
      "type": "object"
    },
    "startChangeset": {
      "type": "string"
    },
    "endChangeset": {
      "type": "string"
    },
    "includeACLs": {
      "type": "boolean"
    },
    "includeTeams": {
      "type": "boolean"
    },
    "includeActivities": {
      "type": "boolean"
    },
    "includeBinaries": {
      "type": "boolean"
    },
    "includeAttachments": {
      "type": "boolean"
    },
    "artifactDependencies": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "artifactIncludes": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "forceIncludes": {
      "type": "boolean"
    }
  }
}

Starts an import job for this resource

Starts an import job for this resource
POST /directories/{directoryId}/connections/{connectionId}/import

Parameters

Name Required Type Description
directoryId true string
connectionId true string
groupId false string The Group ID to be assigned to the exported archive
artifactId false string The Artifact ID to be assigned to the exported archive
versionId false string The Version ID to be assigned to the exported archive
vaultId false string The ID of the vault where the exported archive should be saved
schedule false string Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous')

Response

{
  "type": "object",
  "description": "Import Configuration",
  "properties": {
    "includeACLs": {
      "type": "boolean"
    },
    "includeTeams": {
      "type": "boolean"
    },
    "includeActivities": {
      "type": "boolean"
    },
    "includeBinaries": {
      "type": "boolean"
    },
    "includeAttachments": {
      "type": "boolean"
    },
    "strategy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "substitutions": {
      "type": "string"
    }
  }
}

Sync

POST /domains/{domainId}/connections/sync

Parameters

Name Required Type Description
domainId true string
providerId true string
providerUserId true string
autoCreate false string

Response

{}

Update Social Connection

Updates an existing Social Connection
PUT /directories/{directoryId}/connections/{connectionId}

Parameters

Name Required Type Description
directoryId true string
connectionId true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Schema


{
  "type": "object",
  "extends": "document",
  "container": "directory",
  "description": "Social Connection",
  "properties": {
    "identity-id": {
      "type": "string"
    },
    "providerUserId": {
      "type": "string"
    },
    "providerId": {
      "type": "string"
    },
    "displayName": {
      "type": "string"
    },
    "profileUrl": {
      "type": "string"
    },
    "imageUrl": {
      "type": "string"
    },
    "accessToken": {
      "type": "string"
    },
    "secret": {
      "type": "string"
    },
    "refreshToken": {
      "type": "string"
    },
    "expireTime": {
      "type": "string"
    },
    "_doc": null,
    "_system": null
  },
  "id": "connection"
}