OBJECT

ApiUser

A programmatic user of the EchoStream API.

GraphQL Schema definition

type ApiUser {
#   The AppSync Endpoint used by this api user
appsyncEndpoint: AWSURL! 
#   When and who created.
created: AtBy! 
#   The credentials required to log into Cognito to get JWT's.
credentials: CognitoCredentials! 
#   A human-readable description.
description: String 
#   When and who modified.
lastModified: AtBy! 
#   The role.
role: ApiUserRole! 
#   The Tenant.
tenant: Tenant! 
#   The username.
username: String! 
#   Deletes this.
Delete: 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! 
#   Resets the password used in credentials and returns the ApiUser.
ResetPassword: ApiUser! 
#   Updates and returns this APIUser
# 
# Arguments
#   description: A human-readable description. Null is ignored.
#   role: The new role. Null is ignored.
Update(description: String, role: ApiUserRole): ApiUser! 
}

ApiUser

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by