@itentialopensource/adapter-github/entities/Users/schema.json

This adapter integrates with system described as: github.

{
  "$id": "schema.json",
  "type": "object",
  "schema": "http://json-schema.org/draft-07/schema#",
  "translate": true,
  "dynamicfields": true,
  "properties": {
    "ph_request_type": {
      "type": "string",
      "description": "type of request (internal to adapter)",
      "default": "getUsers",
      "enum": [
        "getUsers",
        "getUsersUsername",
        "getUsersUsernameEvents",
        "getUsersUsernameEventsOrgsOrg",
        "getUsersUsernameFollowers",
        "getUsersUsernameFollowingTargetUser",
        "getUsersUsernameGists",
        "getUsersUsernameKeys",
        "getUsersUsernameOrgs",
        "getUsersUsernameReceivedEvents",
        "getUsersUsernameReceivedEventsPublic",
        "getUsersUsernameRepos",
        "getUsersUsernameStarred",
        "getUsersUsernameSubscriptions",
        "usersListBlockedByAuthenticatedUser",
        "usersCheckBlocked",
        "usersBlock",
        "usersUnblock",
        "usersSetPrimaryEmailVisibilityForAuthenticatedUser",
        "usersListGpgKeysForAuthenticatedUser",
        "usersCreateGpgKeyForAuthenticatedUser",
        "usersGetGpgKeyForAuthenticatedUser",
        "usersDeleteGpgKeyForAuthenticatedUser",
        "usersListPublicEmailsForAuthenticatedUser",
        "usersListSocialAccountsForAuthenticatedUser",
        "usersAddSocialAccountForAuthenticatedUser",
        "usersDeleteSocialAccountForAuthenticatedUser",
        "usersListSshSigningKeysForAuthenticatedUser",
        "usersCreateSshSigningKeyForAuthenticatedUser",
        "usersGetSshSigningKeyForAuthenticatedUser",
        "usersDeleteSshSigningKeyForAuthenticatedUser",
        "usersGetById",
        "usersListAttestations",
        "usersListFollowingForUser",
        "usersCheckFollowingForUser",
        "usersListGpgKeysForUser",
        "usersGetContextForUser",
        "usersListSocialAccountsForUser",
        "usersListSshSigningKeysForUser"
      ],
      "external_name": "ph_request_type"
    },
    "perPage": {
      "type": "number",
      "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated)",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "per_page"
    },
    "gpgKeyId": {
      "type": "number",
      "description": "The unique identifier of the GPG key.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "gpg_key_id"
    },
    "sshSigningKeyId": {
      "type": "number",
      "description": "The unique identifier of the SSH signing key.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "ssh_signing_key_id"
    },
    "accountId": {
      "type": "number",
      "description": "account_id parameter",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "account_id"
    },
    "subjectDigest": {
      "type": "string",
      "description": "Subject Digest",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "subject_digest"
    },
    "targetUser": {
      "type": "string",
      "description": "",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "target_user"
    },
    "subjectType": {
      "type": "string",
      "description": "Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** whe...(description truncated)",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "subject_type"
    },
    "subjectId": {
      "type": "string",
      "description": "Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "subject_id"
    }
  },
  "definitions": {}
}