OBJECT

TenantUser

Represents a user in EchoStream that is authorized within a Tenant.

link GraphQL Schema definition

  • type TenantUser {
  • # When the user became active.
  • activeAt: AWSDateTime
  • # When and who created.
  • created: AtBy!
  • # The email.
  • email: AWSEmail!
  • # The first name.
  • firstName: String
  • # A set of layouts of the Tenant. Only ushoudl be used by the
  • # EchoStream Application UI.
  • graphLayouts: [GraphLayout!]
  • # When and who this user was invited to the Tenant.
  • invited: AtBy!
  • # When and who modified.
  • lastModified: AtBy!
  • # The last name.
  • lastName: String
  • # The role.
  • role: UserRole!
  • # The status.
  • status: UserStatus!
  • # The Tenant.
  • tenant: Tenant!
  • # Deletes this.
  • Delete: Boolean!
  • # Deletes a graph layout.
  • #
  • # Arguments
  • # name: The name of the layout.
  • DeleteGraphLayout(name: String!): Boolean!
  • # Lists the changes.
  • #
  • # Arguments
  • # endDateTime: The end date/time (inclusive) to list changes for
  • # in ISO8601 format. Defaults to now.
  • # exclusiveStartKey: The lastEvaluatedKey from a previous
  • # ChangeResult. Used when paginating.
  • # limit: Used for limiting the number of results when paginating.
  • # Defaults to "all".
  • # sortAscending: True for ascending results, False for descending
  • # result. Defaults to True.
  • # startDateTime: The start date/time (inclusive) to list changes
  • # for in ISO8601 format. Defaults to the beginning of time.
  • ListChanges(
  • endDateTime: AWSDateTime,
  • exclusiveStartKey: AWSJSON,
  • limit: Int,
  • sortAscending: Boolean,
  • startDateTime: AWSDateTime
  • ): ChangeResult!
  • # Saves and returns a graph layout.
  • #
  • # Arguments
  • # name: The name of the layout.
  • # layout: The layout.
  • SaveGraphLayout(name: String!, layout: AWSJSON!): GraphLayout!
  • # Updates and returns the TenantUser.
  • #
  • # Arguments
  • # role: The role. Null is ignored.
  • # status: The status. Null is ignored.
  • Update(role: UserRole, status: UserStatus): TenantUser!
  • }