ssoready

type CreateOrganizationResponse struct {
	// The created organization.
	Organization *Organization `json:"organization,omitempty" url:"organization,omitempty"`
	// contains filtered or unexported fields
}

type CreateSAMLConnectionResponse struct {
	// The created SAML connection.
	SAMLConnection *SAMLConnection `json:"samlConnection,omitempty" url:"samlConnection,omitempty"`
	// contains filtered or unexported fields
}

type CreateSCIMDirectoryResponse struct {
	// The updated SCIM directory.
	SCIMDirectory *SCIMDirectory `json:"scimDirectory,omitempty" url:"scimDirectory,omitempty"`
	// contains filtered or unexported fields
}

type CreateSetupURLResponse struct {
	// The one-time, short-lived self-serve setup URL.
	//
	// Do not log or store this URL. Because this URL is one-time, loading it yourself means your customer will not be
	// able to load it after you.
	URL *string `json:"url,omitempty" url:"url,omitempty"`
	// contains filtered or unexported fields
}

type GetOrganizationResponse struct {
	// The requested organization.
	Organization *Organization `json:"organization,omitempty" url:"organization,omitempty"`
	// contains filtered or unexported fields
}

type GetSAMLConnectionResponse struct {
	// The requested SAML connection.
	SAMLConnection *SAMLConnection `json:"samlConnection,omitempty" url:"samlConnection,omitempty"`
	// contains filtered or unexported fields
}

type GetSAMLRedirectURLRequest struct {
	// The SAML connection to start a SAML login for.
	//
	//	One of `samlConnectionId`, `organizationId`, or `organizationExternalId` must be specified.
	SAMLConnectionID *string `json:"samlConnectionId,omitempty" url:"-"`
	// The ID of the organization to start a SAML login for.
	//
	//	The primary SAML connection in this organization will be used for logins.
	//
	//	One of `samlConnectionId`, `organizationId`, or `organizationExternalId` must be specified.
	OrganizationID *string `json:"organizationId,omitempty" url:"-"`
	// The `externalId` of the organization to start a SAML login for.
	//
	//	The primary SAML connection in this organization will be used for logins.
	//
	//	One of `samlConnectionId`, `organizationId`, or `organizationExternalId` must be specified.
	OrganizationExternalID *string `json:"organizationExternalId,omitempty" url:"-"`
	// This string will be returned back to you when you redeem this login's SAML access code.
	//
	//	You can do anything you like with this `state`, but the most common use-case is to keep track of where to redirect
	//	your user back to after logging in with SAML.
	State *string `json:"state,omitempty" url:"-"`
}

type GetSAMLRedirectURLResponse struct {
	// Redirect your user to this URL to start a SAML login.
	RedirectURL *string `json:"redirectUrl,omitempty" url:"redirectUrl,omitempty"`
	// contains filtered or unexported fields
}

type GetSCIMDirectoryResponse struct {
	// The requested SCIM directory.
	SCIMDirectory *SCIMDirectory `json:"scimDirectory,omitempty" url:"scimDirectory,omitempty"`
	// contains filtered or unexported fields
}

type GetSCIMGroupResponse struct {
	// The requested SCIM group.
	SCIMGroup *SCIMGroup `json:"scimGroup,omitempty" url:"scimGroup,omitempty"`
	// contains filtered or unexported fields
}

type GetSCIMUserResponse struct {
	// The requested SCIM user.
	SCIMUser *SCIMUser `json:"scimUser,omitempty" url:"scimUser,omitempty"`
	// contains filtered or unexported fields
}

type GoogleProtobufAny struct {
	// The type of the serialized message.
	Type *string `json:"@type,omitempty" url:"@type,omitempty"`

	ExtraProperties map[string]interface{} `json:"-" url:"-"`
	// contains filtered or unexported fields
}

type ListOrganizationsResponse struct {
	// List of organizations.
	Organizations []*Organization `json:"organizations,omitempty" url:"organizations,omitempty"`
	// Value to use as `pageToken` for the next page of data. Empty if there is no more data.
	NextPageToken *string `json:"nextPageToken,omitempty" url:"nextPageToken,omitempty"`
	// contains filtered or unexported fields
}

