redirecturls

Documentation

Index

• type CreateRequest
• type CreateResponse
• type DeleteRequest
• type DeleteResponse
• type GetAllRequest
• type GetAllResponse
• type GetRequest
• type GetResponse
• type RedirectType
  • func RedirectTypes() []RedirectType
• type RedirectURL
• type URLRedirectType
• type UpdateRequest
• type UpdateResponse

Types

type CreateRequest

type CreateRequest struct {
	// ProjectID is the ID of the project to create the redirect URL for
	ProjectID string `json:"project_id"`
	// RedirectURL is the object that will be created
	RedirectURL RedirectURL `json:"redirect_url"`
	// DoNotPromoteDefaults is used to suppress the automatic "promotion" of a RedirectURL to the default if no other
	// RedirectURL exists for the given type. This is primarily intended for use with stytchauth/terraform-provider-stytch
	// to allow terraform provisioning to be idempotent. For a Create request, the default behavior is to promote the
	// RedirectURL to the default if no other RedirectURL exists for the given type, even if `IsDefault` was set to false.
	//
	// WARNING: If this is set to true, it is possible to have valid RedirectURLs for a given type but *no* default
	// RedirectURL for that type. If no default exists for a given type, using an API endpoint that utilizes redirect
	// URLs (such as sending a magic link), you will need to explicitly specify which redirect URL should be used.
	DoNotPromoteDefaults bool `json:"do_not_promote_defaults"`
}

type CreateResponse

type CreateResponse struct {
	// StatusCode is the HTTP status code of the response
	StatusCode int `json:"status_code"`
	// RequestID is a unique identifier to help with debugging the request
	RequestID string `json:"request_id"`
	// RedirectURL is the object that was created
	RedirectURL RedirectURL `json:"redirect_url"`
}

type DeleteRequest

type DeleteRequest struct {
	// ProjectID is the ID of the project to delete the redirect URL from
	ProjectID string `json:"project_id"`
	// URL is the redirect URL to delete
	URL string `json:"url"`
	// DoNotPromoteDefaults is used to suppress the automatic "promotion" of a RedirectURL to the default if no other
	// RedirectURL exists for the given type. This is primarily intended for use with stytchauth/terraform-provider-stytch
	// to allow terraform provisioning to be idempotent. For a Delete request, the default behavior is to promote some
	// other valid redirect URL for the given type to the new default if *this* URL was the current default.
	//
	// WARNING: If this is set to true, it is possible to have valid RedirectURLs for a given type but *no* default
	// RedirectURL for that type. If no default exists for a given type, using an API endpoint that utilizes redirect
	// URLs (such as sending a magic link), you will need to explicitly specify which redirect URL should be used.
	DoNotPromoteDefaults bool `json:"do_not_promote_defaults"`
}

type DeleteResponse

type DeleteResponse struct {
	// StatusCode is the HTTP status code of the response
	StatusCode int `json:"status_code"`
	// RequestID is a unique identifier to help with debugging the request
	RequestID string `json:"request_id"`
}

type GetAllRequest

type GetAllRequest struct {
	// ProjectID is the ID of the project to get all the redirect URLs from
	ProjectID string `json:"project_id"`
}

type GetAllResponse

type GetAllResponse struct {
	// StatusCode is the HTTP status code of the response
	StatusCode int `json:"status_code"`
	// RequestID is a unique identifier to help with debugging the request
	RequestID string `json:"request_id"`
	// ProjectID is the ID of the project for the redirect URLs
	ProjectID string `json:"project_id"`
	// RedirectURLs is a list of all the redirect URLs for the project
	RedirectURLs []RedirectURL `json:"redirect_urls"`
}

type GetRequest

type GetRequest struct {
	// ProjectID is the ID of the project to get the redirect URL from
	ProjectID string `json:"project_id"`
	// URL is the redirect URL to get
	URL string `json:"url"`
}

type GetResponse

type GetResponse struct {
	// StatusCode is the HTTP status code of the response
	StatusCode int `json:"status_code"`
	// RequestID is a unique identifier to help with debugging the request
	RequestID string `json:"request_id"`
	// RedirectURL is the object that was retrieved
	RedirectURL RedirectURL `json:"redirect_url"`
}

type RedirectType

type RedirectType string

RedirectType are the different types of redirect available.

const (
	RedirectTypeLogin         RedirectType = "LOGIN"
	RedirectTypeSignup        RedirectType = "SIGNUP"
	RedirectTypeInvite        RedirectType = "INVITE"
	RedirectTypeResetPassword RedirectType = "RESET_PASSWORD"
	// RedirectTypeDiscovery is used for the discovery endpoint exclusively in B2B projects.
	RedirectTypeDiscovery RedirectType = "DISCOVERY"
)

func RedirectTypes

func RedirectTypes() []RedirectType

type RedirectURL

type RedirectURL struct {
	// URL is the URL to redirect to.
	URL string `json:"url"`
	// ValidTypes is a list of all the URLRedirectType available for this object
	ValidTypes []URLRedirectType `json:"valid_types"`
}

RedirectURL holds information for a specific redirect URL and all its redirect types

type URLRedirectType

type URLRedirectType struct {
	// Type is one of the RedirectType values.
	Type RedirectType `json:"type"`
	// IsDefault is true if this is the default redirect type, false otherwise.
	IsDefault bool `json:"is_default"`
}

URLRedirectType holds information for a specific kind of redirect.

type UpdateRequest

type UpdateRequest struct {
	// ProjectID is the ID of the project to update the redirect URL in
	ProjectID string `json:"project_id"`
	// RedirectURL is the object that will be updated
	RedirectURL RedirectURL `json:"redirect_url"`
	// DoNotPromoteDefaults is used to suppress the automatic "promotion" of a RedirectURL to the default if no other
	// RedirectURL exists for the given type. This is primarily intended for use with stytchauth/terraform-provider-stytch
	// to allow terraform provisioning to be idempotent. For an Update request, the default behavior is a combination of
	// what happens for Create and Delete requests:
	// - If the RedirectURL is having a new valid type added, it may be promoted to the default if no other RedirectURL
	//   exists for that type.
	// - If the RedirectURL is having a valid type removed and is *currently* the default for that type, a new default
	//   will be promoted from the remaining URLs for that type.
	//
	// WARNING: If this is set to true, it is possible to have valid RedirectURLs for a given type but *no* default
	// RedirectURL for that type. If no default exists for a given type, using an API endpoint that utilizes redirect
	// URLs (such as sending a magic link), you will need to explicitly specify which redirect URL should be used.
	DoNotPromoteDefaults bool `json:"do_not_promote_defaults"`
}

type UpdateResponse

type UpdateResponse struct {
	// StatusCode is the HTTP status code of the response
	StatusCode int `json:"status_code"`
	// RequestID is a unique identifier to help with debugging the request
	RequestID string `json:"request_id"`
	// RedirectURL is the object that was updated
	RedirectURL RedirectURL `json:"redirect_url"`
}