OBJECT

ApiAccessEntity

API credentials that an integration uses to access the space, with the parts of the API they may read or write.

link GraphQL Schema definition

  • type ApiAccessEntity {
  • # True when the record is protected against deletion because it must always exist
  • # in the space. Deleting a record that is not protected can still fail on other
  • # checks. Read-only.
  • isDeleteProtected: Boolean!
  • # Unique identifier of entity. Must match with Application id.
  • id: ID!
  • # Specifies if the entity is considered deleted.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: DateTime
  • # Creation time.
  • created: DateTime
  • # Contact email associated with this API access. Used for credential change
  • # notifications.
  • email: String
  • # Whether this API access can authenticate. Set to false to disable the
  • # credentials without deleting the record; existing tokens stop working
  • # immediately.
  • isActive: Boolean
  • # Timestamp of the most recent successful authentication using this API access.
  • # Updated automatically on each use; empty for credentials that have never been
  • # used.
  • lastUsed: DateTime
  • # Per-section access permissions (records, administration, misc) granted to this
  • # API access. Determines which entities and operations the credentials can read or
  • # write.
  • permissions: ApiAccessPermissions
  • # Authentication type of this API access (e.g. standard API key vs. OAuth client).
  • # Set automatically on create and cannot be changed.
  • type: ApiAccessTypeEnum!
  • # Name for the api access.
  • name: String
  • # Formerly API Access.
  • username: String
  • # Formerly API Password. Only available during create or for migrated legacy
  • # access. Otherwise, it is null.
  • plainPassword: String
  • # Permissions the current user has on this record, out of the requested ones.
  • #
  • # Arguments
  • # permissions: Permissions to check; the result lists those the
  • # current user has.
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • }

link Require by