OBJECT

CreateUserPayload

Return type for 'createUser' mutation.

link GraphQL Schema definition

  • type CreateUserPayload {
  • # Unique identifier for a user.
  • userId: String!
  • # A link to have the newly created user sign in.
  • signInUrl: String!
  • # A link to have the user reset their password.
  • # Link is for any user that is able to sign in using a password (SSO plans that
  • # allow credential sign in also fall into this category) and is useful when the
  • # API consumer wants to do something custom with the password setting process. An
  • # example would be sending the user over to the password reset page directly
  • # instead of waiting for them to click an invite email. The link will be valid for
  • # 1 hour after it is generated.
  • passwordResetLink: String!
  • # User's email.
  • email: String!
  • # User's unique username.
  • username: String!
  • # User's first name.
  • firstName: String!
  • # User's last name.
  • lastName: String!
  • # A true response means that the invite is queued and will eventually attempt to
  • # send to the email of the newly created user.
  • # A false response means the invite was not queued and will not be sent.
  • # A null response means an invite was not attempted.
  • inviteSuccessful: Boolean
  • # Represents an invitation id if inviteSuccessful is true.
  • inviteId: String
  • }