connection

package
v15.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 9, 2024 License: MIT Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateParams 

type CreateParams struct {
	// OrganizationID: Globally unique UUID that identifies a specific Organization. The `organization_id` is
	// critical to perform operations on an Organization, so be sure to preserve this value.
	OrganizationID string `json:"organization_id,omitempty"`
	// DisplayName: A human-readable display name for the connection.
	DisplayName      string                        `json:"display_name,omitempty"`
	IdentityProvider CreateRequestIdentityProvider `json:"identity_provider,omitempty"`
}

CreateParams: Request type for `Connection.Create`.

type CreateRequestIdentityProvider 

type CreateRequestIdentityProvider string
const (
	CreateRequestIdentityProviderGeneric        CreateRequestIdentityProvider = "generic"
	CreateRequestIdentityProviderOkta           CreateRequestIdentityProvider = "okta"
	CreateRequestIdentityProviderMicrosoftentra CreateRequestIdentityProvider = "microsoft-entra"
	CreateRequestIdentityProviderCyberark       CreateRequestIdentityProvider = "cyberark"
	CreateRequestIdentityProviderJumpcloud      CreateRequestIdentityProvider = "jumpcloud"
	CreateRequestIdentityProviderOnelogin       CreateRequestIdentityProvider = "onelogin"
	CreateRequestIdentityProviderPingfederate   CreateRequestIdentityProvider = "pingfederate"
	CreateRequestIdentityProviderRippling       CreateRequestIdentityProvider = "rippling"
)

type CreateRequestOptions 

type CreateRequestOptions struct {
	// Authorization: Optional authorization object.
	// Pass in an active Stytch Member session token or session JWT and the request
	// will be run using that member's permissions.
	Authorization methodoptions.Authorization `json:"authorization,omitempty"`
}

CreateRequestOptions:

func (*CreateRequestOptions) AddHeaders 

func (o *CreateRequestOptions) AddHeaders(headers map[string][]string) map[string][]string

type CreateResponse 

type CreateResponse struct {
	// RequestID: Globally unique UUID that is returned with every API call. This value is important to log for
	// debugging purposes; we may ask for this value to help identify a specific API call when helping you
	// debug an issue.
	RequestID string `json:"request_id,omitempty"`
	// StatusCode: The HTTP status code of the response. Stytch follows standard HTTP response status code
	// patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX
	// are server errors.
	StatusCode int32 `json:"status_code,omitempty"`
	// Connection: The `SCIM Connection` object affected by this API call. See the
	// [SCIM Connection Object](https://stytch.com/docs/b2b/api/scim-connection-object) for complete response
	// field details.
	Connection *scim.SCIMConnectionWithToken `json:"connection,omitempty"`
}

CreateResponse: Response type for `Connection.Create`.

type DeleteParams 

type DeleteParams struct {
	// OrganizationID: Globally unique UUID that identifies a specific Organization. The `organization_id` is
	// critical to perform operations on an Organization, so be sure to preserve this value.
	OrganizationID string `json:"organization_id,omitempty"`
	// ConnectionID: The ID of the SCIM connection.
	ConnectionID string `json:"connection_id,omitempty"`
}

DeleteParams: Request type for `Connection.Delete`.

type DeleteRequestOptions 

type DeleteRequestOptions struct {
	// Authorization: Optional authorization object.
	// Pass in an active Stytch Member session token or session JWT and the request
	// will be run using that member's permissions.
	Authorization methodoptions.Authorization `json:"authorization,omitempty"`
}

DeleteRequestOptions:

func (*DeleteRequestOptions) AddHeaders 

func (o *DeleteRequestOptions) AddHeaders(headers map[string][]string) map[string][]string

type DeleteResponse 

type DeleteResponse struct {
	// RequestID: Globally unique UUID that is returned with every API call. This value is important to log for
	// debugging purposes; we may ask for this value to help identify a specific API call when helping you
	// debug an issue.
	RequestID string `json:"request_id,omitempty"`
	// ConnectionID: The `connection_id` that was deleted as part of the delete request.
	ConnectionID string `json:"connection_id,omitempty"`
	// StatusCode: The HTTP status code of the response. Stytch follows standard HTTP response status code
	// patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX
	// are server errors.
	StatusCode int32 `json:"status_code,omitempty"`
}