type ListSAMLConnectionsResponse struct {
	// The list of SAML connections.
	SAMLConnections []*SAMLConnection `json:"samlConnections,omitempty" url:"samlConnections,omitempty"`
	// Value to use as `pageToken` for the next page of data. Empty if there is no more data.
	NextPageToken *string `json:"nextPageToken,omitempty" url:"nextPageToken,omitempty"`
	// contains filtered or unexported fields
}

type ListSCIMDirectoriesResponse struct {
	// The list of SCIM directories.
	SCIMDirectories []*SCIMDirectory `json:"scimDirectories,omitempty" url:"scimDirectories,omitempty"`
	// Value to use as `pageToken` for the next page of data. Empty if there is no more data.
	NextPageToken *string `json:"nextPageToken,omitempty" url:"nextPageToken,omitempty"`
	// contains filtered or unexported fields
}

type ListSCIMGroupsResponse struct {
	// List of SCIM groups.
	SCIMGroups []*SCIMGroup `json:"scimGroups,omitempty" url:"scimGroups,omitempty"`
	// Value to use as `pageToken` for the next page of data. Empty if there is no more data.
	NextPageToken *string `json:"nextPageToken,omitempty" url:"nextPageToken,omitempty"`
	// contains filtered or unexported fields
}

type ListSCIMUsersResponse struct {
	// List of SCIM users.
	SCIMUsers []*SCIMUser `json:"scimUsers,omitempty" url:"scimUsers,omitempty"`
	// Value to use as `pageToken` for the next page of data. Empty if there is no more data.
	NextPageToken *string `json:"nextPageToken,omitempty" url:"nextPageToken,omitempty"`
	// contains filtered or unexported fields
}

type Organization struct {
	// Unique identifier for this organization.
	ID *string `json:"id,omitempty" url:"id,omitempty"`
	// The environment this organization belongs to.
	EnvironmentID *string `json:"environmentId,omitempty" url:"environmentId,omitempty"`
	// An optional human-friendly name for this organization.
	DisplayName *string `json:"displayName,omitempty" url:"displayName,omitempty"`
	// An identifier you can attach to an organization. Meant to be used to correlate an SSOReady organization to your
	// internal equivalent concept.
	//
	// External IDs are unique within an environment. No two organizations in the same environment can have
	// the same external ID.
	ExternalID *string `json:"externalId,omitempty" url:"externalId,omitempty"`
	// A list of domains that users from this organization use.
	//
	// SAML connections and SCIM directories within this organization will only produce users whose email are included in
	// `domains`. SSOReady will reject SAML and SCIM users that do not fall within `domains`.
	Domains []string `json:"domains,omitempty" url:"domains,omitempty"`
	// contains filtered or unexported fields
}

type RedeemSAMLAccessCodeRequest struct {
	// The SAML access code to redeem.
	SAMLAccessCode *string `json:"samlAccessCode,omitempty" url:"-"`
}

type RedeemSAMLAccessCodeResponse struct {
	// The user's email address.
	Email *string `json:"email,omitempty" url:"email,omitempty"`
	// The `state` you provided when getting a SAML initiation URL, if any.
	//
	// If your user logged in to your product using Identity Provider-initiated SAML (e.g. they clicked on your app inside
	// their corporate Okta dashboard), then `state` will be empty.
	//
	// SSOReady validates the authenticity of non-empty `state` values. You do not need to implement your own CSRF on top
	// of it, but doing so anyway will have no bad consequences.
	State *string `json:"state,omitempty" url:"state,omitempty"`
	// Arbitrary key-value pairs the Identity Provider included about the user.
	//
	// Typically, these `attributes` are used to pass along the user's first/last name, or whether they should be
	// considered an admin within their company.
	Attributes map[string]string `json:"attributes,omitempty" url:"attributes,omitempty"`
	// The ID of the organization this user belongs to.
	OrganizationID *string `json:"organizationId,omitempty" url:"organizationId,omitempty"`
	// The `externalId`, if any, of the organization this user belongs to.
	OrganizationExternalID *string `json:"organizationExternalId,omitempty" url:"organizationExternalId,omitempty"`
	// A unique identifier of this particular SAML login. It is not a secret. You can safely log it.
	//
	// SSOReady maintains an audit log of every SAML login. Use this SAML flow ID to find this login in the audit logs.
	SAMLFlowID *string `json:"samlFlowId,omitempty" url:"samlFlowId,omitempty"`
	// contains filtered or unexported fields
}

