Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Challenge ¶
type Challenge struct { // The challenge string. Challenge string `json:"challenge"` }
A challenge issued by webhooks to validate the endpoint is working correctly.
type CustomUser ¶
type CustomUser struct { // The external identifier for the user. Id string `json:"id"` // The human-readable display name of the user. // // The maximum length is 200 characters. DisplayName string `json:"displayName"` // The email address of the user. // // The maximum length is 320 characters. Email string `json:"email"` // Whether the user's email address has been verified. EmailVerified bool `json:"emailVerified"` // The E164 phone number for the user (e.g. `+12125550123`). PhoneNumber string `json:"phoneNumber"` // Whether the user's phone number has been verified. PhoneNumberVerified bool `json:"phoneNumberVerified"` // The photo/avatar URL of the user. // // The maximum length is 2000 characters. ImageUrl string `json:"imageUrl"` // Whether the user is disabled. Disabled bool `json:"disabled"` }
The user object for the Custom Users connection.
type DeleteCustomUserRequest ¶ added in v0.3.0
type DeleteCustomUserRequest struct { // The external identifier for the user. Id string `json:"id"` }
Request message for deleting a custom user.
type ErrorResponse ¶
type ErrorResponse struct { // The error code (e.g. `INVALID_ARGUMENT`). Code string `json:"code"` // A user-facing error message. Message string `json:"message"` }
The connection error response.
type GetCustomUserRequest ¶ added in v0.3.0
type GetCustomUserRequest struct { // The external identifier for the user. Id string `json:"id"` }
Request message for getting a custom user.
type ListCustomUsersRequest ¶ added in v0.3.0
type ListCustomUsersRequest struct { // The maximum number of users to return. The webhook is allowed to // return fewer than this value, but it should never return more. PageSize int32 `json:"pageSize"` // A page token, this is from the response of the previous list // request. // // This should be used to determine the next page of results. PageToken string `json:"pageToken"` }
Request message for listing custom users.
type ListCustomUsersResponse ¶
type ListCustomUsersResponse struct { // The list of users. Users []*CustomUser `json:"users"` // A token the webhook can set to indicate it has more results. // // This can be a page number, offset number, timestamp, or any value // the webhook handler wants to use for pagination. // // It must be encoded as a string. NextPageToken string `json:"nextPageToken"` }
Response message for listing custom users.
Click to show internal directories.
Click to hide internal directories.