DeleteResponse: Response type for `Connection.Delete`.

type GetGroupsParams added in v15.2.0 

type GetGroupsParams struct {
	// OrganizationID: Globally unique UUID that identifies a specific Organization. The `organization_id` is
	// critical to perform operations on an Organization, so be sure to preserve this value.
	OrganizationID string `json:"organization_id,omitempty"`
	// ConnectionID: The ID of the SCIM connection.
	ConnectionID string `json:"connection_id,omitempty"`
	// Cursor: The `cursor` field allows you to paginate through your results. Each result array is limited to
	// 1000 results. If your query returns more than 1000 results, you will need to paginate the responses
	// using the `cursor`. If you receive a response that includes a non-null `next_cursor` in the
	// `results_metadata` object, repeat the search call with the `next_cursor` value set to the `cursor` field
	// to retrieve the next page of results. Continue to make search calls until the `next_cursor` in the
	// response is null.
	Cursor string `json:"cursor,omitempty"`
	// Limit: The number of search results to return per page. The default limit is 100. A maximum of 1000
	// results can be returned by a single search request. If the total size of your result set is greater than
	// one page size, you must paginate the response. See the `cursor` field.
	Limit uint32 `json:"limit,omitempty"`
}

GetGroupsParams: Request type for `Connection.GetGroups`.

type GetGroupsRequestOptions added in v15.2.0 

type GetGroupsRequestOptions struct {
	// Authorization: Optional authorization object.
	// Pass in an active Stytch Member session token or session JWT and the request
	// will be run using that member's permissions.
	Authorization methodoptions.Authorization `json:"authorization,omitempty"`
}

GetGroupsRequestOptions:

func (*GetGroupsRequestOptions) AddHeaders added in v15.2.0 

func (o *GetGroupsRequestOptions) AddHeaders(headers map[string][]string) map[string][]string

type GetGroupsResponse added in v15.2.0 

type GetGroupsResponse struct {
	// SCIMGroups: A list of SCIM Connection Groups belonging to the connection.
	SCIMGroups []scim.SCIMGroup `json:"scim_groups,omitempty"`
	StatusCode int32            `json:"status_code,omitempty"`
	// NextCursor: The `next_cursor` string is returned when your search result contains more than one page of
	// results. This value is passed into your next search call in the `cursor` field.
	NextCursor string `json:"next_cursor,omitempty"`
}

GetGroupsResponse: Response type for `Connection.GetGroups`.

type GetParams 

type GetParams struct {
	// OrganizationID: Globally unique UUID that identifies a specific Organization. The `organization_id` is
	// critical to perform operations on an Organization, so be sure to preserve this value.
	OrganizationID string `json:"organization_id,omitempty"`
}

GetParams: Request type for `Connection.Get`.

type GetRequestOptions 

type GetRequestOptions struct {
	// Authorization: Optional authorization object.
	// Pass in an active Stytch Member session token or session JWT and the request
	// will be run using that member's permissions.
	Authorization methodoptions.Authorization `json:"authorization,omitempty"`
}

GetRequestOptions:

func (*GetRequestOptions) AddHeaders 

func (o *GetRequestOptions) AddHeaders(headers map[string][]string) map[string][]string

type GetResponse 

type GetResponse struct {
	// RequestID: Globally unique UUID that is returned with every API call. This value is important to log for
	// debugging purposes; we may ask for this value to help identify a specific API call when helping you
	// debug an issue.
	RequestID string `json:"request_id,omitempty"`
	// StatusCode: The HTTP status code of the response. Stytch follows standard HTTP response status code
	// patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX
	// are server errors.
	StatusCode int32                `json:"status_code,omitempty"`
	Connection *scim.SCIMConnection `json:"connection,omitempty"`
}

GetResponse: Response type for `Connection.Get`.

type RotateCancelParams 

type RotateCancelParams struct {
	// OrganizationID: Globally unique UUID that identifies a specific Organization. The `organization_id` is
	// critical to perform operations on an Organization, so be sure to preserve this value.
	OrganizationID string `json:"organization_id,omitempty"`
	// ConnectionID: The ID of the SCIM connection.
	ConnectionID string `json:"connection_id,omitempty"`
}