type RotateSCIMDirectoryBearerTokenResponse struct {
	// The new, updated bearer token.
	//
	// Do not log or store this bearer token. It is an authentication token that your customer should securely input into
	// their Identity Provider.
	BearerToken *string `json:"bearerToken,omitempty" url:"bearerToken,omitempty"`
	// contains filtered or unexported fields
}

type SAMLConnection struct {
	// Unique identifier for this SAML connection.
	ID *string `json:"id,omitempty" url:"id,omitempty"`
	// The organization this SAML connection belongs to.
	OrganizationID *string `json:"organizationId,omitempty" url:"organizationId,omitempty"`
	// Whether this is the primary SAML connection for the organization.
	Primary *bool `json:"primary,omitempty" url:"primary,omitempty"`
	// URL to redirect to when initiating SAML flows.
	//
	// IDP redirect URLs are assigned by an Identity Provider, and need to be inputted into SSOReady.
	IdpRedirectURL *string `json:"idpRedirectUrl,omitempty" url:"idpRedirectUrl,omitempty"`
	// Certificate to authenticate SAML assertions. This is a PEM-encoded X.509 certificate.
	//
	// IDP certificates are assigned by an Identity Provider, and need to be inputted into SSOReady.
	IdpCertificate *string `json:"idpCertificate,omitempty" url:"idpCertificate,omitempty"`
	// Identifier for the identity provider when handling SAML operations.
	//
	// IDP entity IDs are assigned by an Identity Provider, and need to be inputted into SSOReady.
	IdpEntityID *string `json:"idpEntityId,omitempty" url:"idpEntityId,omitempty"`
	// Identifier for the SAML connection when handling SAML operations.
	//
	// SP entity IDs are assigned by SSOReady, and need to be inputted into your customer's Identity Provider.
	SpEntityID *string `json:"spEntityId,omitempty" url:"spEntityId,omitempty"`
	// URL the Identity Provider redirects to when transmitting SAML assertions. Stands for "Service Provider Assertion
	// Consumer Service" URL.
	//
	// SP ACS URLs are assigned by SSOReady, and need to be inputted into your customer's Identity Provider.
	SpAcsURL *string `json:"spAcsUrl,omitempty" url:"spAcsUrl,omitempty"`
	// contains filtered or unexported fields
}

type SCIMDirectory struct {
	// Unique identifier for this SCIM directory.
	ID *string `json:"id,omitempty" url:"id,omitempty"`
	// The organization this SCIM directory belongs to.
	OrganizationID *string `json:"organizationId,omitempty" url:"organizationId,omitempty"`
	// Whether this is the primary SCIM directory for the organization.
	Primary *bool `json:"primary,omitempty" url:"primary,omitempty"`
	// Base URL the Identity Provider uses to perform SCIM HTTP requests.
	//
	// SCIM base URLs are assigned by SSOReady, and need to be inputted into your customer's Identity Provider.
	SCIMBaseURL *string `json:"scimBaseUrl,omitempty" url:"scimBaseUrl,omitempty"`
	// Whether this SCIM directory has a bearer token assigned.
	//
	// SSOReady only stores a hash of the bearer token. To get a bearer token value, you must rotate this SCIM directory's
	// bearer token.
	HasClientBearerToken *bool `json:"hasClientBearerToken,omitempty" url:"hasClientBearerToken,omitempty"`
	// contains filtered or unexported fields
}

type SCIMGroup struct {
	// Unique identifier for this SCIM group.
	ID *string `json:"id,omitempty" url:"id,omitempty"`
	// SCIM directory this SCIM group belongs to.
	SCIMDirectoryID *string `json:"scimDirectoryId,omitempty" url:"scimDirectoryId,omitempty"`
	// A human-friendly name for the SCIM group.
	DisplayName *string `json:"displayName,omitempty" url:"displayName,omitempty"`
	// Whether the SCIM group has been deleted or deprovisioned from its SCIM directory.
	//
	// Identity Providers are inconsistent about reliably deleting SCIM groups. Many Identity Providers will deprovision
	// the users inside a group, but not the group itself. For this reason, it's typical to ignore this field until a
	// specific need arises.
	Deleted *bool `json:"deleted,omitempty" url:"deleted,omitempty"`
	// Arbitrary, potentially nested, attributes the Identity Provider included about the group.
	//
	// Identity Providers are inconsistent about supporting sending custom attributes on groups. For this reason, it's
	// typical to not rely on them until a specific need arises.
	Attributes map[string]interface{} `json:"attributes,omitempty" url:"attributes,omitempty"`
	// contains filtered or unexported fields
}