RotateCancelParams: Request type for `Connection.RotateCancel`.

type RotateCancelRequestOptions 

type RotateCancelRequestOptions struct {
	// Authorization: Optional authorization object.
	// Pass in an active Stytch Member session token or session JWT and the request
	// will be run using that member's permissions.
	Authorization methodoptions.Authorization `json:"authorization,omitempty"`
}

RotateCancelRequestOptions:

func (*RotateCancelRequestOptions) AddHeaders 

func (o *RotateCancelRequestOptions) AddHeaders(headers map[string][]string) map[string][]string

type RotateCancelResponse 

type RotateCancelResponse struct {
	// RequestID: Globally unique UUID that is returned with every API call. This value is important to log for
	// debugging purposes; we may ask for this value to help identify a specific API call when helping you
	// debug an issue.
	RequestID string `json:"request_id,omitempty"`
	// StatusCode: The HTTP status code of the response. Stytch follows standard HTTP response status code
	// patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX
	// are server errors.
	StatusCode int32 `json:"status_code,omitempty"`
	// Connection: The `SCIM Connection` object affected by this API call. See the
	// [SCIM Connection Object](https://stytch.com/docs/b2b/api/scim-connection-object) for complete response
	// field details.
	Connection *scim.SCIMConnection `json:"connection,omitempty"`
}

RotateCancelResponse: Response type for `Connection.RotateCancel`.

type RotateCompleteParams 

type RotateCompleteParams struct {
	// OrganizationID: Globally unique UUID that identifies a specific Organization. The `organization_id` is
	// critical to perform operations on an Organization, so be sure to preserve this value.
	OrganizationID string `json:"organization_id,omitempty"`
	// ConnectionID: The ID of the SCIM connection.
	ConnectionID string `json:"connection_id,omitempty"`
}

RotateCompleteParams: Request type for `Connection.RotateComplete`.

type RotateCompleteRequestOptions 

type RotateCompleteRequestOptions struct {
	// Authorization: Optional authorization object.
	// Pass in an active Stytch Member session token or session JWT and the request
	// will be run using that member's permissions.
	Authorization methodoptions.Authorization `json:"authorization,omitempty"`
}

RotateCompleteRequestOptions:

func (*RotateCompleteRequestOptions) AddHeaders 

func (o *RotateCompleteRequestOptions) AddHeaders(headers map[string][]string) map[string][]string

type RotateCompleteResponse 

type RotateCompleteResponse struct {
	// RequestID: Globally unique UUID that is returned with every API call. This value is important to log for
	// debugging purposes; we may ask for this value to help identify a specific API call when helping you
	// debug an issue.
	RequestID string `json:"request_id,omitempty"`
	// StatusCode: The HTTP status code of the response. Stytch follows standard HTTP response status code
	// patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX
	// are server errors.
	StatusCode int32 `json:"status_code,omitempty"`
	// Connection: The `SCIM Connection` object affected by this API call. See the
	// [SCIM Connection Object](https://stytch.com/docs/b2b/api/scim-connection-object) for complete response
	// field details.
	Connection *scim.SCIMConnection `json:"connection,omitempty"`
}

RotateCompleteResponse: Response type for `Connection.RotateComplete`.

type RotateStartParams 

type RotateStartParams struct {
	// OrganizationID: Globally unique UUID that identifies a specific Organization. The `organization_id` is
	// critical to perform operations on an Organization, so be sure to preserve this value.
	OrganizationID string `json:"organization_id,omitempty"`
	// ConnectionID: The ID of the SCIM connection.
	ConnectionID string `json:"connection_id,omitempty"`
}

RotateStartParams: Request type for `Connection.RotateStart`.

type RotateStartRequestOptions 

type RotateStartRequestOptions struct {
	// Authorization: Optional authorization object.
	// Pass in an active Stytch Member session token or session JWT and the request
	// will be run using that member's permissions.
	Authorization methodoptions.Authorization `json:"authorization,omitempty"`
}

RotateStartRequestOptions:

func (*RotateStartRequestOptions) AddHeaders 