type SCIMListSCIMGroupsRequest struct {
	// The SCIM directory to list from.
	//
	// One of `scimDirectoryId`, `organizationId`, or `organizationExternalId` must be specified.
	SCIMDirectoryID *string `json:"-" url:"scimDirectoryId,omitempty"`
	// The ID of the organization to list from. The primary SCIM directory of this organization is used.
	//
	// One of `scimDirectoryId`, `organizationId`, or `organizationExternalId` must be specified.
	OrganizationID *string `json:"-" url:"organizationId,omitempty"`
	// The `externalId` of the organization to list from. The primary SCIM directory of this organization is used.
	//
	// One of `scimDirectoryId`, `organizationId`, or `organizationExternalId` must be specified.
	OrganizationExternalID *string `json:"-" url:"organizationExternalId,omitempty"`
	// Pagination token. Leave empty to get the first page of results.
	PageToken *string `json:"-" url:"pageToken,omitempty"`
}

type SCIMListSCIMUsersRequest struct {
	// The SCIM directory to list from.
	//
	// One of `scimDirectoryId`, `organizationId`, or `organizationExternalId` must be specified.
	SCIMDirectoryID *string `json:"-" url:"scimDirectoryId,omitempty"`
	// The ID of the organization to list from. The primary SCIM directory of this organization is used.
	//
	// One of `scimDirectoryId`, `organizationId`, or `organizationExternalId` must be specified.
	OrganizationID *string `json:"-" url:"organizationId,omitempty"`
	// The `externalId` of the organization to list from. The primary SCIM directory of this organization is used.
	//
	// One of `scimDirectoryId`, `organizationId`, or `organizationExternalId` must be specified.
	OrganizationExternalID *string `json:"-" url:"organizationExternalId,omitempty"`
	// If specified, only users that are members of this SCIM group are returned.
	SCIMGroupID *string `json:"-" url:"scimGroupId,omitempty"`
	// Pagination token. Leave empty to get the first page of results.
	PageToken *string `json:"-" url:"pageToken,omitempty"`
}

type SCIMUser struct {
	// Unique identifier for this SCIM user.
	ID *string `json:"id,omitempty" url:"id,omitempty"`
	// SCIM directory this SCIM user belongs to.
	SCIMDirectoryID *string `json:"scimDirectoryId,omitempty" url:"scimDirectoryId,omitempty"`
	// The SCIM user's email address.
	Email *string `json:"email,omitempty" url:"email,omitempty"`
	// Whether the SCIM user has been deleted or deprovisioned from its SCIM directory.
	Deleted *bool `json:"deleted,omitempty" url:"deleted,omitempty"`
	// Arbitrary, potentially nested, attributes the Identity Provider included about the user.
	//
	// Typically, these `attributes` are used to pass along the user's first/last name, or whether they should be
	// considered an admin within their company.
	Attributes map[string]interface{} `json:"attributes,omitempty" url:"attributes,omitempty"`
	// contains filtered or unexported fields
}

type Status struct {
	// The status code, which should be an enum value of [google.rpc.Code][google.rpc.code].
	Code *int `json:"code,omitempty" url:"code,omitempty"`
	// A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.status.details] field, or localized by the client.
	Message *string `json:"message,omitempty" url:"message,omitempty"`
	// A list of messages that carry the error details. There is a common set of message types for APIs to use.
	Details []*GoogleProtobufAny `json:"details,omitempty" url:"details,omitempty"`
	// contains filtered or unexported fields
}

type UpdateOrganizationResponse struct {
	// The updated organization.
	Organization *Organization `json:"organization,omitempty" url:"organization,omitempty"`
	// contains filtered or unexported fields
}

type UpdateSAMLConnectionResponse struct {
	// The updated SAML connection.
	SAMLConnection *SAMLConnection `json:"samlConnection,omitempty" url:"samlConnection,omitempty"`
	// contains filtered or unexported fields
}

type UpdateSCIMDirectoryResponse struct {
	// The updated SCIM directory.
	SCIMDirectory *SCIMDirectory `json:"scimDirectory,omitempty" url:"scimDirectory,omitempty"`
	// contains filtered or unexported fields
}