func (o *RotateStartRequestOptions) AddHeaders(headers map[string][]string) map[string][]string

type RotateStartResponse 

type RotateStartResponse struct {
	// RequestID: Globally unique UUID that is returned with every API call. This value is important to log for
	// debugging purposes; we may ask for this value to help identify a specific API call when helping you
	// debug an issue.
	RequestID string `json:"request_id,omitempty"`
	// StatusCode: The HTTP status code of the response. Stytch follows standard HTTP response status code
	// patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX
	// are server errors.
	StatusCode int32 `json:"status_code,omitempty"`
	// Connection: The `SCIM Connection` object affected by this API call. See the
	// [SCIM Connection Object](https://stytch.com/docs/b2b/api/scim-connection-object) for complete response
	// field details.
	Connection *scim.SCIMConnectionWithNextToken `json:"connection,omitempty"`
}

RotateStartResponse: Response type for `Connection.RotateStart`.

type UpdateParams 

type UpdateParams struct {
	// OrganizationID: Globally unique UUID that identifies a specific Organization. The `organization_id` is
	// critical to perform operations on an Organization, so be sure to preserve this value.
	OrganizationID string `json:"organization_id,omitempty"`
	// ConnectionID: The ID of the SCIM connection.
	ConnectionID string `json:"connection_id,omitempty"`
	// DisplayName: A human-readable display name for the connection.
	DisplayName      string                        `json:"display_name,omitempty"`
	IdentityProvider UpdateRequestIdentityProvider `json:"identity_provider,omitempty"`
	// SCIMGroupImplicitRoleAssignments: An array of SCIM group implicit role assignments. Each object in the
	// array must contain a `group_id` and a `role_id`.
	SCIMGroupImplicitRoleAssignments []*scim.SCIMGroupImplicitRoleAssignments `json:"scim_group_implicit_role_assignments,omitempty"`
}

UpdateParams: Request type for `Connection.Update`.

type UpdateRequestIdentityProvider 

type UpdateRequestIdentityProvider string
const (
	UpdateRequestIdentityProviderGeneric        UpdateRequestIdentityProvider = "generic"
	UpdateRequestIdentityProviderOkta           UpdateRequestIdentityProvider = "okta"
	UpdateRequestIdentityProviderMicrosoftentra UpdateRequestIdentityProvider = "microsoft-entra"
	UpdateRequestIdentityProviderCyberark       UpdateRequestIdentityProvider = "cyberark"
	UpdateRequestIdentityProviderJumpcloud      UpdateRequestIdentityProvider = "jumpcloud"
	UpdateRequestIdentityProviderOnelogin       UpdateRequestIdentityProvider = "onelogin"
	UpdateRequestIdentityProviderPingfederate   UpdateRequestIdentityProvider = "pingfederate"
	UpdateRequestIdentityProviderRippling       UpdateRequestIdentityProvider = "rippling"
)

type UpdateRequestOptions 

type UpdateRequestOptions struct {
	// Authorization: Optional authorization object.
	// Pass in an active Stytch Member session token or session JWT and the request
	// will be run using that member's permissions.
	Authorization methodoptions.Authorization `json:"authorization,omitempty"`
}

UpdateRequestOptions:

func (*UpdateRequestOptions) AddHeaders 

func (o *UpdateRequestOptions) AddHeaders(headers map[string][]string) map[string][]string

type UpdateResponse 

type UpdateResponse struct {
	// RequestID: Globally unique UUID that is returned with every API call. This value is important to log for
	// debugging purposes; we may ask for this value to help identify a specific API call when helping you
	// debug an issue.
	RequestID string `json:"request_id,omitempty"`
	// StatusCode: The HTTP status code of the response. Stytch follows standard HTTP response status code
	// patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX
	// are server errors.
	StatusCode int32 `json:"status_code,omitempty"`
	// Connection: The `SAML Connection` object affected by this API call. See the
	// [SAML Connection Object](https://stytch.com/docs/b2b/api/saml-connection-object) for complete response
	// field details.
	Connection *scim.SCIMConnection `json:"connection,omitempty"`
}

UpdateResponse: Response type for `Connection.Update`.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.