Documentation
¶
Overview ¶
Package api provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.4.1 DO NOT EDIT.
Index ¶
- Constants
- func NewBulkUpdateAccountsRequest(server string, body BulkUpdateAccountsJSONRequestBody) (*http.Request, error)
- func NewBulkUpdateAccountsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewBulkUploadAccountPhotosRequestWithBody(server string, params *BulkUploadAccountPhotosParams, contentType string, ...) (*http.Request, error)
- func NewCancelRequestRequest(server string, requestID string) (*http.Request, error)
- func NewComparePeopleRequest(server string, subject string, body ComparePeopleJSONRequestBody) (*http.Request, error)
- func NewComparePeopleRequestWithBody(server string, subject string, contentType string, body io.Reader) (*http.Request, error)
- func NewCompareSelfieRequestWithBody(server string, subject string, contentType string, body io.Reader) (*http.Request, error)
- func NewCreateAPIKeyRequest(server string, body CreateAPIKeyJSONRequestBody) (*http.Request, error)
- func NewCreateAPIKeyRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewCreateDirectoryRequest(server string, body CreateDirectoryJSONRequestBody) (*http.Request, error)
- func NewCreateDirectoryRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewCreateEnvRequest(server string, body CreateEnvJSONRequestBody) (*http.Request, error)
- func NewCreateEnvRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewCreateRequestRequest(server string, body CreateRequestJSONRequestBody) (*http.Request, error)
- func NewCreateRequestRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewCreateTemplateRequest(server string, env string, body CreateTemplateJSONRequestBody) (*http.Request, error)
- func NewCreateTemplateRequestWithBody(server string, env string, contentType string, body io.Reader) (*http.Request, error)
- func NewDeleteAPIKeyRequest(server string, apiKey string) (*http.Request, error)
- func NewDeleteDirectoryLogoRequest(server string, directory string) (*http.Request, error)
- func NewDeleteDirectoryRequest(server string, directory string) (*http.Request, error)
- func NewDeleteEnvRequest(server string, env string) (*http.Request, error)
- func NewDeleteLogoRequest(server string, env string, params *DeleteLogoParams) (*http.Request, error)
- func NewDeletePersonPropertiesRequest(server string, subject string, scopes string, ...) (*http.Request, error)
- func NewDeleteSlackIntegrationRequest(server string, env string, integration string) (*http.Request, error)
- func NewDeleteTemplateRequest(server string, env string, template string) (*http.Request, error)
- func NewEncryptSecretRequest(server string, env string, body EncryptSecretJSONRequestBody) (*http.Request, error)
- func NewEncryptSecretRequestWithBody(server string, env string, contentType string, body io.Reader) (*http.Request, error)
- func NewGetAPIKeyRequest(server string, apiKey string) (*http.Request, error)
- func NewGetAccountRequest(server string, account string) (*http.Request, error)
- func NewGetBulkPeoplePropertiesRequest(server string, body GetBulkPeoplePropertiesJSONRequestBody) (*http.Request, error)
- func NewGetBulkPeoplePropertiesRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewGetDirectoryAuthorizationURLRequest(server string, directory string) (*http.Request, error)
- func NewGetDirectoryRequest(server string, directory string) (*http.Request, error)
- func NewGetEnvMicrometricsRequest(server string, env string, params *GetEnvMicrometricsParams) (*http.Request, error)
- func NewGetEnvRequest(server string, env string) (*http.Request, error)
- func NewGetEnvRequestRequest(server string, env string, requestID string) (*http.Request, error)
- func NewGetOrgRequest(server string) (*http.Request, error)
- func NewGetPersonPropertiesRequest(server string, subject string, scopes string, ...) (*http.Request, error)
- func NewGetRequestRequest(server string, requestID string) (*http.Request, error)
- func NewGetSlackRequestDetailsRequest(server string) (*http.Request, error)
- func NewInviteOrgMemberRequest(server string, body InviteOrgMemberJSONRequestBody) (*http.Request, error)
- func NewInviteOrgMemberRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewListAPIKeysRequest(server string) (*http.Request, error)
- func NewListAccountsRequest(server string, params *ListAccountsParams) (*http.Request, error)
- func NewListAuditEventsRequest(server string, params *ListAuditEventsParams) (*http.Request, error)
- func NewListDirectoriesRequest(server string) (*http.Request, error)
- func NewListEnvRequestsRequest(server string, env string, params *ListEnvRequestsParams) (*http.Request, error)
- func NewListEnvsRequest(server string) (*http.Request, error)
- func NewListOrgMembersRequest(server string) (*http.Request, error)
- func NewListSlackIntegrationsRequest(server string, env string) (*http.Request, error)
- func NewListWebhooksRequest(server string, env string) (*http.Request, error)
- func NewOauth2AuthorizeIframeRequest(server string, params *Oauth2AuthorizeIframeParams) (*http.Request, error)
- func NewOauth2AuthorizeRequest(server string, params *Oauth2AuthorizeParams) (*http.Request, error)
- func NewOauth2AuthorizeWithExperienceRequest(server string, experience string, params *Oauth2AuthorizeWithExperienceParams) (*http.Request, error)
- func NewOauth2AuthorizeWithRequestAndExperienceRequest(server string, experience string, requestID string, ...) (*http.Request, error)
- func NewOauth2AuthorizeWithRequestRequest(server string, requestID string, params *Oauth2AuthorizeWithRequestParams) (*http.Request, error)
- func NewOauth2CancelRequest(server string, requestID string, params *Oauth2CancelParams) (*http.Request, error)
- func NewOauth2LogoutRequest(server string) (*http.Request, error)
- func NewOauth2PollRequest(server string, requestID string, params *Oauth2PollParams) (*http.Request, error)
- func NewOauth2TokenRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewOauth2TokenRequestWithFormdataBody(server string, body Oauth2TokenFormdataRequestBody) (*http.Request, error)
- func NewPresignRecoveryMicrositeURLRequest(server string, env string, body PresignRecoveryMicrositeURLJSONRequestBody) (*http.Request, error)
- func NewPresignRecoveryMicrositeURLRequestWithBody(server string, env string, contentType string, body io.Reader) (*http.Request, error)
- func NewRefreshWebhookSecretRequest(server string, env string, body RefreshWebhookSecretJSONRequestBody) (*http.Request, error)
- func NewRefreshWebhookSecretRequestWithBody(server string, env string, contentType string, body io.Reader) (*http.Request, error)
- func NewRegenerateDirectoryAgentTokenRequest(server string, directory string) (*http.Request, error)
- func NewRemoveOrgMemberRequest(server string, member string) (*http.Request, error)
- func NewSetDirectoryCredentialsRequest(server string, directory string, body SetDirectoryCredentialsJSONRequestBody) (*http.Request, error)
- func NewSetDirectoryCredentialsRequestWithBody(server string, directory string, contentType string, body io.Reader) (*http.Request, error)
- func NewSyncDirectoryRequest(server string, directory string) (*http.Request, error)
- func NewUpdateAPIKeyRequest(server string, apiKey string, body UpdateAPIKeyJSONRequestBody) (*http.Request, error)
- func NewUpdateAPIKeyRequestWithBody(server string, apiKey string, contentType string, body io.Reader) (*http.Request, error)
- func NewUpdateAccountRequest(server string, account string, body UpdateAccountJSONRequestBody) (*http.Request, error)
- func NewUpdateAccountRequestWithBody(server string, account string, contentType string, body io.Reader) (*http.Request, error)
- func NewUpdateDirectoryRequest(server string, directory string, body UpdateDirectoryJSONRequestBody) (*http.Request, error)
- func NewUpdateDirectoryRequestWithBody(server string, directory string, contentType string, body io.Reader) (*http.Request, error)
- func NewUpdateEnvRequest(server string, env string, body UpdateEnvJSONRequestBody) (*http.Request, error)
- func NewUpdateEnvRequestWithBody(server string, env string, contentType string, body io.Reader) (*http.Request, error)
- func NewUpdateOrgMemberRequest(server string, member string, body UpdateOrgMemberJSONRequestBody) (*http.Request, error)
- func NewUpdateOrgMemberRequestWithBody(server string, member string, contentType string, body io.Reader) (*http.Request, error)
- func NewUpdateOrgRequest(server string, body UpdateOrgJSONRequestBody) (*http.Request, error)
- func NewUpdateOrgRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewUpdateRequestRequest(server string, requestID string, body UpdateRequestJSONRequestBody) (*http.Request, error)
- func NewUpdateRequestRequestWithBody(server string, requestID string, contentType string, body io.Reader) (*http.Request, error)
- func NewUpdateTemplateRequest(server string, env string, template string, body UpdateTemplateJSONRequestBody) (*http.Request, error)
- func NewUpdateTemplateRequestWithBody(server string, env string, template string, contentType string, body io.Reader) (*http.Request, error)
- func NewUploadAccountPhotoRequestWithBody(server string, account string, contentType string, body io.Reader) (*http.Request, error)
- func NewUploadDirectoryLogoRequestWithBody(server string, directory string, contentType string, body io.Reader) (*http.Request, error)
- func NewUploadLogoRequestWithBody(server string, env string, params *UploadLogoParams, contentType string, ...) (*http.Request, error)
- type APIKey
- type APIKeyCreatedAuditEvent
- type APIKeyDeletedAuditEvent
- type APIKeyUpdateRequest
- type APIKeyUpdatedAuditEvent
- type Account
- type AccountBulkUpdateRequest
- type AccountBulkUpdateRequestItem
- type AccountBulkUpdateResponse
- type AccountBulkUpdateResponseItem
- type AccountBulkUpdateStatus
- type AccountPhoto
- type AccountPhotoUploadedAuditEvent
- type AccountUpdateRequest
- type AccountUpdatedAuditEvent
- type AccountValue
- type AccountsList
- type AuditEvent
- type AuditEventKind
- type AuthorizeRequest
- type AuthorizeRequestCodeChallengeMethod
- type AuthorizeRequestResponseMode
- type AuthorizeRequestResponseType
- type AuthorizeResponse
- type AuthorizeReturn
- type AuthorizeStatus
- type AuthorizeV2Request
- type BadRequestResponse
- type BadRequestResponseStatus
- type BulkRequest
- type BulkRequestItem
- type BulkResponse
- type BulkUpdateAccountsJSONRequestBody
- type BulkUpdateAccountsResp
- type BulkUploadAccountPhotosParams
- type BulkUploadAccountPhotosResp
- type BulkUploadAccountPhotosResponse
- type BulkUploadAccountPhotosResponseItem
- type CLISigninAuditEvent
- type CancelRequestResp
- type CancelResponse
- type Claim
- type Client
- func (c *Client) BulkUpdateAccounts(ctx context.Context, body BulkUpdateAccountsJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) BulkUpdateAccountsWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) BulkUploadAccountPhotosWithBody(ctx context.Context, params *BulkUploadAccountPhotosParams, contentType string, ...) (*http.Response, error)
- func (c *Client) CancelRequest(ctx context.Context, requestID string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) ComparePeople(ctx context.Context, subject string, body ComparePeopleJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) ComparePeopleWithBody(ctx context.Context, subject string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) CompareSelfieWithBody(ctx context.Context, subject string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) CreateAPIKey(ctx context.Context, body CreateAPIKeyJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) CreateAPIKeyWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) CreateDirectory(ctx context.Context, body CreateDirectoryJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) CreateDirectoryWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) CreateEnv(ctx context.Context, body CreateEnvJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) CreateEnvWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) CreateRequest(ctx context.Context, body CreateRequestJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) CreateRequestWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) CreateTemplate(ctx context.Context, env string, body CreateTemplateJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) CreateTemplateWithBody(ctx context.Context, env string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) DeleteAPIKey(ctx context.Context, apiKey string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) DeleteDirectory(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) DeleteDirectoryLogo(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) DeleteEnv(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) DeleteLogo(ctx context.Context, env string, params *DeleteLogoParams, ...) (*http.Response, error)
- func (c *Client) DeletePersonProperties(ctx context.Context, subject string, scopes string, ...) (*http.Response, error)
- func (c *Client) DeleteSlackIntegration(ctx context.Context, env string, integration string, ...) (*http.Response, error)
- func (c *Client) DeleteTemplate(ctx context.Context, env string, template string, ...) (*http.Response, error)
- func (c *Client) EncryptSecret(ctx context.Context, env string, body EncryptSecretJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) EncryptSecretWithBody(ctx context.Context, env string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) GetAPIKey(ctx context.Context, apiKey string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetAccount(ctx context.Context, account string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetBulkPeopleProperties(ctx context.Context, body GetBulkPeoplePropertiesJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) GetBulkPeoplePropertiesWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) GetDirectory(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetDirectoryAuthorizationURL(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetEnv(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetEnvMicrometrics(ctx context.Context, env string, params *GetEnvMicrometricsParams, ...) (*http.Response, error)
- func (c *Client) GetEnvRequest(ctx context.Context, env string, requestID string, ...) (*http.Response, error)
- func (c *Client) GetOrg(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetPersonProperties(ctx context.Context, subject string, scopes string, ...) (*http.Response, error)
- func (c *Client) GetRequest(ctx context.Context, requestID string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetSlackRequestDetails(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) InviteOrgMember(ctx context.Context, body InviteOrgMemberJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) InviteOrgMemberWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) ListAPIKeys(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) ListAccounts(ctx context.Context, params *ListAccountsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) ListAuditEvents(ctx context.Context, params *ListAuditEventsParams, ...) (*http.Response, error)
- func (c *Client) ListDirectories(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) ListEnvRequests(ctx context.Context, env string, params *ListEnvRequestsParams, ...) (*http.Response, error)
- func (c *Client) ListEnvs(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) ListOrgMembers(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) ListSlackIntegrations(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) ListWebhooks(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) Oauth2Authorize(ctx context.Context, params *Oauth2AuthorizeParams, ...) (*http.Response, error)
- func (c *Client) Oauth2AuthorizeIframe(ctx context.Context, params *Oauth2AuthorizeIframeParams, ...) (*http.Response, error)
- func (c *Client) Oauth2AuthorizeWithExperience(ctx context.Context, experience string, ...) (*http.Response, error)
- func (c *Client) Oauth2AuthorizeWithRequest(ctx context.Context, requestID string, ...) (*http.Response, error)
- func (c *Client) Oauth2AuthorizeWithRequestAndExperience(ctx context.Context, experience string, requestID string, ...) (*http.Response, error)
- func (c *Client) Oauth2Cancel(ctx context.Context, requestID string, params *Oauth2CancelParams, ...) (*http.Response, error)
- func (c *Client) Oauth2Logout(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) Oauth2Poll(ctx context.Context, requestID string, params *Oauth2PollParams, ...) (*http.Response, error)
- func (c *Client) Oauth2TokenWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) Oauth2TokenWithFormdataBody(ctx context.Context, body Oauth2TokenFormdataRequestBody, ...) (*http.Response, error)
- func (c *Client) PresignRecoveryMicrositeURL(ctx context.Context, env string, ...) (*http.Response, error)
- func (c *Client) PresignRecoveryMicrositeURLWithBody(ctx context.Context, env string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) RefreshWebhookSecret(ctx context.Context, env string, body RefreshWebhookSecretJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) RefreshWebhookSecretWithBody(ctx context.Context, env string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) RegenerateDirectoryAgentToken(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) RemoveOrgMember(ctx context.Context, member string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) SetDirectoryCredentials(ctx context.Context, directory string, ...) (*http.Response, error)
- func (c *Client) SetDirectoryCredentialsWithBody(ctx context.Context, directory string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) SyncDirectory(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) UpdateAPIKey(ctx context.Context, apiKey string, body UpdateAPIKeyJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) UpdateAPIKeyWithBody(ctx context.Context, apiKey string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) UpdateAccount(ctx context.Context, account string, body UpdateAccountJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) UpdateAccountWithBody(ctx context.Context, account string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) UpdateDirectory(ctx context.Context, directory string, body UpdateDirectoryJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) UpdateDirectoryWithBody(ctx context.Context, directory string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) UpdateEnv(ctx context.Context, env string, body UpdateEnvJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) UpdateEnvWithBody(ctx context.Context, env string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) UpdateOrg(ctx context.Context, body UpdateOrgJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) UpdateOrgMember(ctx context.Context, member string, body UpdateOrgMemberJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) UpdateOrgMemberWithBody(ctx context.Context, member string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) UpdateOrgWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) UpdateRequest(ctx context.Context, requestID string, body UpdateRequestJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) UpdateRequestWithBody(ctx context.Context, requestID string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) UpdateTemplate(ctx context.Context, env string, template string, ...) (*http.Response, error)
- func (c *Client) UpdateTemplateWithBody(ctx context.Context, env string, template string, contentType string, ...) (*http.Response, error)
- func (c *Client) UploadAccountPhotoWithBody(ctx context.Context, account string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) UploadDirectoryLogoWithBody(ctx context.Context, directory string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) UploadLogoWithBody(ctx context.Context, env string, params *UploadLogoParams, contentType string, ...) (*http.Response, error)
- type ClientInterface
- type ClientOption
- type ClientWithResponses
- func (c *ClientWithResponses) BulkUpdateAccountsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*BulkUpdateAccountsResp, error)
- func (c *ClientWithResponses) BulkUpdateAccountsWithResponse(ctx context.Context, body BulkUpdateAccountsJSONRequestBody, ...) (*BulkUpdateAccountsResp, error)
- func (c *ClientWithResponses) BulkUploadAccountPhotosWithBodyWithResponse(ctx context.Context, params *BulkUploadAccountPhotosParams, contentType string, ...) (*BulkUploadAccountPhotosResp, error)
- func (c *ClientWithResponses) CancelRequestWithResponse(ctx context.Context, requestID string, reqEditors ...RequestEditorFn) (*CancelRequestResp, error)
- func (c *ClientWithResponses) ComparePeopleWithBodyWithResponse(ctx context.Context, subject string, contentType string, body io.Reader, ...) (*ComparePeopleResp, error)
- func (c *ClientWithResponses) ComparePeopleWithResponse(ctx context.Context, subject string, body ComparePeopleJSONRequestBody, ...) (*ComparePeopleResp, error)
- func (c *ClientWithResponses) CompareSelfieWithBodyWithResponse(ctx context.Context, subject string, contentType string, body io.Reader, ...) (*CompareSelfieResp, error)
- func (c *ClientWithResponses) CreateAPIKeyWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*CreateAPIKeyResp, error)
- func (c *ClientWithResponses) CreateAPIKeyWithResponse(ctx context.Context, body CreateAPIKeyJSONRequestBody, ...) (*CreateAPIKeyResp, error)
- func (c *ClientWithResponses) CreateDirectoryWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*CreateDirectoryResp, error)
- func (c *ClientWithResponses) CreateDirectoryWithResponse(ctx context.Context, body CreateDirectoryJSONRequestBody, ...) (*CreateDirectoryResp, error)
- func (c *ClientWithResponses) CreateEnvWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*CreateEnvResp, error)
- func (c *ClientWithResponses) CreateEnvWithResponse(ctx context.Context, body CreateEnvJSONRequestBody, ...) (*CreateEnvResp, error)
- func (c *ClientWithResponses) CreateRequestWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*CreateRequestResp, error)
- func (c *ClientWithResponses) CreateRequestWithResponse(ctx context.Context, body CreateRequestJSONRequestBody, ...) (*CreateRequestResp, error)
- func (c *ClientWithResponses) CreateTemplateWithBodyWithResponse(ctx context.Context, env string, contentType string, body io.Reader, ...) (*CreateTemplateResp, error)
- func (c *ClientWithResponses) CreateTemplateWithResponse(ctx context.Context, env string, body CreateTemplateJSONRequestBody, ...) (*CreateTemplateResp, error)
- func (c *ClientWithResponses) DeleteAPIKeyWithResponse(ctx context.Context, apiKey string, reqEditors ...RequestEditorFn) (*DeleteAPIKeyResp, error)
- func (c *ClientWithResponses) DeleteDirectoryLogoWithResponse(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*DeleteDirectoryLogoResp, error)
- func (c *ClientWithResponses) DeleteDirectoryWithResponse(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*DeleteDirectoryResp, error)
- func (c *ClientWithResponses) DeleteEnvWithResponse(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*DeleteEnvResp, error)
- func (c *ClientWithResponses) DeleteLogoWithResponse(ctx context.Context, env string, params *DeleteLogoParams, ...) (*DeleteLogoResp, error)
- func (c *ClientWithResponses) DeletePersonPropertiesWithResponse(ctx context.Context, subject string, scopes string, ...) (*DeletePersonPropertiesResp, error)
- func (c *ClientWithResponses) DeleteSlackIntegrationWithResponse(ctx context.Context, env string, integration string, ...) (*DeleteSlackIntegrationResp, error)
- func (c *ClientWithResponses) DeleteTemplateWithResponse(ctx context.Context, env string, template string, ...) (*DeleteTemplateResp, error)
- func (c *ClientWithResponses) EncryptSecretWithBodyWithResponse(ctx context.Context, env string, contentType string, body io.Reader, ...) (*EncryptSecretResp, error)
- func (c *ClientWithResponses) EncryptSecretWithResponse(ctx context.Context, env string, body EncryptSecretJSONRequestBody, ...) (*EncryptSecretResp, error)
- func (c *ClientWithResponses) GetAPIKeyWithResponse(ctx context.Context, apiKey string, reqEditors ...RequestEditorFn) (*GetAPIKeyResp, error)
- func (c *ClientWithResponses) GetAccountWithResponse(ctx context.Context, account string, reqEditors ...RequestEditorFn) (*GetAccountResp, error)
- func (c *ClientWithResponses) GetBulkPeoplePropertiesWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*GetBulkPeoplePropertiesResp, error)
- func (c *ClientWithResponses) GetBulkPeoplePropertiesWithResponse(ctx context.Context, body GetBulkPeoplePropertiesJSONRequestBody, ...) (*GetBulkPeoplePropertiesResp, error)
- func (c *ClientWithResponses) GetDirectoryAuthorizationURLWithResponse(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*GetDirectoryAuthorizationURLResp, error)
- func (c *ClientWithResponses) GetDirectoryWithResponse(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*GetDirectoryResp, error)
- func (c *ClientWithResponses) GetEnvMicrometricsWithResponse(ctx context.Context, env string, params *GetEnvMicrometricsParams, ...) (*GetEnvMicrometricsResp, error)
- func (c *ClientWithResponses) GetEnvRequestWithResponse(ctx context.Context, env string, requestID string, ...) (*GetEnvRequestResp, error)
- func (c *ClientWithResponses) GetEnvWithResponse(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*GetEnvResp, error)
- func (c *ClientWithResponses) GetOrgWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetOrgResp, error)
- func (c *ClientWithResponses) GetPersonPropertiesWithResponse(ctx context.Context, subject string, scopes string, ...) (*GetPersonPropertiesResp, error)
- func (c *ClientWithResponses) GetRequestWithResponse(ctx context.Context, requestID string, reqEditors ...RequestEditorFn) (*GetRequestResp, error)
- func (c *ClientWithResponses) GetSlackRequestDetailsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetSlackRequestDetailsResp, error)
- func (c *ClientWithResponses) InviteOrgMemberWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*InviteOrgMemberResp, error)
- func (c *ClientWithResponses) InviteOrgMemberWithResponse(ctx context.Context, body InviteOrgMemberJSONRequestBody, ...) (*InviteOrgMemberResp, error)
- func (c *ClientWithResponses) ListAPIKeysWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListAPIKeysResp, error)
- func (c *ClientWithResponses) ListAccountsWithResponse(ctx context.Context, params *ListAccountsParams, reqEditors ...RequestEditorFn) (*ListAccountsResp, error)
- func (c *ClientWithResponses) ListAuditEventsWithResponse(ctx context.Context, params *ListAuditEventsParams, ...) (*ListAuditEventsResp, error)
- func (c *ClientWithResponses) ListDirectoriesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListDirectoriesResp, error)
- func (c *ClientWithResponses) ListEnvRequestsWithResponse(ctx context.Context, env string, params *ListEnvRequestsParams, ...) (*ListEnvRequestsResp, error)
- func (c *ClientWithResponses) ListEnvsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListEnvsResp, error)
- func (c *ClientWithResponses) ListOrgMembersWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListOrgMembersResp, error)
- func (c *ClientWithResponses) ListSlackIntegrationsWithResponse(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*ListSlackIntegrationsResp, error)
- func (c *ClientWithResponses) ListWebhooksWithResponse(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*ListWebhooksResp, error)
- func (c *ClientWithResponses) Oauth2AuthorizeIframeWithResponse(ctx context.Context, params *Oauth2AuthorizeIframeParams, ...) (*Oauth2AuthorizeIframeResp, error)
- func (c *ClientWithResponses) Oauth2AuthorizeWithExperienceWithResponse(ctx context.Context, experience string, ...) (*Oauth2AuthorizeWithExperienceResp, error)
- func (c *ClientWithResponses) Oauth2AuthorizeWithRequestAndExperienceWithResponse(ctx context.Context, experience string, requestID string, ...) (*Oauth2AuthorizeWithRequestAndExperienceResp, error)
- func (c *ClientWithResponses) Oauth2AuthorizeWithRequestWithResponse(ctx context.Context, requestID string, ...) (*Oauth2AuthorizeWithRequestResp, error)
- func (c *ClientWithResponses) Oauth2AuthorizeWithResponse(ctx context.Context, params *Oauth2AuthorizeParams, ...) (*Oauth2AuthorizeResp, error)
- func (c *ClientWithResponses) Oauth2CancelWithResponse(ctx context.Context, requestID string, params *Oauth2CancelParams, ...) (*Oauth2CancelResp, error)
- func (c *ClientWithResponses) Oauth2LogoutWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*Oauth2LogoutResp, error)
- func (c *ClientWithResponses) Oauth2PollWithResponse(ctx context.Context, requestID string, params *Oauth2PollParams, ...) (*Oauth2PollResp, error)
- func (c *ClientWithResponses) Oauth2TokenWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*Oauth2TokenResp, error)
- func (c *ClientWithResponses) Oauth2TokenWithFormdataBodyWithResponse(ctx context.Context, body Oauth2TokenFormdataRequestBody, ...) (*Oauth2TokenResp, error)
- func (c *ClientWithResponses) PresignRecoveryMicrositeURLWithBodyWithResponse(ctx context.Context, env string, contentType string, body io.Reader, ...) (*PresignRecoveryMicrositeURLResp, error)
- func (c *ClientWithResponses) PresignRecoveryMicrositeURLWithResponse(ctx context.Context, env string, ...) (*PresignRecoveryMicrositeURLResp, error)
- func (c *ClientWithResponses) RefreshWebhookSecretWithBodyWithResponse(ctx context.Context, env string, contentType string, body io.Reader, ...) (*RefreshWebhookSecretResp, error)
- func (c *ClientWithResponses) RefreshWebhookSecretWithResponse(ctx context.Context, env string, body RefreshWebhookSecretJSONRequestBody, ...) (*RefreshWebhookSecretResp, error)
- func (c *ClientWithResponses) RegenerateDirectoryAgentTokenWithResponse(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*RegenerateDirectoryAgentTokenResp, error)
- func (c *ClientWithResponses) RemoveOrgMemberWithResponse(ctx context.Context, member string, reqEditors ...RequestEditorFn) (*RemoveOrgMemberResp, error)
- func (c *ClientWithResponses) SetDirectoryCredentialsWithBodyWithResponse(ctx context.Context, directory string, contentType string, body io.Reader, ...) (*SetDirectoryCredentialsResp, error)
- func (c *ClientWithResponses) SetDirectoryCredentialsWithResponse(ctx context.Context, directory string, ...) (*SetDirectoryCredentialsResp, error)
- func (c *ClientWithResponses) SyncDirectoryWithResponse(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*SyncDirectoryResp, error)
- func (c *ClientWithResponses) UpdateAPIKeyWithBodyWithResponse(ctx context.Context, apiKey string, contentType string, body io.Reader, ...) (*UpdateAPIKeyResp, error)
- func (c *ClientWithResponses) UpdateAPIKeyWithResponse(ctx context.Context, apiKey string, body UpdateAPIKeyJSONRequestBody, ...) (*UpdateAPIKeyResp, error)
- func (c *ClientWithResponses) UpdateAccountWithBodyWithResponse(ctx context.Context, account string, contentType string, body io.Reader, ...) (*UpdateAccountResp, error)
- func (c *ClientWithResponses) UpdateAccountWithResponse(ctx context.Context, account string, body UpdateAccountJSONRequestBody, ...) (*UpdateAccountResp, error)
- func (c *ClientWithResponses) UpdateDirectoryWithBodyWithResponse(ctx context.Context, directory string, contentType string, body io.Reader, ...) (*UpdateDirectoryResp, error)
- func (c *ClientWithResponses) UpdateDirectoryWithResponse(ctx context.Context, directory string, body UpdateDirectoryJSONRequestBody, ...) (*UpdateDirectoryResp, error)
- func (c *ClientWithResponses) UpdateEnvWithBodyWithResponse(ctx context.Context, env string, contentType string, body io.Reader, ...) (*UpdateEnvResp, error)
- func (c *ClientWithResponses) UpdateEnvWithResponse(ctx context.Context, env string, body UpdateEnvJSONRequestBody, ...) (*UpdateEnvResp, error)
- func (c *ClientWithResponses) UpdateOrgMemberWithBodyWithResponse(ctx context.Context, member string, contentType string, body io.Reader, ...) (*UpdateOrgMemberResp, error)
- func (c *ClientWithResponses) UpdateOrgMemberWithResponse(ctx context.Context, member string, body UpdateOrgMemberJSONRequestBody, ...) (*UpdateOrgMemberResp, error)
- func (c *ClientWithResponses) UpdateOrgWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*UpdateOrgResp, error)
- func (c *ClientWithResponses) UpdateOrgWithResponse(ctx context.Context, body UpdateOrgJSONRequestBody, ...) (*UpdateOrgResp, error)
- func (c *ClientWithResponses) UpdateRequestWithBodyWithResponse(ctx context.Context, requestID string, contentType string, body io.Reader, ...) (*UpdateRequestResp, error)
- func (c *ClientWithResponses) UpdateRequestWithResponse(ctx context.Context, requestID string, body UpdateRequestJSONRequestBody, ...) (*UpdateRequestResp, error)
- func (c *ClientWithResponses) UpdateTemplateWithBodyWithResponse(ctx context.Context, env string, template string, contentType string, ...) (*UpdateTemplateResp, error)
- func (c *ClientWithResponses) UpdateTemplateWithResponse(ctx context.Context, env string, template string, ...) (*UpdateTemplateResp, error)
- func (c *ClientWithResponses) UploadAccountPhotoWithBodyWithResponse(ctx context.Context, account string, contentType string, body io.Reader, ...) (*UploadAccountPhotoResp, error)
- func (c *ClientWithResponses) UploadDirectoryLogoWithBodyWithResponse(ctx context.Context, directory string, contentType string, body io.Reader, ...) (*UploadDirectoryLogoResp, error)
- func (c *ClientWithResponses) UploadLogoWithBodyWithResponse(ctx context.Context, env string, params *UploadLogoParams, contentType string, ...) (*UploadLogoResp, error)
- type ClientWithResponsesInterface
- type ComparePeopleJSONRequestBody
- type ComparePeopleResp
- type CompareSelfieResp
- type CompareSelfieResult
- type Comparison
- type ComparisonResult
- type ConsoleSigninAuditEvent
- type ConsoleSinginConfigureEmailAuditEvent
- type ConsoleSinginConfigureSAMLAuditEvent
- type CreateAPIKeyJSONRequestBody
- type CreateAPIKeyRequest
- type CreateAPIKeyResp
- type CreateAPIKeyResponse
- type CreateDirectoryJSONRequestBody
- type CreateDirectoryRequest
- type CreateDirectoryResp
- type CreateDirectoryResponse
- type CreateEnvJSONRequestBody
- type CreateEnvRequest
- type CreateEnvResp
- type CreateEnvResponse
- type CreateRequestJSONRequestBody
- type CreateRequestRequest
- type CreateRequestResp
- type CreateRequestResponse
- type CreateTemplateJSONRequestBody
- type CreateTemplateRequest
- type CreateTemplateResp
- type CreateTemplateResponse
- type Credentials
- type DeleteAPIKeyResp
- type DeleteDirectoryLogoResp
- type DeleteDirectoryResp
- type DeleteEnvResp
- type DeleteLogoParams
- type DeleteLogoResp
- type DeletePersonPropertiesParams
- type DeletePersonPropertiesResp
- type DeleteSlackIntegrationResp
- type DeleteTemplateResp
- type Directory
- type DirectoryAuthorizedAuditEvent
- type DirectoryCreatedAuditEvent
- type DirectoryDeletedAuditEvent
- type DirectoryGroup
- type DirectoryKind
- type DirectoryLogoDeletedAuditEvent
- type DirectoryLogoUploadedAuditEvent
- type DirectorySetCredentialsAuditEvent
- type DirectoryUpdatedAuditEvent
- type EmployeeBadgeValidationResult
- type EncryptSecretJSONRequestBody
- type EncryptSecretRequest
- type EncryptSecretResp
- type EncryptSecretResponse
- type EntraEamAuthorizeAuditEvent
- type EntraEamAuthorizeRequest
- type EntraEamAuthorizeResponse
- type EntraEamFinishAuditEvent
- type EntraEamFinishRequest
- type EntraEamFinishResponse
- type Env
- type EnvCreatedAuditEvent
- type EnvDeletedAuditEvent
- type EnvLogoDeletedAuditEvent
- type EnvLogoUploadedAuditEvent
- type EnvStatusFilterParams
- type EnvStorage
- type EnvUpdateRequest
- type EnvUpdatedAtFilterParams
- type EnvUpdatedAuditEvent
- type EnvWebhookSecretUpdatedAuditEvent
- type Expectation
- type ExtensionInvokedAuditEvent
- type GetAPIKeyResp
- type GetAccountResp
- type GetBulkPeoplePropertiesJSONRequestBody
- type GetBulkPeoplePropertiesResp
- type GetDirectoriesResponse
- type GetDirectoryAuthorizationURLResp
- type GetDirectoryResp
- type GetEnvMicrometricsParams
- type GetEnvMicrometricsResp
- type GetEnvRequestResp
- type GetEnvResp
- type GetMicrometricsResponse
- type GetOrgResp
- type GetPersonPropertiesParams
- type GetPersonPropertiesResp
- type GetRequestResp
- type GetRequestsResponse
- type GetSlackRequestDetailsResp
- type GovtidType
- type GovtidValue
- type GroupRecoveryPolicy
- type HttpRequestDoer
- type InviteOrgMemberJSONRequestBody
- type InviteOrgMemberRequest
- type InviteOrgMemberResp
- type ListAPIKeysResp
- type ListAPIKeysResponse
- type ListAccountsParams
- type ListAccountsResp
- type ListAuditEventsParams
- type ListAuditEventsResp
- type ListAuditEventsResponse
- type ListDirectoriesResp
- type ListEnvRequestsParams
- type ListEnvRequestsParamsSort
- type ListEnvRequestsResp
- type ListEnvsResp
- type ListEnvsResponse
- type ListOrgMembersResp
- type ListOrgMembersResponse
- type ListSlackIntegrationsResp
- type ListSlackIntegrationsResponse
- type ListWebhooksResp
- type ListWebhooksResponse
- type Location
- type LogoKind
- type N400
- type NumericRequestStatus
- type OAuth2AuthorizeAuditEvent
- type OAuth2AuthorizeResponse
- type OAuth2PushedAuthorizationRequestAuditEvent
- type OAuth2RequestCanceledAuditEvent
- type OAuth2TokenAuditEvent
- type OAuth2V2AuthorizeAuditEvent
- type OIDCDelegate
- type OIDCDelegateUpdate
- type Oauth2AuthorizeIframeParams
- type Oauth2AuthorizeIframeParamsCodeChallengeMethod
- type Oauth2AuthorizeIframeParamsResponseMode
- type Oauth2AuthorizeIframeParamsResponseType
- type Oauth2AuthorizeIframeResp
- type Oauth2AuthorizeParams
- type Oauth2AuthorizeParamsCodeChallengeMethod
- type Oauth2AuthorizeParamsResponseMode
- type Oauth2AuthorizeParamsResponseType
- type Oauth2AuthorizeResp
- type Oauth2AuthorizeWithExperienceParams
- type Oauth2AuthorizeWithExperienceParamsCodeChallengeMethod
- type Oauth2AuthorizeWithExperienceParamsResponseMode
- type Oauth2AuthorizeWithExperienceParamsResponseType
- type Oauth2AuthorizeWithExperienceResp
- type Oauth2AuthorizeWithRequestAndExperienceParams
- type Oauth2AuthorizeWithRequestAndExperienceResp
- type Oauth2AuthorizeWithRequestParams
- type Oauth2AuthorizeWithRequestResp
- type Oauth2CancelParams
- type Oauth2CancelResp
- type Oauth2LogoutResp
- type Oauth2PollParams
- type Oauth2PollResp
- type Oauth2TokenFormdataRequestBody
- type Oauth2TokenResp
- type OktaEamAuthorizeAuditEvent
- type OktaEamAuthorizeRequest
- type OktaEamAuthorizeResponse
- type OktaEamFinishAuditEvent
- type OktaEamFinishRequest
- type OktaEamFinishResponse
- type Org
- type OrgMember
- type OrgMemberInvitedAuditEvent
- type OrgMemberRemovedAuditEvent
- type OrgMemberUpdatedAuditEvent
- type OrgUpdateRequest
- type OrgUpdatedAuditEvent
- type PartialCredentials
- type PeopleCompareAuditEvent
- type PollResponse
- type PresignRecoveryMicrositeURLJSONRequestBody
- type PresignRecoveryMicrositeURLResp
- type Principal
- type PropertiesResponse
- type PropertyResponse
- type PropertyResponseRequest
- type PushedAuthorizationRequest
- type PushedAuthorizationRequestCodeChallengeMethod
- type PushedAuthorizationRequestResponseMode
- type PushedAuthorizationRequestResponseType
- type PushedAuthorizationResponse
- type RecoveryMicrositeFlow
- type RecoveryMicrositeOperation
- type RecoveryMicrositePresignRequest
- type RecoveryMicrositePresignResponse
- type RecoveryOperationRateLimit
- type RecoveryPolicy
- type RecoveryPolicyRules
- type RefreshWebhookSecretJSONRequestBody
- type RefreshWebhookSecretRequest
- type RefreshWebhookSecretResp
- type RefreshWebhookSecretResponse
- type RegenerateDirectoryAgentTokenResp
- type RegenerateDirectoryAgentTokenResponse
- type RemoveOrgMemberResp
- type Request
- type RequestBrowser
- type RequestCanceledAuditEvent
- type RequestCreatedAuditEvent
- type RequestEditorFn
- type RequestMobileDevice
- type RequestProgress
- type RequestProperties
- type RequestStatus
- type RequestUpdatedAuditEvent
- type RequestVerificationSource
- type Role
- type Scope
- type SelfieCompareAuditEvent
- type SetDirectoryCredentialsJSONRequestBody
- type SetDirectoryCredentialsResp
- type SharingRevokedAuditEvent
- type SlackIntegration
- type SlackRequestDetailsResponse
- type SubjectComparisonRequest
- type SyncDirectoryResp
- type Template
- type TemplateClaimDefinition
- type TemplateCreatedAuditEvent
- type TemplateDeletedAuditEvent
- type TemplateScopeDefinition
- type TemplateUpdatedAuditEvent
- type TokenRequest
- type TokenRequestGrantType
- type TokenResponse
- type TokenResponseError
- type TokenResponseTokenType
- type UpdateAPIKeyJSONRequestBody
- type UpdateAPIKeyResp
- type UpdateAccountJSONRequestBody
- type UpdateAccountResp
- type UpdateDirectoryJSONRequestBody
- type UpdateDirectoryRequest
- type UpdateDirectoryResp
- type UpdateEnvJSONRequestBody
- type UpdateEnvResp
- type UpdateOrgJSONRequestBody
- type UpdateOrgMemberJSONRequestBody
- type UpdateOrgMemberRequest
- type UpdateOrgMemberResp
- type UpdateOrgResp
- type UpdateRequestJSONRequestBody
- type UpdateRequestRequest
- type UpdateRequestResp
- type UpdateTemplateJSONRequestBody
- type UpdateTemplateRequest
- type UpdateTemplateResp
- type UploadAccountPhotoResp
- type UploadDirectoryLogoMultipartBody
- type UploadDirectoryLogoMultipartRequestBody
- type UploadDirectoryLogoResp
- type UploadLogoMultipartBody
- type UploadLogoMultipartRequestBody
- type UploadLogoParams
- type UploadLogoResp
- type Webhook
- type WebhookAttempt
- type WebhookDefinition
- type WebhookDefinitionUpdate
- type WebhookEventType
- type WebhookHeader
Constants ¶
View Source
const ( ApiKeyScopes = "apiKey.Scopes" NoneScopes = "none.Scopes" )
Variables ¶
This section is empty.
Functions ¶
func NewBulkUpdateAccountsRequest ¶ added in v0.1.12
func NewBulkUpdateAccountsRequest(server string, body BulkUpdateAccountsJSONRequestBody) (*http.Request, error)
NewBulkUpdateAccountsRequest calls the generic BulkUpdateAccounts builder with application/json body
func NewBulkUpdateAccountsRequestWithBody ¶ added in v0.1.12
func NewBulkUpdateAccountsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewBulkUpdateAccountsRequestWithBody generates requests for BulkUpdateAccounts with any type of body
func NewBulkUploadAccountPhotosRequestWithBody ¶
func NewBulkUploadAccountPhotosRequestWithBody(server string, params *BulkUploadAccountPhotosParams, contentType string, body io.Reader) (*http.Request, error)
NewBulkUploadAccountPhotosRequestWithBody generates requests for BulkUploadAccountPhotos with any type of body
func NewCancelRequestRequest ¶
NewCancelRequestRequest generates requests for CancelRequest
func NewComparePeopleRequest ¶
func NewComparePeopleRequest(server string, subject string, body ComparePeopleJSONRequestBody) (*http.Request, error)
NewComparePeopleRequest calls the generic ComparePeople builder with application/json body
func NewComparePeopleRequestWithBody ¶
func NewComparePeopleRequestWithBody(server string, subject string, contentType string, body io.Reader) (*http.Request, error)
NewComparePeopleRequestWithBody generates requests for ComparePeople with any type of body
func NewCompareSelfieRequestWithBody ¶
func NewCompareSelfieRequestWithBody(server string, subject string, contentType string, body io.Reader) (*http.Request, error)
NewCompareSelfieRequestWithBody generates requests for CompareSelfie with any type of body
func NewCreateAPIKeyRequest ¶
func NewCreateAPIKeyRequest(server string, body CreateAPIKeyJSONRequestBody) (*http.Request, error)
NewCreateAPIKeyRequest calls the generic CreateAPIKey builder with application/json body
func NewCreateAPIKeyRequestWithBody ¶
func NewCreateAPIKeyRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewCreateAPIKeyRequestWithBody generates requests for CreateAPIKey with any type of body
func NewCreateDirectoryRequest ¶
func NewCreateDirectoryRequest(server string, body CreateDirectoryJSONRequestBody) (*http.Request, error)
NewCreateDirectoryRequest calls the generic CreateDirectory builder with application/json body
func NewCreateDirectoryRequestWithBody ¶
func NewCreateDirectoryRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewCreateDirectoryRequestWithBody generates requests for CreateDirectory with any type of body
func NewCreateEnvRequest ¶
func NewCreateEnvRequest(server string, body CreateEnvJSONRequestBody) (*http.Request, error)
NewCreateEnvRequest calls the generic CreateEnv builder with application/json body
func NewCreateEnvRequestWithBody ¶
func NewCreateEnvRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewCreateEnvRequestWithBody generates requests for CreateEnv with any type of body
func NewCreateRequestRequest ¶
func NewCreateRequestRequest(server string, body CreateRequestJSONRequestBody) (*http.Request, error)
NewCreateRequestRequest calls the generic CreateRequest builder with application/json body
func NewCreateRequestRequestWithBody ¶
func NewCreateRequestRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewCreateRequestRequestWithBody generates requests for CreateRequest with any type of body
func NewCreateTemplateRequest ¶
func NewCreateTemplateRequest(server string, env string, body CreateTemplateJSONRequestBody) (*http.Request, error)
NewCreateTemplateRequest calls the generic CreateTemplate builder with application/json body
func NewCreateTemplateRequestWithBody ¶
func NewCreateTemplateRequestWithBody(server string, env string, contentType string, body io.Reader) (*http.Request, error)
NewCreateTemplateRequestWithBody generates requests for CreateTemplate with any type of body
func NewDeleteAPIKeyRequest ¶
NewDeleteAPIKeyRequest generates requests for DeleteAPIKey
func NewDeleteDirectoryLogoRequest ¶ added in v0.1.16
NewDeleteDirectoryLogoRequest generates requests for DeleteDirectoryLogo
func NewDeleteDirectoryRequest ¶
NewDeleteDirectoryRequest generates requests for DeleteDirectory
func NewDeleteEnvRequest ¶
NewDeleteEnvRequest generates requests for DeleteEnv
func NewDeleteLogoRequest ¶
func NewDeleteLogoRequest(server string, env string, params *DeleteLogoParams) (*http.Request, error)
NewDeleteLogoRequest generates requests for DeleteLogo
func NewDeletePersonPropertiesRequest ¶
func NewDeletePersonPropertiesRequest(server string, subject string, scopes string, params *DeletePersonPropertiesParams) (*http.Request, error)
NewDeletePersonPropertiesRequest generates requests for DeletePersonProperties
func NewDeleteSlackIntegrationRequest ¶ added in v0.1.17
func NewDeleteSlackIntegrationRequest(server string, env string, integration string) (*http.Request, error)
NewDeleteSlackIntegrationRequest generates requests for DeleteSlackIntegration
func NewDeleteTemplateRequest ¶
NewDeleteTemplateRequest generates requests for DeleteTemplate
func NewEncryptSecretRequest ¶ added in v0.1.18
func NewEncryptSecretRequest(server string, env string, body EncryptSecretJSONRequestBody) (*http.Request, error)
NewEncryptSecretRequest calls the generic EncryptSecret builder with application/json body
func NewEncryptSecretRequestWithBody ¶ added in v0.1.18
func NewEncryptSecretRequestWithBody(server string, env string, contentType string, body io.Reader) (*http.Request, error)
NewEncryptSecretRequestWithBody generates requests for EncryptSecret with any type of body
func NewGetAPIKeyRequest ¶
NewGetAPIKeyRequest generates requests for GetAPIKey
func NewGetAccountRequest ¶
NewGetAccountRequest generates requests for GetAccount
func NewGetBulkPeoplePropertiesRequest ¶
func NewGetBulkPeoplePropertiesRequest(server string, body GetBulkPeoplePropertiesJSONRequestBody) (*http.Request, error)
NewGetBulkPeoplePropertiesRequest calls the generic GetBulkPeopleProperties builder with application/json body
func NewGetBulkPeoplePropertiesRequestWithBody ¶
func NewGetBulkPeoplePropertiesRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewGetBulkPeoplePropertiesRequestWithBody generates requests for GetBulkPeopleProperties with any type of body
func NewGetDirectoryAuthorizationURLRequest ¶
NewGetDirectoryAuthorizationURLRequest generates requests for GetDirectoryAuthorizationURL
func NewGetDirectoryRequest ¶
NewGetDirectoryRequest generates requests for GetDirectory
func NewGetEnvMicrometricsRequest ¶ added in v0.1.16
func NewGetEnvMicrometricsRequest(server string, env string, params *GetEnvMicrometricsParams) (*http.Request, error)
NewGetEnvMicrometricsRequest generates requests for GetEnvMicrometrics
func NewGetEnvRequest ¶
NewGetEnvRequest generates requests for GetEnv
func NewGetEnvRequestRequest ¶
NewGetEnvRequestRequest generates requests for GetEnvRequest
func NewGetOrgRequest ¶
NewGetOrgRequest generates requests for GetOrg
func NewGetPersonPropertiesRequest ¶
func NewGetPersonPropertiesRequest(server string, subject string, scopes string, params *GetPersonPropertiesParams) (*http.Request, error)
NewGetPersonPropertiesRequest generates requests for GetPersonProperties
func NewGetRequestRequest ¶
NewGetRequestRequest generates requests for GetRequest
func NewGetSlackRequestDetailsRequest ¶ added in v0.1.17
NewGetSlackRequestDetailsRequest generates requests for GetSlackRequestDetails
func NewInviteOrgMemberRequest ¶
func NewInviteOrgMemberRequest(server string, body InviteOrgMemberJSONRequestBody) (*http.Request, error)
NewInviteOrgMemberRequest calls the generic InviteOrgMember builder with application/json body
func NewInviteOrgMemberRequestWithBody ¶
func NewInviteOrgMemberRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewInviteOrgMemberRequestWithBody generates requests for InviteOrgMember with any type of body
func NewListAPIKeysRequest ¶
NewListAPIKeysRequest generates requests for ListAPIKeys
func NewListAccountsRequest ¶
func NewListAccountsRequest(server string, params *ListAccountsParams) (*http.Request, error)
NewListAccountsRequest generates requests for ListAccounts
func NewListAuditEventsRequest ¶ added in v0.1.15
func NewListAuditEventsRequest(server string, params *ListAuditEventsParams) (*http.Request, error)
NewListAuditEventsRequest generates requests for ListAuditEvents
func NewListDirectoriesRequest ¶
NewListDirectoriesRequest generates requests for ListDirectories
func NewListEnvRequestsRequest ¶
func NewListEnvRequestsRequest(server string, env string, params *ListEnvRequestsParams) (*http.Request, error)
NewListEnvRequestsRequest generates requests for ListEnvRequests
func NewListEnvsRequest ¶
NewListEnvsRequest generates requests for ListEnvs
func NewListOrgMembersRequest ¶
NewListOrgMembersRequest generates requests for ListOrgMembers
func NewListSlackIntegrationsRequest ¶ added in v0.1.17
NewListSlackIntegrationsRequest generates requests for ListSlackIntegrations
func NewListWebhooksRequest ¶
NewListWebhooksRequest generates requests for ListWebhooks
func NewOauth2AuthorizeIframeRequest ¶
func NewOauth2AuthorizeIframeRequest(server string, params *Oauth2AuthorizeIframeParams) (*http.Request, error)
NewOauth2AuthorizeIframeRequest generates requests for Oauth2AuthorizeIframe
func NewOauth2AuthorizeRequest ¶
func NewOauth2AuthorizeRequest(server string, params *Oauth2AuthorizeParams) (*http.Request, error)
NewOauth2AuthorizeRequest generates requests for Oauth2Authorize
func NewOauth2AuthorizeWithExperienceRequest ¶
func NewOauth2AuthorizeWithExperienceRequest(server string, experience string, params *Oauth2AuthorizeWithExperienceParams) (*http.Request, error)
NewOauth2AuthorizeWithExperienceRequest generates requests for Oauth2AuthorizeWithExperience
func NewOauth2AuthorizeWithRequestAndExperienceRequest ¶
func NewOauth2AuthorizeWithRequestAndExperienceRequest(server string, experience string, requestID string, params *Oauth2AuthorizeWithRequestAndExperienceParams) (*http.Request, error)
NewOauth2AuthorizeWithRequestAndExperienceRequest generates requests for Oauth2AuthorizeWithRequestAndExperience
func NewOauth2AuthorizeWithRequestRequest ¶
func NewOauth2AuthorizeWithRequestRequest(server string, requestID string, params *Oauth2AuthorizeWithRequestParams) (*http.Request, error)
NewOauth2AuthorizeWithRequestRequest generates requests for Oauth2AuthorizeWithRequest
func NewOauth2CancelRequest ¶
func NewOauth2CancelRequest(server string, requestID string, params *Oauth2CancelParams) (*http.Request, error)
NewOauth2CancelRequest generates requests for Oauth2Cancel
func NewOauth2LogoutRequest ¶
NewOauth2LogoutRequest generates requests for Oauth2Logout
func NewOauth2PollRequest ¶
func NewOauth2PollRequest(server string, requestID string, params *Oauth2PollParams) (*http.Request, error)
NewOauth2PollRequest generates requests for Oauth2Poll
func NewOauth2TokenRequestWithBody ¶
func NewOauth2TokenRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewOauth2TokenRequestWithBody generates requests for Oauth2Token with any type of body
func NewOauth2TokenRequestWithFormdataBody ¶
func NewOauth2TokenRequestWithFormdataBody(server string, body Oauth2TokenFormdataRequestBody) (*http.Request, error)
NewOauth2TokenRequestWithFormdataBody calls the generic Oauth2Token builder with application/x-www-form-urlencoded body
func NewPresignRecoveryMicrositeURLRequest ¶ added in v0.1.12
func NewPresignRecoveryMicrositeURLRequest(server string, env string, body PresignRecoveryMicrositeURLJSONRequestBody) (*http.Request, error)
NewPresignRecoveryMicrositeURLRequest calls the generic PresignRecoveryMicrositeURL builder with application/json body
func NewPresignRecoveryMicrositeURLRequestWithBody ¶ added in v0.1.12
func NewPresignRecoveryMicrositeURLRequestWithBody(server string, env string, contentType string, body io.Reader) (*http.Request, error)
NewPresignRecoveryMicrositeURLRequestWithBody generates requests for PresignRecoveryMicrositeURL with any type of body
func NewRefreshWebhookSecretRequest ¶ added in v0.1.12
func NewRefreshWebhookSecretRequest(server string, env string, body RefreshWebhookSecretJSONRequestBody) (*http.Request, error)
NewRefreshWebhookSecretRequest calls the generic RefreshWebhookSecret builder with application/json body
func NewRefreshWebhookSecretRequestWithBody ¶ added in v0.1.12
func NewRefreshWebhookSecretRequestWithBody(server string, env string, contentType string, body io.Reader) (*http.Request, error)
NewRefreshWebhookSecretRequestWithBody generates requests for RefreshWebhookSecret with any type of body
func NewRegenerateDirectoryAgentTokenRequest ¶ added in v0.1.16
func NewRegenerateDirectoryAgentTokenRequest(server string, directory string) (*http.Request, error)
NewRegenerateDirectoryAgentTokenRequest generates requests for RegenerateDirectoryAgentToken
func NewRemoveOrgMemberRequest ¶
NewRemoveOrgMemberRequest generates requests for RemoveOrgMember
func NewSetDirectoryCredentialsRequest ¶
func NewSetDirectoryCredentialsRequest(server string, directory string, body SetDirectoryCredentialsJSONRequestBody) (*http.Request, error)
NewSetDirectoryCredentialsRequest calls the generic SetDirectoryCredentials builder with application/json body
func NewSetDirectoryCredentialsRequestWithBody ¶
func NewSetDirectoryCredentialsRequestWithBody(server string, directory string, contentType string, body io.Reader) (*http.Request, error)
NewSetDirectoryCredentialsRequestWithBody generates requests for SetDirectoryCredentials with any type of body
func NewSyncDirectoryRequest ¶
NewSyncDirectoryRequest generates requests for SyncDirectory
func NewUpdateAPIKeyRequest ¶
func NewUpdateAPIKeyRequest(server string, apiKey string, body UpdateAPIKeyJSONRequestBody) (*http.Request, error)
NewUpdateAPIKeyRequest calls the generic UpdateAPIKey builder with application/json body
func NewUpdateAPIKeyRequestWithBody ¶
func NewUpdateAPIKeyRequestWithBody(server string, apiKey string, contentType string, body io.Reader) (*http.Request, error)
NewUpdateAPIKeyRequestWithBody generates requests for UpdateAPIKey with any type of body
func NewUpdateAccountRequest ¶
func NewUpdateAccountRequest(server string, account string, body UpdateAccountJSONRequestBody) (*http.Request, error)
NewUpdateAccountRequest calls the generic UpdateAccount builder with application/json body
func NewUpdateAccountRequestWithBody ¶
func NewUpdateAccountRequestWithBody(server string, account string, contentType string, body io.Reader) (*http.Request, error)
NewUpdateAccountRequestWithBody generates requests for UpdateAccount with any type of body
func NewUpdateDirectoryRequest ¶ added in v0.1.12
func NewUpdateDirectoryRequest(server string, directory string, body UpdateDirectoryJSONRequestBody) (*http.Request, error)
NewUpdateDirectoryRequest calls the generic UpdateDirectory builder with application/json body
func NewUpdateDirectoryRequestWithBody ¶ added in v0.1.12
func NewUpdateDirectoryRequestWithBody(server string, directory string, contentType string, body io.Reader) (*http.Request, error)
NewUpdateDirectoryRequestWithBody generates requests for UpdateDirectory with any type of body
func NewUpdateEnvRequest ¶
func NewUpdateEnvRequest(server string, env string, body UpdateEnvJSONRequestBody) (*http.Request, error)
NewUpdateEnvRequest calls the generic UpdateEnv builder with application/json body
func NewUpdateEnvRequestWithBody ¶
func NewUpdateEnvRequestWithBody(server string, env string, contentType string, body io.Reader) (*http.Request, error)
NewUpdateEnvRequestWithBody generates requests for UpdateEnv with any type of body
func NewUpdateOrgMemberRequest ¶
func NewUpdateOrgMemberRequest(server string, member string, body UpdateOrgMemberJSONRequestBody) (*http.Request, error)
NewUpdateOrgMemberRequest calls the generic UpdateOrgMember builder with application/json body
func NewUpdateOrgMemberRequestWithBody ¶
func NewUpdateOrgMemberRequestWithBody(server string, member string, contentType string, body io.Reader) (*http.Request, error)
NewUpdateOrgMemberRequestWithBody generates requests for UpdateOrgMember with any type of body
func NewUpdateOrgRequest ¶
func NewUpdateOrgRequest(server string, body UpdateOrgJSONRequestBody) (*http.Request, error)
NewUpdateOrgRequest calls the generic UpdateOrg builder with application/json body
func NewUpdateOrgRequestWithBody ¶
func NewUpdateOrgRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewUpdateOrgRequestWithBody generates requests for UpdateOrg with any type of body
func NewUpdateRequestRequest ¶
func NewUpdateRequestRequest(server string, requestID string, body UpdateRequestJSONRequestBody) (*http.Request, error)
NewUpdateRequestRequest calls the generic UpdateRequest builder with application/json body
func NewUpdateRequestRequestWithBody ¶
func NewUpdateRequestRequestWithBody(server string, requestID string, contentType string, body io.Reader) (*http.Request, error)
NewUpdateRequestRequestWithBody generates requests for UpdateRequest with any type of body
func NewUpdateTemplateRequest ¶
func NewUpdateTemplateRequest(server string, env string, template string, body UpdateTemplateJSONRequestBody) (*http.Request, error)
NewUpdateTemplateRequest calls the generic UpdateTemplate builder with application/json body
func NewUpdateTemplateRequestWithBody ¶
func NewUpdateTemplateRequestWithBody(server string, env string, template string, contentType string, body io.Reader) (*http.Request, error)
NewUpdateTemplateRequestWithBody generates requests for UpdateTemplate with any type of body
func NewUploadAccountPhotoRequestWithBody ¶
func NewUploadAccountPhotoRequestWithBody(server string, account string, contentType string, body io.Reader) (*http.Request, error)
NewUploadAccountPhotoRequestWithBody generates requests for UploadAccountPhoto with any type of body
Types ¶
type APIKey ¶
type APIKey struct {
// ID The unique identifier for the API key
ID string `json:"id"`
// Name A descriptive name for the API key
Name string `json:"name"`
// CreatedAt When the API key was created
CreatedAt time.Time `json:"created_at"`
// CreatedBy The OrgMember ID that created this API key.
CreatedBy *string `json:"created_by,omitempty"`
// Enabled Whether the API key is enabled.
Enabled bool `json:"enabled"`
// EnvIDs The unique identifier for the environments this API key belongs to, or `["*"]` if the key applies to all environments.
EnvIDs []string `json:"envs"`
Role Role `json:"role"`
// ExpiresAt The expiration date and time for the API key. If not provided, the key will not expire. Example: "2023-12-31T23:59:59Z"
ExpiresAt *time.Time `json:"expires_at,omitempty"`
// LastUsedAt The last time the API key was used. This is updated each time the key is used to make a request.
LastUsedAt *time.Time `json:"last_used_at,omitempty"`
}
APIKey defines model for APIKey.
type APIKeyCreatedAuditEvent ¶ added in v0.1.15
type APIKeyCreatedAuditEvent struct {
Request CreateAPIKeyRequest `json:"request"`
Response CreateAPIKeyResponse `json:"response"`
}
APIKeyCreatedAuditEvent defines model for APIKeyCreatedAuditEvent.
type APIKeyDeletedAuditEvent ¶ added in v0.1.15
type APIKeyDeletedAuditEvent struct {
Apikey string `json:"apikey"`
}
APIKeyDeletedAuditEvent defines model for APIKeyDeletedAuditEvent.
type APIKeyUpdateRequest ¶
type APIKeyUpdateRequest struct {
// Name A descriptive name for the API key
Name *string `json:"name,omitempty"`
// Enabled `true` if the API key is enabled, or `false` if it cannot be used.
Enabled *bool `json:"enabled,omitempty"`
Role *Role `json:"role,omitempty"`
// EnvIDs The unique identifier for the environments this API key belongs to, or `["*"]` if the key applies to all environments.
EnvIDs []string `json:"envs,omitempty"`
// ExpiresAt The expiration date and time for the API key. If not provided, the key will not expire. Example: "2023-12-31T23:59:59Z"
ExpiresAt *time.Time `json:"expires_at,omitempty"`
}
APIKeyUpdateRequest defines model for APIKeyUpdateRequest.
type APIKeyUpdatedAuditEvent ¶ added in v0.1.15
type APIKeyUpdatedAuditEvent struct {
Apikey string `json:"apikey"`
Request APIKeyUpdateRequest `json:"request"`
}
APIKeyUpdatedAuditEvent defines model for APIKeyUpdatedAuditEvent.
type Account ¶
type Account struct {
// ID The Nametag identifier for the account.
ID string `json:"id"`
// DirectoryIdentifiers The identifiers for the account used by the directory (typically an email address, username)
DirectoryIdentifiers []string `json:"directory_identifiers"`
// DirectoryImmutableIdentifier The unchanging identifier for the account used by the directory. Most directories have a UUID or other opaque identifier that doesn't change even when `directory_identifiers` changes.
DirectoryImmutableIdentifier string `json:"directory_immutable_identifier"`
// Name The person's name, according to the directory
Name string `json:"name"`
// Subject The Nametag Subject for this person, if the account has been bound to a `subject`. Null otherwise.
Subject *string `json:"subject,omitempty"`
// HaveBirthDate true if the person's expected birth date has been set for the directory.
HaveBirthDate *bool `json:"have_birth_date,omitempty"`
Photo *AccountPhoto `json:"photo,omitempty"`
}
Account defines model for Account.
type AccountBulkUpdateRequest ¶ added in v0.1.12
type AccountBulkUpdateRequest struct {
// Accounts A list of account update operations
Accounts []AccountBulkUpdateRequestItem `json:"accounts"`
}
AccountBulkUpdateRequest defines model for AccountBulkUpdateRequest.
type AccountBulkUpdateRequestItem ¶ added in v0.1.12
type AccountBulkUpdateRequestItem struct {
// Subject The subject for this person. Set this to an empty string to remove the binding for this person.
Subject *string `json:"subject,omitempty"`
// BirthDate The subject's date of birth. If this is set prior to the account being bound to a `subject`, then the birth date on their ID must match this date. You can also specify the hash or HMAC of the person's birth date. See [Birth date hashes](/docs/birth-date-hash) for details.
BirthDate *string `json:"birth_date,omitempty"`
// ID The unique identifier of the account. This can be the Nametag ID
// for the account, the immutable ID of the account (e.g. the GUID in
// Azure AD), or one of the identifiers associated with the account,
// (e.g. the email address, username, or UPN).
ID string `json:"id"`
}
AccountBulkUpdateRequestItem defines model for AccountBulkUpdateRequestItem.
type AccountBulkUpdateResponse ¶ added in v0.1.12
type AccountBulkUpdateResponse struct {
Results []AccountBulkUpdateResponseItem `json:"results"`
}
AccountBulkUpdateResponse defines model for AccountBulkUpdateResponse.
type AccountBulkUpdateResponseItem ¶ added in v0.1.12
type AccountBulkUpdateResponseItem struct {
// ID The account identifier provided in the request
ID string `json:"id"`
// Status A status code that describes whether the operation was successful
Status AccountBulkUpdateStatus `json:"status"`
// Error A description of the error that occurred.
Error *string `json:"error,omitempty"`
}
AccountBulkUpdateResponseItem The status of each operation specified in the request
type AccountBulkUpdateStatus ¶ added in v0.1.12
type AccountBulkUpdateStatus int
AccountBulkUpdateStatus A status code that describes whether the operation was successful
const ( AccountBulkUpdateItemStatusBadRequest AccountBulkUpdateStatus = 400 AccountBulkUpdateItemStatusConflict AccountBulkUpdateStatus = 409 AccountBulkUpdateItemStatusNotFound AccountBulkUpdateStatus = 404 AccountBulkUpdateItemStatusOK AccountBulkUpdateStatus = 204 )
Defines values for AccountBulkUpdateStatus.
type AccountPhoto ¶
type AccountPhoto struct {
// SHA256 The SHA256 hash of the uploaded image.
SHA256 string `json:"sha256"`
// CreatedAt The time when the image was added.
CreatedAt time.Time `json:"created_at"`
}
AccountPhoto defines model for AccountPhoto.
type AccountPhotoUploadedAuditEvent ¶ added in v0.1.15
type AccountPhotoUploadedAuditEvent struct {
Account string `json:"account"`
Directory string `json:"directory"`
}
AccountPhotoUploadedAuditEvent defines model for AccountPhotoUploadedAuditEvent.
type AccountUpdateRequest ¶
type AccountUpdateRequest struct {
// Subject The subject for this person. Set this to an empty string to remove the binding for this person.
Subject *string `json:"subject,omitempty"`
// BirthDate The subject's date of birth. If this is set prior to the account being bound to a `subject`, then the birth date on their ID must match this date.
// You can also specify the hash or HMAC of the person's birth date. See [Birth date hashes](/docs/birth-date-hash) for details.
BirthDate *string `json:"birth_date,omitempty"`
}
AccountUpdateRequest defines model for AccountUpdateRequest.
type AccountUpdatedAuditEvent ¶ added in v0.1.15
type AccountUpdatedAuditEvent struct {
Account string `json:"account"`
Directory string `json:"directory"`
Request AccountUpdateRequest `json:"request"`
}
AccountUpdatedAuditEvent defines model for AccountUpdatedAuditEvent.
type AccountValue ¶ added in v0.1.18
type AccountValue struct {
// ImmutableExternalId A GUID that uniquely identifies this entry in the directory, even if the external IDs change
ImmutableExternalId *string `json:"immutable_external_id,omitempty"`
// Ids The list of ID's associated with the account
Ids *[]string `json:"ids,omitempty"`
// BindingStrength The binding strength used to determine account info
BindingStrength *string `json:"binding_strength,omitempty"`
}
AccountValue defines model for AccountValue.
type AccountsList ¶
type AccountsList struct {
// Accounts The list of accounts
Accounts []Account `json:"accounts"`
// NextOffset A value for the offset query parameter for the next page of results
NextOffset *int `json:"next_offset,omitempty"`
}
AccountsList defines model for AccountsList.
type AuditEvent ¶ added in v0.1.15
type AuditEvent struct {
// ID The unique identifier for the event.
// The identifier is in [ULID format](https://github.com/ulid/spec) which means that you can sort the events by time by sorting by ID.
ID string `json:"id"`
// Time The time the event occurred
Time time.Time `json:"time"`
Kind AuditEventKind `json:"kind"`
// Trace A unique identifier for the event
Trace string `json:"trace"`
// Truncated True if the details of this record have been removed because the record would exceed the size limit for audit logs.
Truncated *bool `json:"truncated,omitempty"`
// RemoteAddr The IP address of the client that made the request
RemoteAddr *string `json:"remote_addr,omitempty"`
// UserAgent The remote user agent of the client that made the request
UserAgent *string `json:"user_agent,omitempty"`
// OrgID The ID of the organization for the actor performing the action. This will be the same for all your events.
OrgID string `json:"org"`
// EnvID The ID of the environment that this action refers to.
EnvID *string `json:"env,omitempty"`
Principal *Principal `json:"principal,omitempty"`
EnvCreated *EnvCreatedAuditEvent `json:"env_created,omitempty"`
EnvUpdated *EnvUpdatedAuditEvent `json:"env_updated,omitempty"`
EnvDeleted *EnvDeletedAuditEvent `json:"env_deleted,omitempty"`
EnvLogoUploaded *EnvLogoUploadedAuditEvent `json:"env_logo_uploaded,omitempty"`
EnvLogoDeleted *EnvLogoDeletedAuditEvent `json:"env_logo_deleted,omitempty"`
TemplateCreated *TemplateCreatedAuditEvent `json:"template_created,omitempty"`
TemplateUpdated *TemplateUpdatedAuditEvent `json:"template_updated,omitempty"`
TemplateDeleted *TemplateDeletedAuditEvent `json:"template_deleted,omitempty"`
EnvWebhookSecretUpdated *EnvWebhookSecretUpdatedAuditEvent `json:"env_webhook_secret_updated,omitempty"`
OrgUpdated *OrgUpdatedAuditEvent `json:"org_updated,omitempty"`
OrgMemberInvited *OrgMemberInvitedAuditEvent `json:"org_member_invited,omitempty"`
OrgMemberRemoved *OrgMemberRemovedAuditEvent `json:"org_member_removed,omitempty"`
OrgMemberUpdated *OrgMemberUpdatedAuditEvent `json:"org_member_updated,omitempty"`
ApikeyCreated *APIKeyCreatedAuditEvent `json:"apikey_created,omitempty"`
ApikeyUpdated *APIKeyUpdatedAuditEvent `json:"apikey_updated,omitempty"`
ApikeyDeleted *APIKeyDeletedAuditEvent `json:"apikey_deleted,omitempty"`
RequestCreated *RequestCreatedAuditEvent `json:"request_created,omitempty"`
RequestUpdated *RequestUpdatedAuditEvent `json:"request_updated,omitempty"`
RequestCanceled *RequestCanceledAuditEvent `json:"request_canceled,omitempty"`
AccountUpdated *AccountUpdatedAuditEvent `json:"account_updated,omitempty"`
AccountPhotoUploaded *AccountPhotoUploadedAuditEvent `json:"account_photo_uploaded,omitempty"`
DirectoryCreated *DirectoryCreatedAuditEvent `json:"directory_created,omitempty"`
DirectoryUpdated *DirectoryUpdatedAuditEvent `json:"directory_updated,omitempty"`
DirectoryDeleted *DirectoryDeletedAuditEvent `json:"directory_deleted,omitempty"`
DirectoryAuthorized *DirectoryAuthorizedAuditEvent `json:"directory_authorized,omitempty"`
DirectorySetCredentials *DirectorySetCredentialsAuditEvent `json:"directory_set_credentials,omitempty"`
DirectoryLogoUploaded *DirectoryLogoUploadedAuditEvent `json:"directory_logo_uploaded,omitempty"`
DirectoryLogoDeleted *DirectoryLogoDeletedAuditEvent `json:"directory_logo_deleted,omitempty"`
ConsoleSignin *ConsoleSigninAuditEvent `json:"console_signin,omitempty"`
ConsoleSinginConfigureEmail *ConsoleSinginConfigureEmailAuditEvent `json:"console_singin_configure_email,omitempty"`
ConsoleSinginConfigureSaml *ConsoleSinginConfigureSAMLAuditEvent `json:"console_singin_configure_saml,omitempty"`
CliSignin *CLISigninAuditEvent `json:"cli_signin,omitempty"`
Oauth2PushedAuthorizationRequest *OAuth2PushedAuthorizationRequestAuditEvent `json:"oauth2_pushed_authorization_request,omitempty"`
Oauth2Authorize *OAuth2AuthorizeAuditEvent `json:"oauth2_authorize,omitempty"`
Oauth2V2Authorize *OAuth2V2AuthorizeAuditEvent `json:"oauth2_v2_authorize,omitempty"`
Oauth2RequestCanceled *OAuth2RequestCanceledAuditEvent `json:"oauth2_request_canceled,omitempty"`
Oauth2Token *OAuth2TokenAuditEvent `json:"oauth2_token,omitempty"`
EntraEamAuthorize *EntraEamAuthorizeAuditEvent `json:"entra_eam_authorize,omitempty"`
EntraEamFinish *EntraEamFinishAuditEvent `json:"entra_eam_finish,omitempty"`
OktaEamAuthorize *OktaEamAuthorizeAuditEvent `json:"okta_eam_authorize,omitempty"`
OktaEamFinish *OktaEamFinishAuditEvent `json:"okta_eam_finish,omitempty"`
PeopleCompare *PeopleCompareAuditEvent `json:"people_compare,omitempty"`
SelfieCompare *SelfieCompareAuditEvent `json:"selfie_compare,omitempty"`
SharingRevoked *SharingRevokedAuditEvent `json:"sharing_revoked,omitempty"`
ExtensionInvoked *ExtensionInvokedAuditEvent `json:"extension_invoked,omitempty"`
}
AuditEvent defines model for AuditEvent.
type AuditEventKind ¶ added in v0.1.18
type AuditEventKind string
AuditEventKind defines model for AuditEventKind.
const ( AuditEventKindAPIKeyCreated AuditEventKind = "apikey_created" AuditEventKindAPIKeyDeleted AuditEventKind = "apikey_deleted" AuditEventKindAPIKeyUpdated AuditEventKind = "apikey_updated" AuditEventKindAccountPhotoUploaded AuditEventKind = "account_photo_uploaded" AuditEventKindAccountUpdated AuditEventKind = "account_updated" AuditEventKindCLISignin AuditEventKind = "cli_signin" AuditEventKindConsoleSignin AuditEventKind = "console_signin" AuditEventKindConsoleSinginConfigureEmail AuditEventKind = "console_singin_configure_email" AuditEventKindConsoleSinginConfigureSAML AuditEventKind = "console_singin_configure_saml" AuditEventKindDirectoryAuthorized AuditEventKind = "directory_authorized" AuditEventKindDirectoryCreated AuditEventKind = "directory_created" AuditEventKindDirectoryDeleted AuditEventKind = "directory_deleted" AuditEventKindDirectoryLogoDeleted AuditEventKind = "directory_logo_deleted" AuditEventKindDirectoryLogoUploaded AuditEventKind = "directory_logo_uploaded" AuditEventKindDirectorySetCredentials AuditEventKind = "directory_set_credentials" AuditEventKindDirectoryUpdated AuditEventKind = "directory_updated" AuditEventKindEntraEamAuthorize AuditEventKind = "entra_eam_authorize" AuditEventKindEntraEamFinish AuditEventKind = "entra_eam_finish" AuditEventKindEnvCreated AuditEventKind = "env_created" AuditEventKindEnvDeleted AuditEventKind = "env_deleted" AuditEventKindEnvLogoDeleted AuditEventKind = "env_logo_deleted" AuditEventKindEnvLogoUploaded AuditEventKind = "env_logo_uploaded" AuditEventKindEnvUpdated AuditEventKind = "env_updated" AuditEventKindEnvWebhookSecretUpdated AuditEventKind = "env_webhook_secret_updated" AuditEventKindExtensionInvoked AuditEventKind = "extension_invoked" AuditEventKindOAuth2Authorize AuditEventKind = "oauth2_authorize" AuditEventKindOAuth2PushedAuthorizationRequest AuditEventKind = "oauth2_pushed_authorization_request" AuditEventKindOAuth2RequestCanceled AuditEventKind = "oauth2_request_canceled" AuditEventKindOAuth2Token AuditEventKind = "oauth2_token" AuditEventKindOAuth2V2Authorize AuditEventKind = "oauth2_v2_authorize" AuditEventKindOktaEamAuthorize AuditEventKind = "okta_eam_authorize" AuditEventKindOktaEamFinish AuditEventKind = "okta_eam_finish" AuditEventKindOrgMemberInvited AuditEventKind = "org_member_invited" AuditEventKindOrgMemberRemoved AuditEventKind = "org_member_removed" AuditEventKindOrgMemberUpdated AuditEventKind = "org_member_updated" AuditEventKindOrgUpdated AuditEventKind = "org_updated" AuditEventKindPeopleCompare AuditEventKind = "people_compare" AuditEventKindRequestCanceled AuditEventKind = "request_canceled" AuditEventKindRequestCreated AuditEventKind = "request_created" AuditEventKindRequestUpdated AuditEventKind = "request_updated" AuditEventKindSelfieCompare AuditEventKind = "selfie_compare" AuditEventKindSharingRevoked AuditEventKind = "sharing_revoked" AuditEventKindTemplateCreated AuditEventKind = "template_created" AuditEventKindTemplateDeleted AuditEventKind = "template_deleted" AuditEventKindTemplateUpdated AuditEventKind = "template_updated" )
Defines values for AuditEventKind.
type AuthorizeRequest ¶ added in v0.1.15
type AuthorizeRequest struct {
// Claim Space-separated list of claims
Claim *[]Claim `json:"claim,omitempty"`
// ClientId The client ID
ClientId string `json:"client_id"`
// CodeChallenge The code challenge
CodeChallenge *string `json:"code_challenge,omitempty"`
// CodeChallengeMethod The code challenge method
CodeChallengeMethod *AuthorizeRequestCodeChallengeMethod `json:"code_challenge_method,omitempty"`
// EmailHint The email hint
EmailHint *openapi_types.Email `json:"email_hint,omitempty"`
// RedirectUri The redirect URI
RedirectUri string `json:"redirect_uri"`
// ResponseMode The response mode
ResponseMode *AuthorizeRequestResponseMode `json:"response_mode,omitempty"`
// ResponseType The response type
ResponseType *AuthorizeRequestResponseType `json:"response_type,omitempty"`
Return *AuthorizeReturn `json:"return,omitempty"`
// Scope Space-separated list of scopes
Scope *[]Scope `json:"scope,omitempty"`
// State The state
State string `json:"state"`
// Template The template to use
Template *string `json:"template,omitempty"`
}
AuthorizeRequest defines model for AuthorizeRequest.
type AuthorizeRequestCodeChallengeMethod ¶ added in v0.1.15
type AuthorizeRequestCodeChallengeMethod string
AuthorizeRequestCodeChallengeMethod The code challenge method
const ( AuthorizeRequestCodeChallengeMethodPlain AuthorizeRequestCodeChallengeMethod = "plain" AuthorizeRequestCodeChallengeMethodS256 AuthorizeRequestCodeChallengeMethod = "S256" )
Defines values for AuthorizeRequestCodeChallengeMethod.
type AuthorizeRequestResponseMode ¶ added in v0.1.15
type AuthorizeRequestResponseMode string
AuthorizeRequestResponseMode The response mode
const (
AuthorizeRequestResponseModeFragment AuthorizeRequestResponseMode = "fragment"
)
Defines values for AuthorizeRequestResponseMode.
type AuthorizeRequestResponseType ¶ added in v0.1.15
type AuthorizeRequestResponseType string
AuthorizeRequestResponseType The response type
const (
AuthorizeRequestResponseTypeCode AuthorizeRequestResponseType = "code"
)
Defines values for AuthorizeRequestResponseType.
type AuthorizeResponse ¶
type AuthorizeResponse struct {
ErrorMessage string `json:"error_message,omitempty"`
RedirectURI string `json:"redirect_uri,omitempty"`
EnvName string `json:"env_name,omitempty"`
QRCode []byte `json:"qrcode,omitempty"`
InstallTicket string `json:"install_ticket,omitempty"`
RequestID string `json:"request,omitempty"`
SessionToken string `json:"session_token,omitempty"`
AppClipExperience string `json:"app_clip_experience,omitempty"`
Return AuthorizeReturn `json:"return"`
}
AuthorizeResponse defines model for AuthorizeResponse.
type AuthorizeReturn ¶
type AuthorizeReturn string
AuthorizeReturn defines model for AuthorizeReturn.
const ( AuthorizeReturnChrome AuthorizeReturn = "chrome" AuthorizeReturnFirefox AuthorizeReturn = "firefox" AuthorizeReturnHTTPS AuthorizeReturn = "https" AuthorizeReturnNone AuthorizeReturn = "" )
Defines values for AuthorizeReturn.
type AuthorizeStatus ¶
type AuthorizeStatus int
AuthorizeStatus defines model for AuthorizeStatus.
const ( AuthorizeStatusComplete AuthorizeStatus = 200 AuthorizeStatusExpired AuthorizeStatus = 510 AuthorizeStatusPending AuthorizeStatus = 100 AuthorizeStatusRejected AuthorizeStatus = 403 )
Defines values for AuthorizeStatus.
type AuthorizeV2Request ¶ added in v0.1.16
type AuthorizeV2Request struct {
// RequestUri The request URI
RequestUri string `json:"request_uri"`
}
AuthorizeV2Request defines model for AuthorizeV2Request.
type BadRequestResponse ¶
type BadRequestResponse struct {
// Status The status code for the request. Always 400, meaning the request was invalid
Status BadRequestResponseStatus `json:"status"`
// Errors A set of descriptive error messages that caused the request to be invalid
Errors []string `json:"errors"`
}
BadRequestResponse defines model for BadRequestResponse.
type BadRequestResponseStatus ¶
type BadRequestResponseStatus int
BadRequestResponseStatus The status code for the request. Always 400, meaning the request was invalid
const (
BadRequestResponseStatusN400 BadRequestResponseStatus = 400
)
Defines values for BadRequestResponseStatus.
type BulkRequest ¶
type BulkRequest struct {
// Requests A list of property requests, one for each person about whom you are requesting information.
Requests []BulkRequestItem `json:"requests"`
}
BulkRequest defines model for BulkRequest.
type BulkRequestItem ¶
type BulkRequestItem struct {
// Subject The subject of the request. This is the person whose properties are being requested.
Subject string `json:"subject"`
// Scopes Which scopes you are requesting for this person.
Scopes *[]Scope `json:"scopes,omitempty"`
// Claims Which claims you are requesting for this person.
Claims []Claim `json:"claims"`
}
BulkRequestItem defines model for BulkRequestItem.
type BulkResponse ¶
type BulkResponse struct {
// Responses A list of responses for each person requested.
Responses []PropertiesResponse `json:"data"`
}
BulkResponse defines model for BulkResponse.
type BulkUpdateAccountsJSONRequestBody ¶ added in v0.1.12
type BulkUpdateAccountsJSONRequestBody = AccountBulkUpdateRequest
BulkUpdateAccountsJSONRequestBody defines body for BulkUpdateAccounts for application/json ContentType.
type BulkUpdateAccountsResp ¶ added in v0.1.12
type BulkUpdateAccountsResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *AccountBulkUpdateResponse
JSON400 *N400
}
func ParseBulkUpdateAccountsResp ¶ added in v0.1.12
func ParseBulkUpdateAccountsResp(rsp *http.Response) (*BulkUpdateAccountsResp, error)
ParseBulkUpdateAccountsResp parses an HTTP response from a BulkUpdateAccountsWithResponse call
func (BulkUpdateAccountsResp) Status ¶ added in v0.1.12
func (r BulkUpdateAccountsResp) Status() string
Status returns HTTPResponse.Status
func (BulkUpdateAccountsResp) StatusCode ¶ added in v0.1.12
func (r BulkUpdateAccountsResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type BulkUploadAccountPhotosParams ¶
type BulkUploadAccountPhotosParams struct {
// Directory Modify only accounts in the specified directory(s)
Directory string `form:"directory" json:"directory"`
}
BulkUploadAccountPhotosParams defines parameters for BulkUploadAccountPhotos.
type BulkUploadAccountPhotosResp ¶
type BulkUploadAccountPhotosResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *BulkUploadAccountPhotosResponse
JSON400 *N400
}
func ParseBulkUploadAccountPhotosResp ¶
func ParseBulkUploadAccountPhotosResp(rsp *http.Response) (*BulkUploadAccountPhotosResp, error)
ParseBulkUploadAccountPhotosResp parses an HTTP response from a BulkUploadAccountPhotosWithResponse call
func (BulkUploadAccountPhotosResp) Status ¶
func (r BulkUploadAccountPhotosResp) Status() string
Status returns HTTPResponse.Status
func (BulkUploadAccountPhotosResp) StatusCode ¶
func (r BulkUploadAccountPhotosResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type BulkUploadAccountPhotosResponse ¶
type BulkUploadAccountPhotosResponse struct {
// Files A list of responses, each corresponding to a file in the uploaded archive.
Files []BulkUploadAccountPhotosResponseItem `json:"files"`
}
BulkUploadAccountPhotosResponse defines model for BulkUploadAccountPhotosResponse.
type BulkUploadAccountPhotosResponseItem ¶
type BulkUploadAccountPhotosResponseItem struct {
// Filename The name of the file
Filename string `json:"filename"`
// AccountID The Nametag identifier for the account that matched this file. If this field is absent, then the file was not matched to an existing account.
AccountID *string `json:"account_id,omitempty"`
// DirectoryIdentifiers The identifiers for the account used by the directory (typically an email address, username)
DirectoryIdentifiers *[]string `json:"directory_identifiers,omitempty"`
// DirectoryImmutableIdentifier The unchanging identifier for the account used by the directory. Most directories have a UUID or other opaque identifier that doesn't change even when `directory_identifiers` changes.
DirectoryImmutableIdentifier *string `json:"directory_immutable_identifier,omitempty"`
// Status This field is 200 if adding the photo was successful, 404 if an account could not be found, 400 if the image is invalid, or 422 if the image contains multiple faces, doesn't match the existing selfie, or no face at all.
Status int `json:"status"`
// Error A human-readable error message describing the reason a file could not be processed.
Error *string `json:"error,omitempty"`
}
BulkUploadAccountPhotosResponseItem defines model for BulkUploadAccountPhotosResponseItem.
type CLISigninAuditEvent ¶ added in v0.1.15
type CLISigninAuditEvent struct {
Session string `json:"session"`
}
CLISigninAuditEvent defines model for CLISigninAuditEvent.
type CancelRequestResp ¶
func ParseCancelRequestResp ¶
func ParseCancelRequestResp(rsp *http.Response) (*CancelRequestResp, error)
ParseCancelRequestResp parses an HTTP response from a CancelRequestWithResponse call
func (CancelRequestResp) Status ¶
func (r CancelRequestResp) Status() string
Status returns HTTPResponse.Status
func (CancelRequestResp) StatusCode ¶
func (r CancelRequestResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CancelResponse ¶
type CancelResponse struct {
RedirectURI string `json:"redirect_uri"`
}
CancelResponse defines model for CancelResponse.
type Claim ¶ added in v0.1.16
type Claim string
Claim Claims are used to describe the information you want people to share with you. In order to request a claim you must first define it in your environment and provide additional parameters, such as what type of data and how long you need the data. This is done separately for each environment you manage in the Nametag console.
const ( ClaimAccount Claim = "account" ClaimAddress Claim = "address" ClaimBirthDate Claim = "birth_date" ClaimEmail Claim = "email" ClaimFamilyName Claim = "family_name" ClaimGivenName Claim = "given_name" ClaimGovtid Claim = "govtid" ClaimGovtidExpired Claim = "govtid_expired" ClaimGpsLocation Claim = "gps_location" ClaimIpLocation Claim = "ip_location" ClaimName Claim = "name" ClaimPhoneNumber Claim = "phone_number" ClaimPicture Claim = "picture" ClaimPreferredName Claim = "preferred_name" )
Defines values for Claim.
type Client ¶
type Client struct {
// The endpoint of the server conforming to this interface, with scheme,
// https://api.deepmap.com for example. This can contain a path relative
// to the server, such as https://api.deepmap.com/dev-test, and all the
// paths in the swagger spec will be appended to the server.
Server string
// Doer for performing requests, typically a *http.Client with any
// customized settings, such as certificate chains.
Client HttpRequestDoer
// A list of callbacks for modifying requests which are generated before sending over
// the network.
RequestEditors []RequestEditorFn
}
Client which conforms to the OpenAPI3 specification for this service.
func NewClient ¶
func NewClient(server string, opts ...ClientOption) (*Client, error)
Creates a new Client, with reasonable defaults
func (*Client) BulkUpdateAccounts ¶ added in v0.1.12
func (c *Client) BulkUpdateAccounts(ctx context.Context, body BulkUpdateAccountsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) BulkUpdateAccountsWithBody ¶ added in v0.1.12
func (*Client) BulkUploadAccountPhotosWithBody ¶
func (*Client) CancelRequest ¶
func (*Client) ComparePeople ¶
func (c *Client) ComparePeople(ctx context.Context, subject string, body ComparePeopleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) ComparePeopleWithBody ¶
func (*Client) CompareSelfieWithBody ¶
func (*Client) CreateAPIKey ¶
func (c *Client) CreateAPIKey(ctx context.Context, body CreateAPIKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) CreateAPIKeyWithBody ¶
func (*Client) CreateDirectory ¶
func (c *Client) CreateDirectory(ctx context.Context, body CreateDirectoryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) CreateDirectoryWithBody ¶
func (*Client) CreateEnv ¶
func (c *Client) CreateEnv(ctx context.Context, body CreateEnvJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) CreateEnvWithBody ¶
func (*Client) CreateRequest ¶
func (c *Client) CreateRequest(ctx context.Context, body CreateRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) CreateRequestWithBody ¶
func (*Client) CreateTemplate ¶
func (c *Client) CreateTemplate(ctx context.Context, env string, body CreateTemplateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) CreateTemplateWithBody ¶
func (*Client) DeleteAPIKey ¶
func (*Client) DeleteDirectory ¶
func (*Client) DeleteDirectoryLogo ¶ added in v0.1.16
func (*Client) DeleteLogo ¶
func (c *Client) DeleteLogo(ctx context.Context, env string, params *DeleteLogoParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) DeletePersonProperties ¶
func (c *Client) DeletePersonProperties(ctx context.Context, subject string, scopes string, params *DeletePersonPropertiesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) DeleteSlackIntegration ¶ added in v0.1.17
func (*Client) DeleteTemplate ¶
func (*Client) EncryptSecret ¶ added in v0.1.18
func (c *Client) EncryptSecret(ctx context.Context, env string, body EncryptSecretJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) EncryptSecretWithBody ¶ added in v0.1.18
func (*Client) GetAccount ¶
func (*Client) GetBulkPeopleProperties ¶
func (c *Client) GetBulkPeopleProperties(ctx context.Context, body GetBulkPeoplePropertiesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetBulkPeoplePropertiesWithBody ¶
func (*Client) GetDirectory ¶
func (*Client) GetDirectoryAuthorizationURL ¶
func (*Client) GetEnvMicrometrics ¶ added in v0.1.16
func (c *Client) GetEnvMicrometrics(ctx context.Context, env string, params *GetEnvMicrometricsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetEnvRequest ¶
func (*Client) GetPersonProperties ¶
func (c *Client) GetPersonProperties(ctx context.Context, subject string, scopes string, params *GetPersonPropertiesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetRequest ¶
func (*Client) GetSlackRequestDetails ¶ added in v0.1.17
func (*Client) InviteOrgMember ¶
func (c *Client) InviteOrgMember(ctx context.Context, body InviteOrgMemberJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) InviteOrgMemberWithBody ¶
func (*Client) ListAPIKeys ¶
func (*Client) ListAccounts ¶
func (c *Client) ListAccounts(ctx context.Context, params *ListAccountsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) ListAuditEvents ¶ added in v0.1.15
func (c *Client) ListAuditEvents(ctx context.Context, params *ListAuditEventsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) ListDirectories ¶
func (*Client) ListEnvRequests ¶
func (c *Client) ListEnvRequests(ctx context.Context, env string, params *ListEnvRequestsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) ListOrgMembers ¶
func (*Client) ListSlackIntegrations ¶ added in v0.1.17
func (*Client) ListWebhooks ¶
func (*Client) Oauth2Authorize ¶
func (c *Client) Oauth2Authorize(ctx context.Context, params *Oauth2AuthorizeParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) Oauth2AuthorizeIframe ¶
func (c *Client) Oauth2AuthorizeIframe(ctx context.Context, params *Oauth2AuthorizeIframeParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) Oauth2AuthorizeWithExperience ¶
func (c *Client) Oauth2AuthorizeWithExperience(ctx context.Context, experience string, params *Oauth2AuthorizeWithExperienceParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) Oauth2AuthorizeWithRequest ¶
func (c *Client) Oauth2AuthorizeWithRequest(ctx context.Context, requestID string, params *Oauth2AuthorizeWithRequestParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) Oauth2AuthorizeWithRequestAndExperience ¶
func (c *Client) Oauth2AuthorizeWithRequestAndExperience(ctx context.Context, experience string, requestID string, params *Oauth2AuthorizeWithRequestAndExperienceParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) Oauth2Cancel ¶
func (c *Client) Oauth2Cancel(ctx context.Context, requestID string, params *Oauth2CancelParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) Oauth2Logout ¶
func (*Client) Oauth2Poll ¶
func (c *Client) Oauth2Poll(ctx context.Context, requestID string, params *Oauth2PollParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) Oauth2TokenWithBody ¶
func (*Client) Oauth2TokenWithFormdataBody ¶
func (c *Client) Oauth2TokenWithFormdataBody(ctx context.Context, body Oauth2TokenFormdataRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PresignRecoveryMicrositeURL ¶ added in v0.1.12
func (c *Client) PresignRecoveryMicrositeURL(ctx context.Context, env string, body PresignRecoveryMicrositeURLJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PresignRecoveryMicrositeURLWithBody ¶ added in v0.1.12
func (*Client) RefreshWebhookSecret ¶ added in v0.1.12
func (c *Client) RefreshWebhookSecret(ctx context.Context, env string, body RefreshWebhookSecretJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) RefreshWebhookSecretWithBody ¶ added in v0.1.12
func (*Client) RegenerateDirectoryAgentToken ¶ added in v0.1.16
func (*Client) RemoveOrgMember ¶
func (*Client) SetDirectoryCredentials ¶
func (c *Client) SetDirectoryCredentials(ctx context.Context, directory string, body SetDirectoryCredentialsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) SetDirectoryCredentialsWithBody ¶
func (*Client) SyncDirectory ¶
func (*Client) UpdateAPIKey ¶
func (c *Client) UpdateAPIKey(ctx context.Context, apiKey string, body UpdateAPIKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateAPIKeyWithBody ¶
func (*Client) UpdateAccount ¶
func (c *Client) UpdateAccount(ctx context.Context, account string, body UpdateAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateAccountWithBody ¶
func (*Client) UpdateDirectory ¶ added in v0.1.12
func (c *Client) UpdateDirectory(ctx context.Context, directory string, body UpdateDirectoryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateDirectoryWithBody ¶ added in v0.1.12
func (*Client) UpdateEnv ¶
func (c *Client) UpdateEnv(ctx context.Context, env string, body UpdateEnvJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateEnvWithBody ¶
func (*Client) UpdateOrg ¶
func (c *Client) UpdateOrg(ctx context.Context, body UpdateOrgJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateOrgMember ¶
func (c *Client) UpdateOrgMember(ctx context.Context, member string, body UpdateOrgMemberJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateOrgMemberWithBody ¶
func (*Client) UpdateOrgWithBody ¶
func (*Client) UpdateRequest ¶
func (c *Client) UpdateRequest(ctx context.Context, requestID string, body UpdateRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateRequestWithBody ¶
func (*Client) UpdateTemplate ¶
func (c *Client) UpdateTemplate(ctx context.Context, env string, template string, body UpdateTemplateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateTemplateWithBody ¶
func (*Client) UploadAccountPhotoWithBody ¶
func (*Client) UploadDirectoryLogoWithBody ¶ added in v0.1.16
func (*Client) UploadLogoWithBody ¶
type ClientInterface ¶
type ClientInterface interface {
// BulkUploadAccountPhotosWithBody request with any body
BulkUploadAccountPhotosWithBody(ctx context.Context, params *BulkUploadAccountPhotosParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// ListAccounts request
ListAccounts(ctx context.Context, params *ListAccountsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// BulkUpdateAccountsWithBody request with any body
BulkUpdateAccountsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
BulkUpdateAccounts(ctx context.Context, body BulkUpdateAccountsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetAccount request
GetAccount(ctx context.Context, account string, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateAccountWithBody request with any body
UpdateAccountWithBody(ctx context.Context, account string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateAccount(ctx context.Context, account string, body UpdateAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// UploadAccountPhotoWithBody request with any body
UploadAccountPhotoWithBody(ctx context.Context, account string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// ListAPIKeys request
ListAPIKeys(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateAPIKeyWithBody request with any body
CreateAPIKeyWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateAPIKey(ctx context.Context, body CreateAPIKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteAPIKey request
DeleteAPIKey(ctx context.Context, apiKey string, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetAPIKey request
GetAPIKey(ctx context.Context, apiKey string, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateAPIKeyWithBody request with any body
UpdateAPIKeyWithBody(ctx context.Context, apiKey string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateAPIKey(ctx context.Context, apiKey string, body UpdateAPIKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// ListAuditEvents request
ListAuditEvents(ctx context.Context, params *ListAuditEventsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// Oauth2Cancel request
Oauth2Cancel(ctx context.Context, requestID string, params *Oauth2CancelParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// Oauth2Poll request
Oauth2Poll(ctx context.Context, requestID string, params *Oauth2PollParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// ListDirectories request
ListDirectories(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateDirectoryWithBody request with any body
CreateDirectoryWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateDirectory(ctx context.Context, body CreateDirectoryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteDirectory request
DeleteDirectory(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetDirectory request
GetDirectory(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateDirectoryWithBody request with any body
UpdateDirectoryWithBody(ctx context.Context, directory string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateDirectory(ctx context.Context, directory string, body UpdateDirectoryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetDirectoryAuthorizationURL request
GetDirectoryAuthorizationURL(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*http.Response, error)
// SetDirectoryCredentialsWithBody request with any body
SetDirectoryCredentialsWithBody(ctx context.Context, directory string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
SetDirectoryCredentials(ctx context.Context, directory string, body SetDirectoryCredentialsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteDirectoryLogo request
DeleteDirectoryLogo(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*http.Response, error)
// UploadDirectoryLogoWithBody request with any body
UploadDirectoryLogoWithBody(ctx context.Context, directory string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// RegenerateDirectoryAgentToken request
RegenerateDirectoryAgentToken(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*http.Response, error)
// SyncDirectory request
SyncDirectory(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*http.Response, error)
// ListEnvs request
ListEnvs(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateEnvWithBody request with any body
CreateEnvWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateEnv(ctx context.Context, body CreateEnvJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteEnv request
DeleteEnv(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetEnv request
GetEnv(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateEnvWithBody request with any body
UpdateEnvWithBody(ctx context.Context, env string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateEnv(ctx context.Context, env string, body UpdateEnvJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// EncryptSecretWithBody request with any body
EncryptSecretWithBody(ctx context.Context, env string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
EncryptSecret(ctx context.Context, env string, body EncryptSecretJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteLogo request
DeleteLogo(ctx context.Context, env string, params *DeleteLogoParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// UploadLogoWithBody request with any body
UploadLogoWithBody(ctx context.Context, env string, params *UploadLogoParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetEnvMicrometrics request
GetEnvMicrometrics(ctx context.Context, env string, params *GetEnvMicrometricsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// PresignRecoveryMicrositeURLWithBody request with any body
PresignRecoveryMicrositeURLWithBody(ctx context.Context, env string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PresignRecoveryMicrositeURL(ctx context.Context, env string, body PresignRecoveryMicrositeURLJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// RefreshWebhookSecretWithBody request with any body
RefreshWebhookSecretWithBody(ctx context.Context, env string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
RefreshWebhookSecret(ctx context.Context, env string, body RefreshWebhookSecretJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// ListEnvRequests request
ListEnvRequests(ctx context.Context, env string, params *ListEnvRequestsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetEnvRequest request
GetEnvRequest(ctx context.Context, env string, requestID string, reqEditors ...RequestEditorFn) (*http.Response, error)
// ListSlackIntegrations request
ListSlackIntegrations(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteSlackIntegration request
DeleteSlackIntegration(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateTemplateWithBody request with any body
CreateTemplateWithBody(ctx context.Context, env string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateTemplate(ctx context.Context, env string, body CreateTemplateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteTemplate request
DeleteTemplate(ctx context.Context, env string, template string, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateTemplateWithBody request with any body
UpdateTemplateWithBody(ctx context.Context, env string, template string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateTemplate(ctx context.Context, env string, template string, body UpdateTemplateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// ListWebhooks request
ListWebhooks(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetSlackRequestDetails request
GetSlackRequestDetails(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetOrg request
GetOrg(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateOrgWithBody request with any body
UpdateOrgWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateOrg(ctx context.Context, body UpdateOrgJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// ListOrgMembers request
ListOrgMembers(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// InviteOrgMemberWithBody request with any body
InviteOrgMemberWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
InviteOrgMember(ctx context.Context, body InviteOrgMemberJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// RemoveOrgMember request
RemoveOrgMember(ctx context.Context, member string, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateOrgMemberWithBody request with any body
UpdateOrgMemberWithBody(ctx context.Context, member string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateOrgMember(ctx context.Context, member string, body UpdateOrgMemberJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateRequestWithBody request with any body
CreateRequestWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateRequest(ctx context.Context, body CreateRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// CancelRequest request
CancelRequest(ctx context.Context, requestID string, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetRequest request
GetRequest(ctx context.Context, requestID string, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateRequestWithBody request with any body
UpdateRequestWithBody(ctx context.Context, requestID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateRequest(ctx context.Context, requestID string, body UpdateRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// Oauth2Authorize request
Oauth2Authorize(ctx context.Context, params *Oauth2AuthorizeParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// Oauth2AuthorizeIframe request
Oauth2AuthorizeIframe(ctx context.Context, params *Oauth2AuthorizeIframeParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// Oauth2AuthorizeWithRequest request
Oauth2AuthorizeWithRequest(ctx context.Context, requestID string, params *Oauth2AuthorizeWithRequestParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// Oauth2Logout request
Oauth2Logout(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetBulkPeoplePropertiesWithBody request with any body
GetBulkPeoplePropertiesWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
GetBulkPeopleProperties(ctx context.Context, body GetBulkPeoplePropertiesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// ComparePeopleWithBody request with any body
ComparePeopleWithBody(ctx context.Context, subject string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
ComparePeople(ctx context.Context, subject string, body ComparePeopleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// CompareSelfieWithBody request with any body
CompareSelfieWithBody(ctx context.Context, subject string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeletePersonProperties request
DeletePersonProperties(ctx context.Context, subject string, scopes string, params *DeletePersonPropertiesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetPersonProperties request
GetPersonProperties(ctx context.Context, subject string, scopes string, params *GetPersonPropertiesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// Oauth2TokenWithBody request with any body
Oauth2TokenWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
Oauth2TokenWithFormdataBody(ctx context.Context, body Oauth2TokenFormdataRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// Oauth2AuthorizeWithExperience request
Oauth2AuthorizeWithExperience(ctx context.Context, experience string, params *Oauth2AuthorizeWithExperienceParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// Oauth2AuthorizeWithRequestAndExperience request
Oauth2AuthorizeWithRequestAndExperience(ctx context.Context, experience string, requestID string, params *Oauth2AuthorizeWithRequestAndExperienceParams, reqEditors ...RequestEditorFn) (*http.Response, error)
}
The interface specification for the client above.
type ClientOption ¶
ClientOption allows setting custom parameters during construction
func WithHTTPClient ¶
func WithHTTPClient(doer HttpRequestDoer) ClientOption
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.
func WithRequestEditorFn ¶
func WithRequestEditorFn(fn RequestEditorFn) ClientOption
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.
type ClientWithResponses ¶
type ClientWithResponses struct {
ClientInterface
}
ClientWithResponses builds on ClientInterface to offer response payloads
func NewClientWithResponses ¶
func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling
func (*ClientWithResponses) BulkUpdateAccountsWithBodyWithResponse ¶ added in v0.1.12
func (c *ClientWithResponses) BulkUpdateAccountsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BulkUpdateAccountsResp, error)
BulkUpdateAccountsWithBodyWithResponse request with arbitrary body returning *BulkUpdateAccountsResp
func (*ClientWithResponses) BulkUpdateAccountsWithResponse ¶ added in v0.1.12
func (c *ClientWithResponses) BulkUpdateAccountsWithResponse(ctx context.Context, body BulkUpdateAccountsJSONRequestBody, reqEditors ...RequestEditorFn) (*BulkUpdateAccountsResp, error)
func (*ClientWithResponses) BulkUploadAccountPhotosWithBodyWithResponse ¶
func (c *ClientWithResponses) BulkUploadAccountPhotosWithBodyWithResponse(ctx context.Context, params *BulkUploadAccountPhotosParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BulkUploadAccountPhotosResp, error)
BulkUploadAccountPhotosWithBodyWithResponse request with arbitrary body returning *BulkUploadAccountPhotosResp
func (*ClientWithResponses) CancelRequestWithResponse ¶
func (c *ClientWithResponses) CancelRequestWithResponse(ctx context.Context, requestID string, reqEditors ...RequestEditorFn) (*CancelRequestResp, error)
CancelRequestWithResponse request returning *CancelRequestResp
func (*ClientWithResponses) ComparePeopleWithBodyWithResponse ¶
func (c *ClientWithResponses) ComparePeopleWithBodyWithResponse(ctx context.Context, subject string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ComparePeopleResp, error)
ComparePeopleWithBodyWithResponse request with arbitrary body returning *ComparePeopleResp
func (*ClientWithResponses) ComparePeopleWithResponse ¶
func (c *ClientWithResponses) ComparePeopleWithResponse(ctx context.Context, subject string, body ComparePeopleJSONRequestBody, reqEditors ...RequestEditorFn) (*ComparePeopleResp, error)
func (*ClientWithResponses) CompareSelfieWithBodyWithResponse ¶
func (c *ClientWithResponses) CompareSelfieWithBodyWithResponse(ctx context.Context, subject string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CompareSelfieResp, error)
CompareSelfieWithBodyWithResponse request with arbitrary body returning *CompareSelfieResp
func (*ClientWithResponses) CreateAPIKeyWithBodyWithResponse ¶
func (c *ClientWithResponses) CreateAPIKeyWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateAPIKeyResp, error)
CreateAPIKeyWithBodyWithResponse request with arbitrary body returning *CreateAPIKeyResp
func (*ClientWithResponses) CreateAPIKeyWithResponse ¶
func (c *ClientWithResponses) CreateAPIKeyWithResponse(ctx context.Context, body CreateAPIKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateAPIKeyResp, error)
func (*ClientWithResponses) CreateDirectoryWithBodyWithResponse ¶
func (c *ClientWithResponses) CreateDirectoryWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDirectoryResp, error)
CreateDirectoryWithBodyWithResponse request with arbitrary body returning *CreateDirectoryResp
func (*ClientWithResponses) CreateDirectoryWithResponse ¶
func (c *ClientWithResponses) CreateDirectoryWithResponse(ctx context.Context, body CreateDirectoryJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateDirectoryResp, error)
func (*ClientWithResponses) CreateEnvWithBodyWithResponse ¶
func (c *ClientWithResponses) CreateEnvWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateEnvResp, error)
CreateEnvWithBodyWithResponse request with arbitrary body returning *CreateEnvResp
func (*ClientWithResponses) CreateEnvWithResponse ¶
func (c *ClientWithResponses) CreateEnvWithResponse(ctx context.Context, body CreateEnvJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateEnvResp, error)
func (*ClientWithResponses) CreateRequestWithBodyWithResponse ¶
func (c *ClientWithResponses) CreateRequestWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateRequestResp, error)
CreateRequestWithBodyWithResponse request with arbitrary body returning *CreateRequestResp
func (*ClientWithResponses) CreateRequestWithResponse ¶
func (c *ClientWithResponses) CreateRequestWithResponse(ctx context.Context, body CreateRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateRequestResp, error)
func (*ClientWithResponses) CreateTemplateWithBodyWithResponse ¶
func (c *ClientWithResponses) CreateTemplateWithBodyWithResponse(ctx context.Context, env string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateTemplateResp, error)
CreateTemplateWithBodyWithResponse request with arbitrary body returning *CreateTemplateResp
func (*ClientWithResponses) CreateTemplateWithResponse ¶
func (c *ClientWithResponses) CreateTemplateWithResponse(ctx context.Context, env string, body CreateTemplateJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateTemplateResp, error)
func (*ClientWithResponses) DeleteAPIKeyWithResponse ¶
func (c *ClientWithResponses) DeleteAPIKeyWithResponse(ctx context.Context, apiKey string, reqEditors ...RequestEditorFn) (*DeleteAPIKeyResp, error)
DeleteAPIKeyWithResponse request returning *DeleteAPIKeyResp
func (*ClientWithResponses) DeleteDirectoryLogoWithResponse ¶ added in v0.1.16
func (c *ClientWithResponses) DeleteDirectoryLogoWithResponse(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*DeleteDirectoryLogoResp, error)
DeleteDirectoryLogoWithResponse request returning *DeleteDirectoryLogoResp
func (*ClientWithResponses) DeleteDirectoryWithResponse ¶
func (c *ClientWithResponses) DeleteDirectoryWithResponse(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*DeleteDirectoryResp, error)
DeleteDirectoryWithResponse request returning *DeleteDirectoryResp
func (*ClientWithResponses) DeleteEnvWithResponse ¶
func (c *ClientWithResponses) DeleteEnvWithResponse(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*DeleteEnvResp, error)
DeleteEnvWithResponse request returning *DeleteEnvResp
func (*ClientWithResponses) DeleteLogoWithResponse ¶
func (c *ClientWithResponses) DeleteLogoWithResponse(ctx context.Context, env string, params *DeleteLogoParams, reqEditors ...RequestEditorFn) (*DeleteLogoResp, error)
DeleteLogoWithResponse request returning *DeleteLogoResp
func (*ClientWithResponses) DeletePersonPropertiesWithResponse ¶
func (c *ClientWithResponses) DeletePersonPropertiesWithResponse(ctx context.Context, subject string, scopes string, params *DeletePersonPropertiesParams, reqEditors ...RequestEditorFn) (*DeletePersonPropertiesResp, error)
DeletePersonPropertiesWithResponse request returning *DeletePersonPropertiesResp
func (*ClientWithResponses) DeleteSlackIntegrationWithResponse ¶ added in v0.1.17
func (c *ClientWithResponses) DeleteSlackIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*DeleteSlackIntegrationResp, error)
DeleteSlackIntegrationWithResponse request returning *DeleteSlackIntegrationResp
func (*ClientWithResponses) DeleteTemplateWithResponse ¶
func (c *ClientWithResponses) DeleteTemplateWithResponse(ctx context.Context, env string, template string, reqEditors ...RequestEditorFn) (*DeleteTemplateResp, error)
DeleteTemplateWithResponse request returning *DeleteTemplateResp
func (*ClientWithResponses) EncryptSecretWithBodyWithResponse ¶ added in v0.1.18
func (c *ClientWithResponses) EncryptSecretWithBodyWithResponse(ctx context.Context, env string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*EncryptSecretResp, error)
EncryptSecretWithBodyWithResponse request with arbitrary body returning *EncryptSecretResp
func (*ClientWithResponses) EncryptSecretWithResponse ¶ added in v0.1.18
func (c *ClientWithResponses) EncryptSecretWithResponse(ctx context.Context, env string, body EncryptSecretJSONRequestBody, reqEditors ...RequestEditorFn) (*EncryptSecretResp, error)
func (*ClientWithResponses) GetAPIKeyWithResponse ¶
func (c *ClientWithResponses) GetAPIKeyWithResponse(ctx context.Context, apiKey string, reqEditors ...RequestEditorFn) (*GetAPIKeyResp, error)
GetAPIKeyWithResponse request returning *GetAPIKeyResp
func (*ClientWithResponses) GetAccountWithResponse ¶
func (c *ClientWithResponses) GetAccountWithResponse(ctx context.Context, account string, reqEditors ...RequestEditorFn) (*GetAccountResp, error)
GetAccountWithResponse request returning *GetAccountResp
func (*ClientWithResponses) GetBulkPeoplePropertiesWithBodyWithResponse ¶
func (c *ClientWithResponses) GetBulkPeoplePropertiesWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*GetBulkPeoplePropertiesResp, error)
GetBulkPeoplePropertiesWithBodyWithResponse request with arbitrary body returning *GetBulkPeoplePropertiesResp
func (*ClientWithResponses) GetBulkPeoplePropertiesWithResponse ¶
func (c *ClientWithResponses) GetBulkPeoplePropertiesWithResponse(ctx context.Context, body GetBulkPeoplePropertiesJSONRequestBody, reqEditors ...RequestEditorFn) (*GetBulkPeoplePropertiesResp, error)
func (*ClientWithResponses) GetDirectoryAuthorizationURLWithResponse ¶
func (c *ClientWithResponses) GetDirectoryAuthorizationURLWithResponse(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*GetDirectoryAuthorizationURLResp, error)
GetDirectoryAuthorizationURLWithResponse request returning *GetDirectoryAuthorizationURLResp
func (*ClientWithResponses) GetDirectoryWithResponse ¶
func (c *ClientWithResponses) GetDirectoryWithResponse(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*GetDirectoryResp, error)
GetDirectoryWithResponse request returning *GetDirectoryResp
func (*ClientWithResponses) GetEnvMicrometricsWithResponse ¶ added in v0.1.16
func (c *ClientWithResponses) GetEnvMicrometricsWithResponse(ctx context.Context, env string, params *GetEnvMicrometricsParams, reqEditors ...RequestEditorFn) (*GetEnvMicrometricsResp, error)
GetEnvMicrometricsWithResponse request returning *GetEnvMicrometricsResp
func (*ClientWithResponses) GetEnvRequestWithResponse ¶
func (c *ClientWithResponses) GetEnvRequestWithResponse(ctx context.Context, env string, requestID string, reqEditors ...RequestEditorFn) (*GetEnvRequestResp, error)
GetEnvRequestWithResponse request returning *GetEnvRequestResp
func (*ClientWithResponses) GetEnvWithResponse ¶
func (c *ClientWithResponses) GetEnvWithResponse(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*GetEnvResp, error)
GetEnvWithResponse request returning *GetEnvResp
func (*ClientWithResponses) GetOrgWithResponse ¶
func (c *ClientWithResponses) GetOrgWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetOrgResp, error)
GetOrgWithResponse request returning *GetOrgResp
func (*ClientWithResponses) GetPersonPropertiesWithResponse ¶
func (c *ClientWithResponses) GetPersonPropertiesWithResponse(ctx context.Context, subject string, scopes string, params *GetPersonPropertiesParams, reqEditors ...RequestEditorFn) (*GetPersonPropertiesResp, error)
GetPersonPropertiesWithResponse request returning *GetPersonPropertiesResp
func (*ClientWithResponses) GetRequestWithResponse ¶
func (c *ClientWithResponses) GetRequestWithResponse(ctx context.Context, requestID string, reqEditors ...RequestEditorFn) (*GetRequestResp, error)
GetRequestWithResponse request returning *GetRequestResp
func (*ClientWithResponses) GetSlackRequestDetailsWithResponse ¶ added in v0.1.17
func (c *ClientWithResponses) GetSlackRequestDetailsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetSlackRequestDetailsResp, error)
GetSlackRequestDetailsWithResponse request returning *GetSlackRequestDetailsResp
func (*ClientWithResponses) InviteOrgMemberWithBodyWithResponse ¶
func (c *ClientWithResponses) InviteOrgMemberWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*InviteOrgMemberResp, error)
InviteOrgMemberWithBodyWithResponse request with arbitrary body returning *InviteOrgMemberResp
func (*ClientWithResponses) InviteOrgMemberWithResponse ¶
func (c *ClientWithResponses) InviteOrgMemberWithResponse(ctx context.Context, body InviteOrgMemberJSONRequestBody, reqEditors ...RequestEditorFn) (*InviteOrgMemberResp, error)
func (*ClientWithResponses) ListAPIKeysWithResponse ¶
func (c *ClientWithResponses) ListAPIKeysWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListAPIKeysResp, error)
ListAPIKeysWithResponse request returning *ListAPIKeysResp
func (*ClientWithResponses) ListAccountsWithResponse ¶
func (c *ClientWithResponses) ListAccountsWithResponse(ctx context.Context, params *ListAccountsParams, reqEditors ...RequestEditorFn) (*ListAccountsResp, error)
ListAccountsWithResponse request returning *ListAccountsResp
func (*ClientWithResponses) ListAuditEventsWithResponse ¶ added in v0.1.15
func (c *ClientWithResponses) ListAuditEventsWithResponse(ctx context.Context, params *ListAuditEventsParams, reqEditors ...RequestEditorFn) (*ListAuditEventsResp, error)
ListAuditEventsWithResponse request returning *ListAuditEventsResp
func (*ClientWithResponses) ListDirectoriesWithResponse ¶
func (c *ClientWithResponses) ListDirectoriesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListDirectoriesResp, error)
ListDirectoriesWithResponse request returning *ListDirectoriesResp
func (*ClientWithResponses) ListEnvRequestsWithResponse ¶
func (c *ClientWithResponses) ListEnvRequestsWithResponse(ctx context.Context, env string, params *ListEnvRequestsParams, reqEditors ...RequestEditorFn) (*ListEnvRequestsResp, error)
ListEnvRequestsWithResponse request returning *ListEnvRequestsResp
func (*ClientWithResponses) ListEnvsWithResponse ¶
func (c *ClientWithResponses) ListEnvsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListEnvsResp, error)
ListEnvsWithResponse request returning *ListEnvsResp
func (*ClientWithResponses) ListOrgMembersWithResponse ¶
func (c *ClientWithResponses) ListOrgMembersWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListOrgMembersResp, error)
ListOrgMembersWithResponse request returning *ListOrgMembersResp
func (*ClientWithResponses) ListSlackIntegrationsWithResponse ¶ added in v0.1.17
func (c *ClientWithResponses) ListSlackIntegrationsWithResponse(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*ListSlackIntegrationsResp, error)
ListSlackIntegrationsWithResponse request returning *ListSlackIntegrationsResp
func (*ClientWithResponses) ListWebhooksWithResponse ¶
func (c *ClientWithResponses) ListWebhooksWithResponse(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*ListWebhooksResp, error)
ListWebhooksWithResponse request returning *ListWebhooksResp
func (*ClientWithResponses) Oauth2AuthorizeIframeWithResponse ¶
func (c *ClientWithResponses) Oauth2AuthorizeIframeWithResponse(ctx context.Context, params *Oauth2AuthorizeIframeParams, reqEditors ...RequestEditorFn) (*Oauth2AuthorizeIframeResp, error)
Oauth2AuthorizeIframeWithResponse request returning *Oauth2AuthorizeIframeResp
func (*ClientWithResponses) Oauth2AuthorizeWithExperienceWithResponse ¶
func (c *ClientWithResponses) Oauth2AuthorizeWithExperienceWithResponse(ctx context.Context, experience string, params *Oauth2AuthorizeWithExperienceParams, reqEditors ...RequestEditorFn) (*Oauth2AuthorizeWithExperienceResp, error)
Oauth2AuthorizeWithExperienceWithResponse request returning *Oauth2AuthorizeWithExperienceResp
func (*ClientWithResponses) Oauth2AuthorizeWithRequestAndExperienceWithResponse ¶
func (c *ClientWithResponses) Oauth2AuthorizeWithRequestAndExperienceWithResponse(ctx context.Context, experience string, requestID string, params *Oauth2AuthorizeWithRequestAndExperienceParams, reqEditors ...RequestEditorFn) (*Oauth2AuthorizeWithRequestAndExperienceResp, error)
Oauth2AuthorizeWithRequestAndExperienceWithResponse request returning *Oauth2AuthorizeWithRequestAndExperienceResp
func (*ClientWithResponses) Oauth2AuthorizeWithRequestWithResponse ¶
func (c *ClientWithResponses) Oauth2AuthorizeWithRequestWithResponse(ctx context.Context, requestID string, params *Oauth2AuthorizeWithRequestParams, reqEditors ...RequestEditorFn) (*Oauth2AuthorizeWithRequestResp, error)
Oauth2AuthorizeWithRequestWithResponse request returning *Oauth2AuthorizeWithRequestResp
func (*ClientWithResponses) Oauth2AuthorizeWithResponse ¶
func (c *ClientWithResponses) Oauth2AuthorizeWithResponse(ctx context.Context, params *Oauth2AuthorizeParams, reqEditors ...RequestEditorFn) (*Oauth2AuthorizeResp, error)
Oauth2AuthorizeWithResponse request returning *Oauth2AuthorizeResp
func (*ClientWithResponses) Oauth2CancelWithResponse ¶
func (c *ClientWithResponses) Oauth2CancelWithResponse(ctx context.Context, requestID string, params *Oauth2CancelParams, reqEditors ...RequestEditorFn) (*Oauth2CancelResp, error)
Oauth2CancelWithResponse request returning *Oauth2CancelResp
func (*ClientWithResponses) Oauth2LogoutWithResponse ¶
func (c *ClientWithResponses) Oauth2LogoutWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*Oauth2LogoutResp, error)
Oauth2LogoutWithResponse request returning *Oauth2LogoutResp
func (*ClientWithResponses) Oauth2PollWithResponse ¶
func (c *ClientWithResponses) Oauth2PollWithResponse(ctx context.Context, requestID string, params *Oauth2PollParams, reqEditors ...RequestEditorFn) (*Oauth2PollResp, error)
Oauth2PollWithResponse request returning *Oauth2PollResp
func (*ClientWithResponses) Oauth2TokenWithBodyWithResponse ¶
func (c *ClientWithResponses) Oauth2TokenWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*Oauth2TokenResp, error)
Oauth2TokenWithBodyWithResponse request with arbitrary body returning *Oauth2TokenResp
func (*ClientWithResponses) Oauth2TokenWithFormdataBodyWithResponse ¶
func (c *ClientWithResponses) Oauth2TokenWithFormdataBodyWithResponse(ctx context.Context, body Oauth2TokenFormdataRequestBody, reqEditors ...RequestEditorFn) (*Oauth2TokenResp, error)
func (*ClientWithResponses) PresignRecoveryMicrositeURLWithBodyWithResponse ¶ added in v0.1.12
func (c *ClientWithResponses) PresignRecoveryMicrositeURLWithBodyWithResponse(ctx context.Context, env string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PresignRecoveryMicrositeURLResp, error)
PresignRecoveryMicrositeURLWithBodyWithResponse request with arbitrary body returning *PresignRecoveryMicrositeURLResp
func (*ClientWithResponses) PresignRecoveryMicrositeURLWithResponse ¶ added in v0.1.12
func (c *ClientWithResponses) PresignRecoveryMicrositeURLWithResponse(ctx context.Context, env string, body PresignRecoveryMicrositeURLJSONRequestBody, reqEditors ...RequestEditorFn) (*PresignRecoveryMicrositeURLResp, error)
func (*ClientWithResponses) RefreshWebhookSecretWithBodyWithResponse ¶ added in v0.1.12
func (c *ClientWithResponses) RefreshWebhookSecretWithBodyWithResponse(ctx context.Context, env string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RefreshWebhookSecretResp, error)
RefreshWebhookSecretWithBodyWithResponse request with arbitrary body returning *RefreshWebhookSecretResp
func (*ClientWithResponses) RefreshWebhookSecretWithResponse ¶ added in v0.1.12
func (c *ClientWithResponses) RefreshWebhookSecretWithResponse(ctx context.Context, env string, body RefreshWebhookSecretJSONRequestBody, reqEditors ...RequestEditorFn) (*RefreshWebhookSecretResp, error)
func (*ClientWithResponses) RegenerateDirectoryAgentTokenWithResponse ¶ added in v0.1.16
func (c *ClientWithResponses) RegenerateDirectoryAgentTokenWithResponse(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*RegenerateDirectoryAgentTokenResp, error)
RegenerateDirectoryAgentTokenWithResponse request returning *RegenerateDirectoryAgentTokenResp
func (*ClientWithResponses) RemoveOrgMemberWithResponse ¶
func (c *ClientWithResponses) RemoveOrgMemberWithResponse(ctx context.Context, member string, reqEditors ...RequestEditorFn) (*RemoveOrgMemberResp, error)
RemoveOrgMemberWithResponse request returning *RemoveOrgMemberResp
func (*ClientWithResponses) SetDirectoryCredentialsWithBodyWithResponse ¶
func (c *ClientWithResponses) SetDirectoryCredentialsWithBodyWithResponse(ctx context.Context, directory string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetDirectoryCredentialsResp, error)
SetDirectoryCredentialsWithBodyWithResponse request with arbitrary body returning *SetDirectoryCredentialsResp
func (*ClientWithResponses) SetDirectoryCredentialsWithResponse ¶
func (c *ClientWithResponses) SetDirectoryCredentialsWithResponse(ctx context.Context, directory string, body SetDirectoryCredentialsJSONRequestBody, reqEditors ...RequestEditorFn) (*SetDirectoryCredentialsResp, error)
func (*ClientWithResponses) SyncDirectoryWithResponse ¶
func (c *ClientWithResponses) SyncDirectoryWithResponse(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*SyncDirectoryResp, error)
SyncDirectoryWithResponse request returning *SyncDirectoryResp
func (*ClientWithResponses) UpdateAPIKeyWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateAPIKeyWithBodyWithResponse(ctx context.Context, apiKey string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAPIKeyResp, error)
UpdateAPIKeyWithBodyWithResponse request with arbitrary body returning *UpdateAPIKeyResp
func (*ClientWithResponses) UpdateAPIKeyWithResponse ¶
func (c *ClientWithResponses) UpdateAPIKeyWithResponse(ctx context.Context, apiKey string, body UpdateAPIKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAPIKeyResp, error)
func (*ClientWithResponses) UpdateAccountWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateAccountWithBodyWithResponse(ctx context.Context, account string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAccountResp, error)
UpdateAccountWithBodyWithResponse request with arbitrary body returning *UpdateAccountResp
func (*ClientWithResponses) UpdateAccountWithResponse ¶
func (c *ClientWithResponses) UpdateAccountWithResponse(ctx context.Context, account string, body UpdateAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAccountResp, error)
func (*ClientWithResponses) UpdateDirectoryWithBodyWithResponse ¶ added in v0.1.12
func (c *ClientWithResponses) UpdateDirectoryWithBodyWithResponse(ctx context.Context, directory string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDirectoryResp, error)
UpdateDirectoryWithBodyWithResponse request with arbitrary body returning *UpdateDirectoryResp
func (*ClientWithResponses) UpdateDirectoryWithResponse ¶ added in v0.1.12
func (c *ClientWithResponses) UpdateDirectoryWithResponse(ctx context.Context, directory string, body UpdateDirectoryJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDirectoryResp, error)
func (*ClientWithResponses) UpdateEnvWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateEnvWithBodyWithResponse(ctx context.Context, env string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateEnvResp, error)
UpdateEnvWithBodyWithResponse request with arbitrary body returning *UpdateEnvResp
func (*ClientWithResponses) UpdateEnvWithResponse ¶
func (c *ClientWithResponses) UpdateEnvWithResponse(ctx context.Context, env string, body UpdateEnvJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateEnvResp, error)
func (*ClientWithResponses) UpdateOrgMemberWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateOrgMemberWithBodyWithResponse(ctx context.Context, member string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateOrgMemberResp, error)
UpdateOrgMemberWithBodyWithResponse request with arbitrary body returning *UpdateOrgMemberResp
func (*ClientWithResponses) UpdateOrgMemberWithResponse ¶
func (c *ClientWithResponses) UpdateOrgMemberWithResponse(ctx context.Context, member string, body UpdateOrgMemberJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateOrgMemberResp, error)
func (*ClientWithResponses) UpdateOrgWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateOrgWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateOrgResp, error)
UpdateOrgWithBodyWithResponse request with arbitrary body returning *UpdateOrgResp
func (*ClientWithResponses) UpdateOrgWithResponse ¶
func (c *ClientWithResponses) UpdateOrgWithResponse(ctx context.Context, body UpdateOrgJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateOrgResp, error)
func (*ClientWithResponses) UpdateRequestWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateRequestWithBodyWithResponse(ctx context.Context, requestID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateRequestResp, error)
UpdateRequestWithBodyWithResponse request with arbitrary body returning *UpdateRequestResp
func (*ClientWithResponses) UpdateRequestWithResponse ¶
func (c *ClientWithResponses) UpdateRequestWithResponse(ctx context.Context, requestID string, body UpdateRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateRequestResp, error)
func (*ClientWithResponses) UpdateTemplateWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateTemplateWithBodyWithResponse(ctx context.Context, env string, template string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateTemplateResp, error)
UpdateTemplateWithBodyWithResponse request with arbitrary body returning *UpdateTemplateResp
func (*ClientWithResponses) UpdateTemplateWithResponse ¶
func (c *ClientWithResponses) UpdateTemplateWithResponse(ctx context.Context, env string, template string, body UpdateTemplateJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateTemplateResp, error)
func (*ClientWithResponses) UploadAccountPhotoWithBodyWithResponse ¶
func (c *ClientWithResponses) UploadAccountPhotoWithBodyWithResponse(ctx context.Context, account string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UploadAccountPhotoResp, error)
UploadAccountPhotoWithBodyWithResponse request with arbitrary body returning *UploadAccountPhotoResp
func (*ClientWithResponses) UploadDirectoryLogoWithBodyWithResponse ¶ added in v0.1.16
func (c *ClientWithResponses) UploadDirectoryLogoWithBodyWithResponse(ctx context.Context, directory string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UploadDirectoryLogoResp, error)
UploadDirectoryLogoWithBodyWithResponse request with arbitrary body returning *UploadDirectoryLogoResp
func (*ClientWithResponses) UploadLogoWithBodyWithResponse ¶
func (c *ClientWithResponses) UploadLogoWithBodyWithResponse(ctx context.Context, env string, params *UploadLogoParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UploadLogoResp, error)
UploadLogoWithBodyWithResponse request with arbitrary body returning *UploadLogoResp
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface {
// BulkUploadAccountPhotosWithBodyWithResponse request with any body
BulkUploadAccountPhotosWithBodyWithResponse(ctx context.Context, params *BulkUploadAccountPhotosParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BulkUploadAccountPhotosResp, error)
// ListAccountsWithResponse request
ListAccountsWithResponse(ctx context.Context, params *ListAccountsParams, reqEditors ...RequestEditorFn) (*ListAccountsResp, error)
// BulkUpdateAccountsWithBodyWithResponse request with any body
BulkUpdateAccountsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BulkUpdateAccountsResp, error)
BulkUpdateAccountsWithResponse(ctx context.Context, body BulkUpdateAccountsJSONRequestBody, reqEditors ...RequestEditorFn) (*BulkUpdateAccountsResp, error)
// GetAccountWithResponse request
GetAccountWithResponse(ctx context.Context, account string, reqEditors ...RequestEditorFn) (*GetAccountResp, error)
// UpdateAccountWithBodyWithResponse request with any body
UpdateAccountWithBodyWithResponse(ctx context.Context, account string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAccountResp, error)
UpdateAccountWithResponse(ctx context.Context, account string, body UpdateAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAccountResp, error)
// UploadAccountPhotoWithBodyWithResponse request with any body
UploadAccountPhotoWithBodyWithResponse(ctx context.Context, account string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UploadAccountPhotoResp, error)
// ListAPIKeysWithResponse request
ListAPIKeysWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListAPIKeysResp, error)
// CreateAPIKeyWithBodyWithResponse request with any body
CreateAPIKeyWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateAPIKeyResp, error)
CreateAPIKeyWithResponse(ctx context.Context, body CreateAPIKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateAPIKeyResp, error)
// DeleteAPIKeyWithResponse request
DeleteAPIKeyWithResponse(ctx context.Context, apiKey string, reqEditors ...RequestEditorFn) (*DeleteAPIKeyResp, error)
// GetAPIKeyWithResponse request
GetAPIKeyWithResponse(ctx context.Context, apiKey string, reqEditors ...RequestEditorFn) (*GetAPIKeyResp, error)
// UpdateAPIKeyWithBodyWithResponse request with any body
UpdateAPIKeyWithBodyWithResponse(ctx context.Context, apiKey string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAPIKeyResp, error)
UpdateAPIKeyWithResponse(ctx context.Context, apiKey string, body UpdateAPIKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAPIKeyResp, error)
// ListAuditEventsWithResponse request
ListAuditEventsWithResponse(ctx context.Context, params *ListAuditEventsParams, reqEditors ...RequestEditorFn) (*ListAuditEventsResp, error)
// Oauth2CancelWithResponse request
Oauth2CancelWithResponse(ctx context.Context, requestID string, params *Oauth2CancelParams, reqEditors ...RequestEditorFn) (*Oauth2CancelResp, error)
// Oauth2PollWithResponse request
Oauth2PollWithResponse(ctx context.Context, requestID string, params *Oauth2PollParams, reqEditors ...RequestEditorFn) (*Oauth2PollResp, error)
// ListDirectoriesWithResponse request
ListDirectoriesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListDirectoriesResp, error)
// CreateDirectoryWithBodyWithResponse request with any body
CreateDirectoryWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDirectoryResp, error)
CreateDirectoryWithResponse(ctx context.Context, body CreateDirectoryJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateDirectoryResp, error)
// DeleteDirectoryWithResponse request
DeleteDirectoryWithResponse(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*DeleteDirectoryResp, error)
// GetDirectoryWithResponse request
GetDirectoryWithResponse(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*GetDirectoryResp, error)
// UpdateDirectoryWithBodyWithResponse request with any body
UpdateDirectoryWithBodyWithResponse(ctx context.Context, directory string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDirectoryResp, error)
UpdateDirectoryWithResponse(ctx context.Context, directory string, body UpdateDirectoryJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDirectoryResp, error)
// GetDirectoryAuthorizationURLWithResponse request
GetDirectoryAuthorizationURLWithResponse(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*GetDirectoryAuthorizationURLResp, error)
// SetDirectoryCredentialsWithBodyWithResponse request with any body
SetDirectoryCredentialsWithBodyWithResponse(ctx context.Context, directory string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetDirectoryCredentialsResp, error)
SetDirectoryCredentialsWithResponse(ctx context.Context, directory string, body SetDirectoryCredentialsJSONRequestBody, reqEditors ...RequestEditorFn) (*SetDirectoryCredentialsResp, error)
// DeleteDirectoryLogoWithResponse request
DeleteDirectoryLogoWithResponse(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*DeleteDirectoryLogoResp, error)
// UploadDirectoryLogoWithBodyWithResponse request with any body
UploadDirectoryLogoWithBodyWithResponse(ctx context.Context, directory string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UploadDirectoryLogoResp, error)
// RegenerateDirectoryAgentTokenWithResponse request
RegenerateDirectoryAgentTokenWithResponse(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*RegenerateDirectoryAgentTokenResp, error)
// SyncDirectoryWithResponse request
SyncDirectoryWithResponse(ctx context.Context, directory string, reqEditors ...RequestEditorFn) (*SyncDirectoryResp, error)
// ListEnvsWithResponse request
ListEnvsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListEnvsResp, error)
// CreateEnvWithBodyWithResponse request with any body
CreateEnvWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateEnvResp, error)
CreateEnvWithResponse(ctx context.Context, body CreateEnvJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateEnvResp, error)
// DeleteEnvWithResponse request
DeleteEnvWithResponse(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*DeleteEnvResp, error)
// GetEnvWithResponse request
GetEnvWithResponse(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*GetEnvResp, error)
// UpdateEnvWithBodyWithResponse request with any body
UpdateEnvWithBodyWithResponse(ctx context.Context, env string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateEnvResp, error)
UpdateEnvWithResponse(ctx context.Context, env string, body UpdateEnvJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateEnvResp, error)
// EncryptSecretWithBodyWithResponse request with any body
EncryptSecretWithBodyWithResponse(ctx context.Context, env string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*EncryptSecretResp, error)
EncryptSecretWithResponse(ctx context.Context, env string, body EncryptSecretJSONRequestBody, reqEditors ...RequestEditorFn) (*EncryptSecretResp, error)
// DeleteLogoWithResponse request
DeleteLogoWithResponse(ctx context.Context, env string, params *DeleteLogoParams, reqEditors ...RequestEditorFn) (*DeleteLogoResp, error)
// UploadLogoWithBodyWithResponse request with any body
UploadLogoWithBodyWithResponse(ctx context.Context, env string, params *UploadLogoParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UploadLogoResp, error)
// GetEnvMicrometricsWithResponse request
GetEnvMicrometricsWithResponse(ctx context.Context, env string, params *GetEnvMicrometricsParams, reqEditors ...RequestEditorFn) (*GetEnvMicrometricsResp, error)
// PresignRecoveryMicrositeURLWithBodyWithResponse request with any body
PresignRecoveryMicrositeURLWithBodyWithResponse(ctx context.Context, env string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PresignRecoveryMicrositeURLResp, error)
PresignRecoveryMicrositeURLWithResponse(ctx context.Context, env string, body PresignRecoveryMicrositeURLJSONRequestBody, reqEditors ...RequestEditorFn) (*PresignRecoveryMicrositeURLResp, error)
// RefreshWebhookSecretWithBodyWithResponse request with any body
RefreshWebhookSecretWithBodyWithResponse(ctx context.Context, env string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RefreshWebhookSecretResp, error)
RefreshWebhookSecretWithResponse(ctx context.Context, env string, body RefreshWebhookSecretJSONRequestBody, reqEditors ...RequestEditorFn) (*RefreshWebhookSecretResp, error)
// ListEnvRequestsWithResponse request
ListEnvRequestsWithResponse(ctx context.Context, env string, params *ListEnvRequestsParams, reqEditors ...RequestEditorFn) (*ListEnvRequestsResp, error)
// GetEnvRequestWithResponse request
GetEnvRequestWithResponse(ctx context.Context, env string, requestID string, reqEditors ...RequestEditorFn) (*GetEnvRequestResp, error)
// ListSlackIntegrationsWithResponse request
ListSlackIntegrationsWithResponse(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*ListSlackIntegrationsResp, error)
// DeleteSlackIntegrationWithResponse request
DeleteSlackIntegrationWithResponse(ctx context.Context, env string, integration string, reqEditors ...RequestEditorFn) (*DeleteSlackIntegrationResp, error)
// CreateTemplateWithBodyWithResponse request with any body
CreateTemplateWithBodyWithResponse(ctx context.Context, env string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateTemplateResp, error)
CreateTemplateWithResponse(ctx context.Context, env string, body CreateTemplateJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateTemplateResp, error)
// DeleteTemplateWithResponse request
DeleteTemplateWithResponse(ctx context.Context, env string, template string, reqEditors ...RequestEditorFn) (*DeleteTemplateResp, error)
// UpdateTemplateWithBodyWithResponse request with any body
UpdateTemplateWithBodyWithResponse(ctx context.Context, env string, template string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateTemplateResp, error)
UpdateTemplateWithResponse(ctx context.Context, env string, template string, body UpdateTemplateJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateTemplateResp, error)
// ListWebhooksWithResponse request
ListWebhooksWithResponse(ctx context.Context, env string, reqEditors ...RequestEditorFn) (*ListWebhooksResp, error)
// GetSlackRequestDetailsWithResponse request
GetSlackRequestDetailsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetSlackRequestDetailsResp, error)
// GetOrgWithResponse request
GetOrgWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetOrgResp, error)
// UpdateOrgWithBodyWithResponse request with any body
UpdateOrgWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateOrgResp, error)
UpdateOrgWithResponse(ctx context.Context, body UpdateOrgJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateOrgResp, error)
// ListOrgMembersWithResponse request
ListOrgMembersWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListOrgMembersResp, error)
// InviteOrgMemberWithBodyWithResponse request with any body
InviteOrgMemberWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*InviteOrgMemberResp, error)
InviteOrgMemberWithResponse(ctx context.Context, body InviteOrgMemberJSONRequestBody, reqEditors ...RequestEditorFn) (*InviteOrgMemberResp, error)
// RemoveOrgMemberWithResponse request
RemoveOrgMemberWithResponse(ctx context.Context, member string, reqEditors ...RequestEditorFn) (*RemoveOrgMemberResp, error)
// UpdateOrgMemberWithBodyWithResponse request with any body
UpdateOrgMemberWithBodyWithResponse(ctx context.Context, member string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateOrgMemberResp, error)
UpdateOrgMemberWithResponse(ctx context.Context, member string, body UpdateOrgMemberJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateOrgMemberResp, error)
// CreateRequestWithBodyWithResponse request with any body
CreateRequestWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateRequestResp, error)
CreateRequestWithResponse(ctx context.Context, body CreateRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateRequestResp, error)
// CancelRequestWithResponse request
CancelRequestWithResponse(ctx context.Context, requestID string, reqEditors ...RequestEditorFn) (*CancelRequestResp, error)
// GetRequestWithResponse request
GetRequestWithResponse(ctx context.Context, requestID string, reqEditors ...RequestEditorFn) (*GetRequestResp, error)
// UpdateRequestWithBodyWithResponse request with any body
UpdateRequestWithBodyWithResponse(ctx context.Context, requestID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateRequestResp, error)
UpdateRequestWithResponse(ctx context.Context, requestID string, body UpdateRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateRequestResp, error)
// Oauth2AuthorizeWithResponse request
Oauth2AuthorizeWithResponse(ctx context.Context, params *Oauth2AuthorizeParams, reqEditors ...RequestEditorFn) (*Oauth2AuthorizeResp, error)
// Oauth2AuthorizeIframeWithResponse request
Oauth2AuthorizeIframeWithResponse(ctx context.Context, params *Oauth2AuthorizeIframeParams, reqEditors ...RequestEditorFn) (*Oauth2AuthorizeIframeResp, error)
// Oauth2AuthorizeWithRequestWithResponse request
Oauth2AuthorizeWithRequestWithResponse(ctx context.Context, requestID string, params *Oauth2AuthorizeWithRequestParams, reqEditors ...RequestEditorFn) (*Oauth2AuthorizeWithRequestResp, error)
// Oauth2LogoutWithResponse request
Oauth2LogoutWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*Oauth2LogoutResp, error)
// GetBulkPeoplePropertiesWithBodyWithResponse request with any body
GetBulkPeoplePropertiesWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*GetBulkPeoplePropertiesResp, error)
GetBulkPeoplePropertiesWithResponse(ctx context.Context, body GetBulkPeoplePropertiesJSONRequestBody, reqEditors ...RequestEditorFn) (*GetBulkPeoplePropertiesResp, error)
// ComparePeopleWithBodyWithResponse request with any body
ComparePeopleWithBodyWithResponse(ctx context.Context, subject string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ComparePeopleResp, error)
ComparePeopleWithResponse(ctx context.Context, subject string, body ComparePeopleJSONRequestBody, reqEditors ...RequestEditorFn) (*ComparePeopleResp, error)
// CompareSelfieWithBodyWithResponse request with any body
CompareSelfieWithBodyWithResponse(ctx context.Context, subject string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CompareSelfieResp, error)
// DeletePersonPropertiesWithResponse request
DeletePersonPropertiesWithResponse(ctx context.Context, subject string, scopes string, params *DeletePersonPropertiesParams, reqEditors ...RequestEditorFn) (*DeletePersonPropertiesResp, error)
// GetPersonPropertiesWithResponse request
GetPersonPropertiesWithResponse(ctx context.Context, subject string, scopes string, params *GetPersonPropertiesParams, reqEditors ...RequestEditorFn) (*GetPersonPropertiesResp, error)
// Oauth2TokenWithBodyWithResponse request with any body
Oauth2TokenWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*Oauth2TokenResp, error)
Oauth2TokenWithFormdataBodyWithResponse(ctx context.Context, body Oauth2TokenFormdataRequestBody, reqEditors ...RequestEditorFn) (*Oauth2TokenResp, error)
// Oauth2AuthorizeWithExperienceWithResponse request
Oauth2AuthorizeWithExperienceWithResponse(ctx context.Context, experience string, params *Oauth2AuthorizeWithExperienceParams, reqEditors ...RequestEditorFn) (*Oauth2AuthorizeWithExperienceResp, error)
// Oauth2AuthorizeWithRequestAndExperienceWithResponse request
Oauth2AuthorizeWithRequestAndExperienceWithResponse(ctx context.Context, experience string, requestID string, params *Oauth2AuthorizeWithRequestAndExperienceParams, reqEditors ...RequestEditorFn) (*Oauth2AuthorizeWithRequestAndExperienceResp, error)
}
ClientWithResponsesInterface is the interface specification for the client with responses above.
type ComparePeopleJSONRequestBody ¶
type ComparePeopleJSONRequestBody = SubjectComparisonRequest
ComparePeopleJSONRequestBody defines body for ComparePeople for application/json ContentType.
type ComparePeopleResp ¶
type ComparePeopleResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ComparisonResult
JSON400 *N400
}
func ParseComparePeopleResp ¶
func ParseComparePeopleResp(rsp *http.Response) (*ComparePeopleResp, error)
ParseComparePeopleResp parses an HTTP response from a ComparePeopleWithResponse call
func (ComparePeopleResp) Status ¶
func (r ComparePeopleResp) Status() string
Status returns HTTPResponse.Status
func (ComparePeopleResp) StatusCode ¶
func (r ComparePeopleResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CompareSelfieResp ¶
type CompareSelfieResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *CompareSelfieResult
JSON400 *N400
}
func ParseCompareSelfieResp ¶
func ParseCompareSelfieResp(rsp *http.Response) (*CompareSelfieResp, error)
ParseCompareSelfieResp parses an HTTP response from a CompareSelfieWithResponse call
func (CompareSelfieResp) Status ¶
func (r CompareSelfieResp) Status() string
Status returns HTTPResponse.Status
func (CompareSelfieResp) StatusCode ¶
func (r CompareSelfieResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CompareSelfieResult ¶
type CompareSelfieResult struct {
// Match True if the `match_confidence` exceeds Nametag's recommended threshold for a match, false otherwise.
Match bool `json:"match"`
// Confidence A number between 0 and 1 that represents Nametag's confidence that the values match. A value of 1 means Nametag is very confident that the values match, while 0 means that the values do not match at all.
Confidence float64 `json:"confidence"`
// NoFace The photo provided does not contain a person's face.
NoFace *bool `json:"no_face,omitempty"`
// NotMatched The face in the photo provided does not match any of the selfies on file for this person.
NotMatched *bool `json:"not_matched,omitempty"`
// MultipleFaces The photo provided contains more than one face.
MultipleFaces *bool `json:"multiple_faces,omitempty"`
EmployeeBadge *EmployeeBadgeValidationResult `json:"employee_badge,omitempty"`
}
CompareSelfieResult defines model for CompareSelfieResult.
type Comparison ¶
type Comparison struct {
// Scope Scopes are used to describe the information you want people to share with you. In order to request a scope you must first define it in your environment and provide additional parameters, such as what type of data and how long you need the data. This is done separately for each environment you manage in the Nametag console.
Scope *Scope `json:"scope,omitempty"`
// Claim Claims are used to describe the information you want people to share with you. In order to request a claim you must first define it in your environment and provide additional parameters, such as what type of data and how long you need the data. This is done separately for each environment you manage in the Nametag console.
Claim Claim `json:"claim"`
// Expected The expected value for this claim.
Expected string `json:"expected"`
// Actual The actual value for this claim.
Actual string `json:"actual"`
// Match True if the `match_confidence` exceeds Nametag's recommended threshold for a match, false otherwise.
Match bool `json:"match"`
// MatchConfidence A number between 0 and 1 that represents Nametag's confidence that the values match. A value of 1 means Nametag is very confident that the values match, while 0 means that the values do not match at all.
MatchConfidence float64 `json:"match_confidence"`
}
Comparison defines model for Comparison.
type ComparisonResult ¶
type ComparisonResult struct {
// Confidence A number between 0 and 1 that represents Nametag's confidence that the value matches the expected value. A value of 1 means Nametag is very confident that the values match, while 0 means that the values do not match at all.
Confidence float64 `json:"confidence"`
// Comparisons A list of comparisons between the expected and actual values.
Comparisons []Comparison `json:"comparisons"`
}
ComparisonResult defines model for ComparisonResult.
type ConsoleSigninAuditEvent ¶ added in v0.1.15
type ConsoleSigninAuditEvent struct {
// Email True if the user authenticated via email
Email *bool `json:"email,omitempty"`
// Nametag True if the user authenticated via Nametag (deprecated)
Nametag *bool `json:"nametag,omitempty"`
// RelayState If the user authenticated via SAML, the RelayState parameter
RelayState *string `json:"relay_state,omitempty"`
// SAML True if the user authenticated via SAML
SAML *bool `json:"saml,omitempty"`
// SAMLResponse If the user authenticated via SAML, the RelayState parameter
SAMLResponse *string `json:"saml_response,omitempty"`
}
ConsoleSigninAuditEvent defines model for ConsoleSigninAuditEvent.
type ConsoleSinginConfigureEmailAuditEvent ¶ added in v0.1.15
type ConsoleSinginConfigureEmailAuditEvent struct {
Empty *bool `json:"empty,omitempty"`
}
ConsoleSinginConfigureEmailAuditEvent defines model for ConsoleSinginConfigureEmailAuditEvent.
type ConsoleSinginConfigureSAMLAuditEvent ¶ added in v0.1.15
type ConsoleSinginConfigureSAMLAuditEvent struct {
Empty *bool `json:"empty,omitempty"`
}
ConsoleSinginConfigureSAMLAuditEvent defines model for ConsoleSinginConfigureSAMLAuditEvent.
type CreateAPIKeyJSONRequestBody ¶
type CreateAPIKeyJSONRequestBody = CreateAPIKeyRequest
CreateAPIKeyJSONRequestBody defines body for CreateAPIKey for application/json ContentType.
type CreateAPIKeyRequest ¶
type CreateAPIKeyRequest struct {
// Name A descriptive name for the API key
Name string `json:"name,omitempty"`
// Enabled `true` if the API key is enabled, or `false` if it cannot be used.
Enabled bool `json:"enabled,omitempty"`
// EnvIDs The unique identifier for the environments this API key belongs to, or `["*"]` if the key applies to all environments.
EnvIDs []string `json:"envs"`
Role *Role `json:"role,omitempty"`
// ExpiresAt The expiration date and time for the API key. If not provided, the key will not expire. Example: "2023-12-31T23:59:59Z"
ExpiresAt *time.Time `json:"expires_at,omitempty"`
}
CreateAPIKeyRequest defines model for CreateAPIKeyRequest.
type CreateAPIKeyResp ¶
type CreateAPIKeyResp struct {
Body []byte
HTTPResponse *http.Response
JSON201 *CreateAPIKeyResponse
JSON400 *N400
}
func ParseCreateAPIKeyResp ¶
func ParseCreateAPIKeyResp(rsp *http.Response) (*CreateAPIKeyResp, error)
ParseCreateAPIKeyResp parses an HTTP response from a CreateAPIKeyWithResponse call
func (CreateAPIKeyResp) Status ¶
func (r CreateAPIKeyResp) Status() string
Status returns HTTPResponse.Status
func (CreateAPIKeyResp) StatusCode ¶
func (r CreateAPIKeyResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CreateAPIKeyResponse ¶
type CreateAPIKeyResponse struct {
// ID The unique identifier for the API key
ID string `json:"id"`
// Key The full secret API key
Key string `json:"key"`
}
CreateAPIKeyResponse defines model for CreateAPIKeyResponse.
type CreateDirectoryJSONRequestBody ¶
type CreateDirectoryJSONRequestBody = CreateDirectoryRequest
CreateDirectoryJSONRequestBody defines body for CreateDirectory for application/json ContentType.
type CreateDirectoryRequest ¶
type CreateDirectoryRequest struct {
// Env The ID of the environment to create this directory for
Env string `json:"env"`
// Kind The type of the directory connection.
Kind DirectoryKind `json:"kind"`
Credentials *Credentials `json:"credentials,omitempty"`
}
CreateDirectoryRequest defines model for CreateDirectoryRequest.
type CreateDirectoryResp ¶
type CreateDirectoryResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *CreateDirectoryResponse
JSON400 *N400
}
func ParseCreateDirectoryResp ¶
func ParseCreateDirectoryResp(rsp *http.Response) (*CreateDirectoryResp, error)
ParseCreateDirectoryResp parses an HTTP response from a CreateDirectoryWithResponse call
func (CreateDirectoryResp) Status ¶
func (r CreateDirectoryResp) Status() string
Status returns HTTPResponse.Status
func (CreateDirectoryResp) StatusCode ¶
func (r CreateDirectoryResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CreateDirectoryResponse ¶
type CreateDirectoryResponse struct {
AgentToken *string `json:"agent_token,omitempty"`
// ID The unique identifier for the directory.
ID string `json:"id"`
// RedirectURL The OAuth 2.0 redirect URL to authorize the directory.
//
// If the directory uses OAuth 2.0 for authorization (e.g. `"azure-ad"`), then
// this field contains the URL to redirect the user to authorize the directory.
RedirectURL *string `json:"redirect_url,omitempty"`
}
CreateDirectoryResponse defines model for CreateDirectoryResponse.
type CreateEnvJSONRequestBody ¶
type CreateEnvJSONRequestBody = CreateEnvRequest
CreateEnvJSONRequestBody defines body for CreateEnv for application/json ContentType.
type CreateEnvRequest ¶
type CreateEnvRequest = map[string]interface{}
CreateEnvRequest defines model for CreateEnvRequest.
type CreateEnvResp ¶
type CreateEnvResp struct {
Body []byte
HTTPResponse *http.Response
JSON201 *CreateEnvResponse
JSON400 *N400
}
func ParseCreateEnvResp ¶
func ParseCreateEnvResp(rsp *http.Response) (*CreateEnvResp, error)
ParseCreateEnvResp parses an HTTP response from a CreateEnvWithResponse call
func (CreateEnvResp) Status ¶
func (r CreateEnvResp) Status() string
Status returns HTTPResponse.Status
func (CreateEnvResp) StatusCode ¶
func (r CreateEnvResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CreateEnvResponse ¶
type CreateEnvResponse struct {
// ID The unique identifier of the environment
ID string `json:"id"`
}
CreateEnvResponse defines model for CreateEnvResponse.
type CreateRequestJSONRequestBody ¶
type CreateRequestJSONRequestBody = CreateRequestRequest
CreateRequestJSONRequestBody defines body for CreateRequest for application/json ContentType.
type CreateRequestRequest ¶
type CreateRequestRequest struct {
// EnvID The ID of the environment associated with the request.
EnvID string `json:"env"`
// Scopes A list of the information (scopes) that the request is asking for.
// If you specify `template`, you must not specify `scopes`.
Scopes []Scope `json:"scopes,omitempty"`
// Claims A list of the information (claims) that the request is asking for.
// > **Note**: This field is required unless `template` is specified.
Claims []Claim `json:"claims,omitempty"`
// Template The name of a template that customizes how the request is presented to the user.
//
// Because a template contains its own claim definitions, you can provide either `claims` or `template`; providing both results in an amalgamation of the two.
Template string `json:"template,omitempty"`
// ExpiresAt The last time this request will be valid. After this time, the request is expired and the user will no longer be able to complete it. This cannot be used with `ttl`.
ExpiresAt time.Time `json:"expires_at,omitempty"`
// Phone The phone number to which the request link should be sent.
Phone string `json:"phone,omitempty"`
// Whatsapp The WhatsApp phone number to which the request link should be sent.
Whatsapp string `json:"whatsapp,omitempty"`
// Label An internal label for this request. You can use this field to help you track the request in your own systems. Nametag stores this field, but does not process it at all.
Label string `json:"label,omitempty"`
}
CreateRequestRequest defines model for CreateRequestRequest.
type CreateRequestResp ¶
type CreateRequestResp struct {
Body []byte
HTTPResponse *http.Response
JSON201 *CreateRequestResponse
JSON400 *N400
}
func ParseCreateRequestResp ¶
func ParseCreateRequestResp(rsp *http.Response) (*CreateRequestResp, error)
ParseCreateRequestResp parses an HTTP response from a CreateRequestWithResponse call
func (CreateRequestResp) Status ¶
func (r CreateRequestResp) Status() string
Status returns HTTPResponse.Status
func (CreateRequestResp) StatusCode ¶
func (r CreateRequestResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CreateRequestResponse ¶
type CreateRequestResponse struct {
// ID A unique identifier for the request
ID string `json:"id"`
Status NumericRequestStatus `json:"status"`
// EnvID The ID of the environment associated with the request.
EnvID string `json:"env"`
// Scopes A list of the information (scopes) that the request is asking for.
Scopes []Scope `json:"scopes"`
// Claims A list of the information (claims) that the request is asking for.
Claims []Claim `json:"claims"`
// Template The name of a template that customizes how the request is presented to the user.
Template string `json:"template,omitempty"`
// Link An authorization link. Passing this link to the user will prompt them to complete the request.
Link string `json:"link"`
// Phone The phone number to which the request link was sent, in E.164 format.
Phone string `json:"phone,omitempty"`
// Label An internal label for this request. You can use this field to help you track the
// request in your own systems. Nametag stores this field, but does not process it at all.
Label string `json:"label,omitempty"`
// ExpiresAt The last time this request will be valid. After this time, the request is expired
// and the user will no longer be able to complete it.
ExpiresAt *time.Time `json:"expires_at,omitempty"`
}
CreateRequestResponse defines model for CreateRequestResponse.
type CreateTemplateJSONRequestBody ¶
type CreateTemplateJSONRequestBody = CreateTemplateRequest
CreateTemplateJSONRequestBody defines body for CreateTemplate for application/json ContentType.
type CreateTemplateRequest ¶
type CreateTemplateRequest struct {
// Name A descriptive name of the template
Name string `json:"name"`
// Headline The text that appears at the top of the mobile app when showing the request
Headline *string `json:"headline,omitempty"`
// QrHeadline The text that appears above the QR code when directing the user from desktop to mobile.
QrHeadline *string `json:"qr_headline,omitempty"`
// ExpirationText The text that describes when the request expires. This should include `{{.TTL}}` which is a placeholder for the expiration of the data sharing authorization in human-readable form, e.g. "3 hours"
ExpirationText *string `json:"expiration_text,omitempty"`
// AcceptText The text on the accept button in the mobile app.
AcceptText *string `json:"accept_text,omitempty"`
// AcceptedText The text that appears on the confirmation view after a request has been accepted.
AcceptedText *string `json:"accepted_text,omitempty"`
// InstallMessageSMS The contents of the SMS message sent to users to direct them to the mobile app. This must contain the `{{.Link}}` which is a placeholder for the actual link.
InstallMessageSMS *string `json:"install_message_sms,omitempty"`
// IsDefault If true then this is the default template used when a template is not explicitly specified. There must be exactly one default template.
IsDefault *bool `json:"is_default,omitempty"`
// ScopeDefinitions A list of scopes that are requested when requests are created with this template.
ScopeDefinitions []TemplateScopeDefinition `json:"scope_definitions,omitempty"`
// ScopesExpireIn How long the data sharing authorization should last, in seconds.
ScopesExpireIn *int `json:"scopes_expire_in,omitempty"`
// ClaimDefinitions A list of claims that are requested when requests are created with this template.
ClaimDefinitions []TemplateClaimDefinition `json:"claim_definitions,omitempty"`
// ClaimsExpireIn How long the data sharing authorization should last, in seconds.
ClaimsExpireIn *int `json:"claims_expire_in,omitempty"`
// Enabled If true, then this template is enabled for requests. The default template must be enabled.
Enabled *bool `json:"enabled,omitempty"`
// RequireSelfieReverification If true, existing users must provide a new selfie to validate their identity.
RequireSelfieReverification *bool `json:"require_selfie_reverification,omitempty"`
// QRCustomText The text that appears below the desktop QR page headline.
QRCustomText *string `json:"qr_custom_text,omitempty"`
}
CreateTemplateRequest defines model for CreateTemplateRequest.
type CreateTemplateResp ¶
type CreateTemplateResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *CreateTemplateResponse
JSON400 *N400
}
func ParseCreateTemplateResp ¶
func ParseCreateTemplateResp(rsp *http.Response) (*CreateTemplateResp, error)
ParseCreateTemplateResp parses an HTTP response from a CreateTemplateWithResponse call
func (CreateTemplateResp) Status ¶
func (r CreateTemplateResp) Status() string
Status returns HTTPResponse.Status
func (CreateTemplateResp) StatusCode ¶
func (r CreateTemplateResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CreateTemplateResponse ¶
type CreateTemplateResponse struct {
// ID The unique identifier of the template
ID string `json:"id"`
}
CreateTemplateResponse defines model for CreateTemplateResponse.
type Credentials ¶
type Credentials struct {
// Account * For Duo, the integration key
// * For Okta, this field should be blank
// * For Onelogin, the client ID, e.g. `98ea6e4f216f2fb4b69fff9b3a44842c38686ca685f3f55dc48c5d3fb1107be4`
// * For BeyondIdentity, the client ID, e.g. `Tf9IGY976IqEjEHJrYSJW7JF`
Account string `json:"account,omitempty"`
// ApplicationID * For Duo, this field should be blank
// * For Okta, this field should be blank
// * For Onelogin, this field should be blank
// * For BeyondIdentity, the application ID, e.g. `9f6b7c1e-2d44-4c2b-8c9f-3ab59e92c123`
ApplicationID string `json:"application_id,omitempty"`
// Partition * For Duo, the API hostname, e.g. `api-33091yc9.duosecurity.com`.
// * For Okta, the service hostname, e.g. `your-company.okta.com`.
// * For Onelogin, the subdomain, e.g. `example.onelogin.com`.
// * For BeyondIdentity, the BaseURL, e.g. `https://api-us.beyondidentity.com`.
Partition string `json:"partition"`
// RealmID * For Duo, this field should be blank
// * For Okta, this field should be blank
// * For Onelogin, this field should be blank
// * For BeyondIdentity, the realm ID, e.g. `8b4e3oxk01qwu19`
RealmID string `json:"realm_id,omitempty"`
// Secret * For Duo, the secret key, e.g. `cv9wJSC10XDFRGY5L9DcgHuNtR76vM8kuB1sDCpc`
// * For Okta, the API token, e.g. `21lgux-M8uJC4w-9kN_PL0ivV5tM81AvSd7l0IuAS3`
// * For Onelogin, the client secret, e.g. `f3d4bd80d4d4007be3455453819d3359f8a5eb2eb66fdbc7bae5e44083605118`
// * For BeyondIdentity, the client secret, e.g. `Y0p8Q~a1Bx3K-4lHnV9zYt2sA7jRkLmF5gS9xTqW`
Secret string `json:"secret"`
// TenantID * For Duo, this field should be blank
// * For Okta, this field should be blank
// * For Onelogin, this field should be blank
// * For BeyondIdentity, the tenant ID, e.g. `1124mn2az1yglqq`
TenantID string `json:"tenant_id,omitempty"`
}
Credentials defines model for Credentials.
type DeleteAPIKeyResp ¶
func ParseDeleteAPIKeyResp ¶
func ParseDeleteAPIKeyResp(rsp *http.Response) (*DeleteAPIKeyResp, error)
ParseDeleteAPIKeyResp parses an HTTP response from a DeleteAPIKeyWithResponse call
func (DeleteAPIKeyResp) Status ¶
func (r DeleteAPIKeyResp) Status() string
Status returns HTTPResponse.Status
func (DeleteAPIKeyResp) StatusCode ¶
func (r DeleteAPIKeyResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteDirectoryLogoResp ¶ added in v0.1.16
func ParseDeleteDirectoryLogoResp ¶ added in v0.1.16
func ParseDeleteDirectoryLogoResp(rsp *http.Response) (*DeleteDirectoryLogoResp, error)
ParseDeleteDirectoryLogoResp parses an HTTP response from a DeleteDirectoryLogoWithResponse call
func (DeleteDirectoryLogoResp) Status ¶ added in v0.1.16
func (r DeleteDirectoryLogoResp) Status() string
Status returns HTTPResponse.Status
func (DeleteDirectoryLogoResp) StatusCode ¶ added in v0.1.16
func (r DeleteDirectoryLogoResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteDirectoryResp ¶
func ParseDeleteDirectoryResp ¶
func ParseDeleteDirectoryResp(rsp *http.Response) (*DeleteDirectoryResp, error)
ParseDeleteDirectoryResp parses an HTTP response from a DeleteDirectoryWithResponse call
func (DeleteDirectoryResp) Status ¶
func (r DeleteDirectoryResp) Status() string
Status returns HTTPResponse.Status
func (DeleteDirectoryResp) StatusCode ¶
func (r DeleteDirectoryResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteEnvResp ¶
func ParseDeleteEnvResp ¶
func ParseDeleteEnvResp(rsp *http.Response) (*DeleteEnvResp, error)
ParseDeleteEnvResp parses an HTTP response from a DeleteEnvWithResponse call
func (DeleteEnvResp) Status ¶
func (r DeleteEnvResp) Status() string
Status returns HTTPResponse.Status
func (DeleteEnvResp) StatusCode ¶
func (r DeleteEnvResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteLogoParams ¶
type DeleteLogoParams struct {
// Kind The kind of logo to remove
Kind LogoKind `form:"kind" json:"kind"`
}
DeleteLogoParams defines parameters for DeleteLogo.
type DeleteLogoResp ¶
func ParseDeleteLogoResp ¶
func ParseDeleteLogoResp(rsp *http.Response) (*DeleteLogoResp, error)
ParseDeleteLogoResp parses an HTTP response from a DeleteLogoWithResponse call
func (DeleteLogoResp) Status ¶
func (r DeleteLogoResp) Status() string
Status returns HTTPResponse.Status
func (DeleteLogoResp) StatusCode ¶
func (r DeleteLogoResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeletePersonPropertiesParams ¶
type DeletePersonPropertiesParams struct {
// Token The `id_token` you received from the `/token` endpoint. This may only be used if the subject is the special value `me`.
Token *string `form:"token,omitempty" json:"token,omitempty"`
Origin *string `json:"Origin,omitempty"`
}
DeletePersonPropertiesParams defines parameters for DeletePersonProperties.
type DeletePersonPropertiesResp ¶
func ParseDeletePersonPropertiesResp ¶
func ParseDeletePersonPropertiesResp(rsp *http.Response) (*DeletePersonPropertiesResp, error)
ParseDeletePersonPropertiesResp parses an HTTP response from a DeletePersonPropertiesWithResponse call
func (DeletePersonPropertiesResp) Status ¶
func (r DeletePersonPropertiesResp) Status() string
Status returns HTTPResponse.Status
func (DeletePersonPropertiesResp) StatusCode ¶
func (r DeletePersonPropertiesResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteSlackIntegrationResp ¶ added in v0.1.17
func ParseDeleteSlackIntegrationResp ¶ added in v0.1.17
func ParseDeleteSlackIntegrationResp(rsp *http.Response) (*DeleteSlackIntegrationResp, error)
ParseDeleteSlackIntegrationResp parses an HTTP response from a DeleteSlackIntegrationWithResponse call
func (DeleteSlackIntegrationResp) Status ¶ added in v0.1.17
func (r DeleteSlackIntegrationResp) Status() string
Status returns HTTPResponse.Status
func (DeleteSlackIntegrationResp) StatusCode ¶ added in v0.1.17
func (r DeleteSlackIntegrationResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteTemplateResp ¶
func ParseDeleteTemplateResp ¶
func ParseDeleteTemplateResp(rsp *http.Response) (*DeleteTemplateResp, error)
ParseDeleteTemplateResp parses an HTTP response from a DeleteTemplateWithResponse call
func (DeleteTemplateResp) Status ¶
func (r DeleteTemplateResp) Status() string
Status returns HTTPResponse.Status
func (DeleteTemplateResp) StatusCode ¶
func (r DeleteTemplateResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type Directory ¶
type Directory struct {
// ID The unique identifier for the directory.
ID string `json:"id"`
// Env The environment this directory belongs to.
Env string `json:"env"`
// Kind The type of the directory connection.
Kind DirectoryKind `json:"kind"`
// Name The internal name of the directory.
// This field is derived from inspecting the directory itself, for example for Entra ID this field is the primary domain name. This field is used to help you identify the directory.
Name string `json:"name"`
AuthenticatePolicy RecoveryPolicyRules `json:"authenticate_policy"`
MfaPolicy RecoveryPolicyRules `json:"mfa_policy"`
PasswordPolicy RecoveryPolicyRules `json:"password_policy"`
TemporaryAccessPassPolicy RecoveryPolicyRules `json:"temporary_access_pass_policy"`
UnlockPolicy RecoveryPolicyRules `json:"unlock_policy"`
// TemporaryAccessPassLifetimeMinutes The validity period of a temporary access pass in minutes.
// For Entra ID, this value must be between 10 and 43200 (equivalent to 30 days). If not specified, the defaultLifetimeInMinutes setting in the [Temporary Access Pass authentication method policy](https://learn.microsoft.com/en-us/graph/api/resources/temporaryaccesspassauthenticationmethodconfiguration?view=graph-rest-1.0) is applied.
TemporaryAccessPassLifetimeMinutes *int `json:"temporary_access_pass_lifetime_minutes,omitempty"`
// TemporaryAccessPassReusable True if temporary access passes can be used more than once. If unspecified, temporary access passes are usable only once.
TemporaryAccessPassReusable *bool `json:"temporary_access_pass_reusable,omitempty"`
Credentials *PartialCredentials `json:"credentials,omitempty"`
// LastSyncStartedAt When the last sync started.
LastSyncStartedAt *time.Time `json:"last_sync_started_at,omitempty"`
// LastSyncCompletedAt When the last sync completed
LastSyncCompletedAt *time.Time `json:"last_sync_completed_at,omitempty"`
// LastSyncError An error describing the failure of the last sync, or null if the last sync was successful.
LastSyncError *string `json:"last_sync_error,omitempty"`
// Count The number of accounts in the directory.
Count *int `json:"count,omitempty"`
// NeedsReconnect If the directory needs to reconnect.
NeedsReconnect *bool `json:"needs_reconnect,omitempty"`
// SyncRunning true if the directory sync is currently running
SyncRunning bool `json:"sync_running"`
// BirthDateHMACSecretExists true if a shared secret for birth date HMACs has been set
BirthDateHMACSecretExists bool `json:"birth_date_hmac_secret_exists"`
// DirectorySecret the directory secret used by external clients for integration scenarios
DirectorySecret []byte `json:"directory_secret,omitempty"`
// CanGetMFABypassCode true if the directory supports generating an MFA bypass code
CanGetMFABypassCode *bool `json:"can_get_mfa_bypass_code,omitempty"`
// CanGetPasswordLink true if the directory supports issuing a pre-authenticated password reset link
CanGetPasswordLink *bool `json:"can_get_password_link,omitempty"`
// CanGetTemporaryAccessPass true if the directory supports issuing a temporary access pass
CanGetTemporaryAccessPass *bool `json:"can_get_temporary_access_pass,omitempty"`
// CanGetTemporaryPassword true if the directory supports issuing a temporary password
CanGetTemporaryPassword *bool `json:"can_get_temporary_password,omitempty"`
// CanRemoveAllMFA true if the directory supports removing all MFA devices
CanRemoveAllMFA *bool `json:"can_remove_all_mfa,omitempty"`
// CanUnlock true if the directory supports unlocking a locked account
CanUnlock *bool `json:"can_unlock,omitempty"`
// CanUpdateAccountsList true if the directory supports progressive updates to the list of accounts
CanUpdateAccountsList *bool `json:"can_update_accounts_list,omitempty"`
// LogoURL The URL of the logo image for this directory.
LogoURL *string `json:"logo_url,omitempty"`
RecoveryOperationRateLimit *RecoveryOperationRateLimit `json:"recovery_operation_rate_limit,omitempty"`
}
Directory defines model for Directory.
type DirectoryAuthorizedAuditEvent ¶ added in v0.1.15
type DirectoryAuthorizedAuditEvent struct {
Directory string `json:"directory"`
}
DirectoryAuthorizedAuditEvent defines model for DirectoryAuthorizedAuditEvent.
type DirectoryCreatedAuditEvent ¶ added in v0.1.15
type DirectoryCreatedAuditEvent struct {
Request CreateDirectoryRequest `json:"request"`
Response CreateDirectoryResponse `json:"response"`
}
DirectoryCreatedAuditEvent defines model for DirectoryCreatedAuditEvent.
type DirectoryDeletedAuditEvent ¶ added in v0.1.15
type DirectoryDeletedAuditEvent struct {
Directory string `json:"directory"`
}
DirectoryDeletedAuditEvent defines model for DirectoryDeletedAuditEvent.
type DirectoryGroup ¶
type DirectoryGroup struct {
// DirectoryImmutableIdentifier The unique identifier for the group.
DirectoryImmutableIdentifier string `json:"directory_immutable_identifier"`
// Name The display name of the group.
Name string `json:"name"`
}
DirectoryGroup defines model for DirectoryGroup.
type DirectoryKind ¶
type DirectoryKind string
DirectoryKind The type of the directory connection.
const ( DirectoryKindAzureAD DirectoryKind = "azure-ad" DirectoryKindBeyondIdentity DirectoryKind = "beyond-identity" DirectoryKindCustom DirectoryKind = "custom" DirectoryKindDuo DirectoryKind = "duo" DirectoryKindOkta DirectoryKind = "okta" DirectoryKindOnelogin DirectoryKind = "onelogin" )
Defines values for DirectoryKind.
type DirectoryLogoDeletedAuditEvent ¶ added in v0.1.16
type DirectoryLogoDeletedAuditEvent struct {
Directory string `json:"directory"`
}
DirectoryLogoDeletedAuditEvent defines model for DirectoryLogoDeletedAuditEvent.
type DirectoryLogoUploadedAuditEvent ¶ added in v0.1.16
type DirectoryLogoUploadedAuditEvent struct {
Directory string `json:"directory"`
}
DirectoryLogoUploadedAuditEvent defines model for DirectoryLogoUploadedAuditEvent.
type DirectorySetCredentialsAuditEvent ¶ added in v0.1.15
type DirectorySetCredentialsAuditEvent struct {
Directory string `json:"directory"`
}
DirectorySetCredentialsAuditEvent defines model for DirectorySetCredentialsAuditEvent.
type DirectoryUpdatedAuditEvent ¶ added in v0.1.15
type DirectoryUpdatedAuditEvent struct {
Directory string `json:"directory"`
Request UpdateDirectoryRequest `json:"request"`
}
DirectoryUpdatedAuditEvent defines model for DirectoryUpdatedAuditEvent.
type EmployeeBadgeValidationResult ¶ added in v0.1.18
type EmployeeBadgeValidationResult struct {
// Valid True if the photo is appropriate for use as an employee badge, false otherwise.
Valid bool `json:"valid"`
// Reason If the photo is not appropriate for use as an employee badge, a human-readable explanation of why the photo is not valid.
Reason *string `json:"reason,omitempty"`
}
EmployeeBadgeValidationResult defines model for EmployeeBadgeValidationResult.
type EncryptSecretJSONRequestBody ¶ added in v0.1.18
type EncryptSecretJSONRequestBody = EncryptSecretRequest
EncryptSecretJSONRequestBody defines body for EncryptSecret for application/json ContentType.
type EncryptSecretRequest ¶ added in v0.1.18
type EncryptSecretRequest struct {
// Plaintext The secret to encrypt
Plaintext string `json:"plaintext"`
}
EncryptSecretRequest defines model for EncryptSecretRequest.
type EncryptSecretResp ¶ added in v0.1.18
type EncryptSecretResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *EncryptSecretResponse
JSON400 *N400
}
func ParseEncryptSecretResp ¶ added in v0.1.18
func ParseEncryptSecretResp(rsp *http.Response) (*EncryptSecretResp, error)
ParseEncryptSecretResp parses an HTTP response from a EncryptSecretWithResponse call
func (EncryptSecretResp) Status ¶ added in v0.1.18
func (r EncryptSecretResp) Status() string
Status returns HTTPResponse.Status
func (EncryptSecretResp) StatusCode ¶ added in v0.1.18
func (r EncryptSecretResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type EncryptSecretResponse ¶ added in v0.1.18
type EncryptSecretResponse struct {
// Ciphertext The encrypted secret value
Ciphertext string `json:"ciphertext"`
}
EncryptSecretResponse defines model for EncryptSecretResponse.
type EntraEamAuthorizeAuditEvent ¶ added in v0.1.15
type EntraEamAuthorizeAuditEvent struct {
Directory string `json:"directory"`
Request EntraEamAuthorizeRequest `json:"request"`
Response EntraEamAuthorizeResponse `json:"response"`
}
EntraEamAuthorizeAuditEvent defines model for EntraEamAuthorizeAuditEvent.
type EntraEamAuthorizeRequest ¶ added in v0.1.15
type EntraEamAuthorizeRequest struct {
Claims string `json:"claims"`
ClientId string `json:"client_id"`
ClientRequestId string `json:"client_request_id"`
IdTokenHint string `json:"id_token_hint"`
Nonce string `json:"nonce"`
RedirectUri string `json:"redirect_uri"`
ResponseMode string `json:"response_mode"`
ResponseType string `json:"response_type"`
Scope string `json:"scope"`
State string `json:"state"`
}
EntraEamAuthorizeRequest defines model for EntraEamAuthorizeRequest.
type EntraEamAuthorizeResponse ¶ added in v0.1.15
type EntraEamAuthorizeResponse struct {
Oauth2ClientId string `json:"oauth2_client_id"`
Oauth2RedirectUri string `json:"oauth2_redirect_uri"`
Oauth2Server string `json:"oauth2_server"`
Oauth2Template string `json:"oauth2_template"`
State string `json:"state"`
}
EntraEamAuthorizeResponse defines model for EntraEamAuthorizeResponse.
type EntraEamFinishAuditEvent ¶ added in v0.1.15
type EntraEamFinishAuditEvent struct {
Directory string `json:"directory"`
Request EntraEamFinishRequest `json:"request"`
Response EntraEamFinishResponse `json:"response"`
}
EntraEamFinishAuditEvent defines model for EntraEamFinishAuditEvent.
type EntraEamFinishRequest ¶ added in v0.1.15
type EntraEamFinishRequest struct {
Code *string `json:"code,omitempty"`
Error *string `json:"error,omitempty"`
State string `json:"state"`
}
EntraEamFinishRequest defines model for EntraEamFinishRequest.
type EntraEamFinishResponse ¶ added in v0.1.15
type EntraEamFinishResponse struct {
BindingFailed *bool `json:"binding_failed,omitempty"`
Error *string `json:"error,omitempty"`
IDToken *string `json:"id_token,omitempty"`
Oauth2State *string `json:"oauth2_state,omitempty"`
RedirectUri *string `json:"redirect_uri,omitempty"`
}
EntraEamFinishResponse defines model for EntraEamFinishResponse.
type Env ¶
type Env struct {
// ID The identifier for this environment
ID string `json:"id"`
// Name The internal name for this environment
Name string `json:"name"`
// PublicName The name of the environment that is shared with people
PublicName string `json:"public_name"`
// LogoURL A URL to your logo, which is displayed in the Nametag mobile app.
LogoURL string `json:"logo_url"`
// TermsOfServiceURL The URL of the terms of service.
//
// Formerly, this URL was provided to end-users in the Nametag mobile app, but it
// is no longer used.
// Deprecated:
TermsOfServiceURL string `json:"terms_of_service_url"`
// CallbackURLs A list of valid URLs for use as OAuth 2.0 callback URLs.
CallbackURLs []string `json:"callback_urls"`
// Webhooks A list of webhooks.
Webhooks []WebhookDefinition `json:"webhooks"`
// Templates A list of request templates.
Templates []Template `json:"templates"`
Storage *EnvStorage `json:"storage,omitempty"`
// OidcDelegates A list of OIDC Delegates.
OidcDelegates []OIDCDelegate `json:"oidc_delegates"`
// MicrositeSAMLDirectories A list of directory ID's that back the SAML verify flow.
MicrositeSAMLDirectories []string `json:"microsite_saml_directories"`
}
Env defines model for Env.
type EnvCreatedAuditEvent ¶ added in v0.1.15
type EnvCreatedAuditEvent struct {
Request CreateEnvRequest `json:"request"`
Response CreateEnvResponse `json:"response"`
}
EnvCreatedAuditEvent defines model for EnvCreatedAuditEvent.
type EnvDeletedAuditEvent ¶ added in v0.1.15
type EnvDeletedAuditEvent struct {
Empty *bool `json:"empty,omitempty"`
}
EnvDeletedAuditEvent defines model for EnvDeletedAuditEvent.
type EnvLogoDeletedAuditEvent ¶ added in v0.1.15
type EnvLogoDeletedAuditEvent struct {
Kind string `json:"kind"`
}
EnvLogoDeletedAuditEvent defines model for EnvLogoDeletedAuditEvent.
type EnvLogoUploadedAuditEvent ¶ added in v0.1.15
type EnvLogoUploadedAuditEvent struct {
Kind string `json:"kind"`
}
EnvLogoUploadedAuditEvent defines model for EnvLogoUploadedAuditEvent.
type EnvStatusFilterParams ¶ added in v0.1.16
type EnvStatusFilterParams string
EnvStatusFilterParams defines model for EnvStatusFilterParams.
const ( Active EnvStatusFilterParams = "active" Expired EnvStatusFilterParams = "expired" HideExpired EnvStatusFilterParams = "hideExpired" RejectedAll EnvStatusFilterParams = "rejectedAll" RejectedFraud EnvStatusFilterParams = "rejectedFraud" ScheduledForDeletion EnvStatusFilterParams = "scheduledForDeletion" )
Defines values for EnvStatusFilterParams.
type EnvStorage ¶
type EnvStorage struct {
// S3BucketUS The S3 bucket for data stored in the United States. Must be in the us-east-2 AWS region.
S3BucketUS *string `json:"s3_bucket_us,omitempty"`
// S3BucketEU The S3 bucket for data stored in Europe. Must be in the eu-west-1 AWS region.
S3BucketEU *string `json:"s3_bucket_eu,omitempty"`
// S3BucketIN The S3 bucket for data stored in India. Must be in the ap-south-1 AWS region.
S3BucketIN *string `json:"s3_bucket_in,omitempty"`
// AWSRoleARN The role Nametag should use to access the S3 buckets.
AWSRoleARN *string `json:"aws_role_arn,omitempty"`
// AzureBlobSasUS Azure Blob Storage presigned (SAS) URL. Should be in the eastus region.
AzureBlobSasUS *string `json:"azure_blob_us,omitempty"`
// AzureBlobSasEU Azure Blob Storage presigned (SAS) URL. Should be in the northeurope region.
AzureBlobSasEU *string `json:"azure_blob_eu,omitempty"`
// AzureBlobSasIN Azure Blob Storage presigned (SAS) URL. Should be in the centralindia region.
AzureBlobSasIN *string `json:"azure_blob_in,omitempty"`
}
EnvStorage defines model for EnvStorage.
type EnvUpdateRequest ¶
type EnvUpdateRequest struct {
// Name Update the name of the environment, for internal use.
Name *string `json:"name,omitempty"`
// PublicName Update the public-facing name for your environment, typically your company or brand name.
PublicName *string `json:"public_name,omitempty"`
// CallbackURLs Set the list of allowed OAuth 2.0 callback URLs
CallbackURLs []string `json:"callback_urls,omitempty"`
// TermsOfServiceURL Update the terms of service URL.
// Deprecated:
TermsOfServiceURL *string `json:"terms_of_service_url,omitempty"`
// RemoveWebhooks Remove webhooks from the environment (IDs of the webhooks to remove)
RemoveWebhooks []string `json:"remove_webhooks,omitempty"`
// AddWebhooks Add webhooks to the environment
AddWebhooks []WebhookDefinition `json:"add_webhooks,omitempty"`
UpdateWebhook *WebhookDefinitionUpdate `json:"update_webhook,omitempty"`
Storage *EnvStorage `json:"storage,omitempty"`
// RemoveOidcDelegates Remove OIDC delegate from the environment (IDs of the delegates to remove)
RemoveOidcDelegates []string `json:"remove_oidc_delegates,omitempty"`
// AddOidcDelegates Add OIDC delegates to the environment
AddOidcDelegates []OIDCDelegate `json:"add_oidc_delegates,omitempty"`
UpdateOidcDelegate *OIDCDelegateUpdate `json:"update_oidc_delegate,omitempty"`
}
EnvUpdateRequest defines model for EnvUpdateRequest.
type EnvUpdatedAtFilterParams ¶ added in v0.1.16
type EnvUpdatedAtFilterParams string
EnvUpdatedAtFilterParams defines model for EnvUpdatedAtFilterParams.
const ( All EnvUpdatedAtFilterParams = "all" Lastmonth EnvUpdatedAtFilterParams = "lastmonth" Month EnvUpdatedAtFilterParams = "month" Today EnvUpdatedAtFilterParams = "today" Week EnvUpdatedAtFilterParams = "week" Year EnvUpdatedAtFilterParams = "year" )
Defines values for EnvUpdatedAtFilterParams.
type EnvUpdatedAuditEvent ¶ added in v0.1.15
type EnvUpdatedAuditEvent struct {
Request EnvUpdateRequest `json:"request"`
}
EnvUpdatedAuditEvent defines model for EnvUpdatedAuditEvent.
type EnvWebhookSecretUpdatedAuditEvent ¶ added in v0.1.15
type EnvWebhookSecretUpdatedAuditEvent struct {
Empty *bool `json:"empty,omitempty"`
}
EnvWebhookSecretUpdatedAuditEvent defines model for EnvWebhookSecretUpdatedAuditEvent.
type Expectation ¶
type Expectation struct {
// Scope Scopes are used to describe the information you want people to share with you. In order to request a scope you must first define it in your environment and provide additional parameters, such as what type of data and how long you need the data. This is done separately for each environment you manage in the Nametag console.
Scope *Scope `json:"scope,omitempty"`
// Claim Claims are used to describe the information you want people to share with you. In order to request a claim you must first define it in your environment and provide additional parameters, such as what type of data and how long you need the data. This is done separately for each environment you manage in the Nametag console.
Claim Claim `json:"claim"`
// Value The value you expect the person to have for this claim.
Value string `json:"value"`
}
Expectation defines model for Expectation.
type ExtensionInvokedAuditEvent ¶ added in v0.1.18
type ExtensionInvokedAuditEvent struct {
// Method The extension method name
Method string `json:"method"`
// Logs Messages that are emitted by console logs during the execution of the extension function.
Logs []string `json:"logs,omitempty"`
// Error If the extension method returned an error, this will contain the error message. Otherwise, it will be empty.
Error *string `json:"error,omitempty"`
}
ExtensionInvokedAuditEvent defines model for ExtensionInvokedAuditEvent.
type GetAPIKeyResp ¶
func ParseGetAPIKeyResp ¶
func ParseGetAPIKeyResp(rsp *http.Response) (*GetAPIKeyResp, error)
ParseGetAPIKeyResp parses an HTTP response from a GetAPIKeyWithResponse call
func (GetAPIKeyResp) Status ¶
func (r GetAPIKeyResp) Status() string
Status returns HTTPResponse.Status
func (GetAPIKeyResp) StatusCode ¶
func (r GetAPIKeyResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetAccountResp ¶
type GetAccountResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *Account
JSON400 *N400
}
func ParseGetAccountResp ¶
func ParseGetAccountResp(rsp *http.Response) (*GetAccountResp, error)
ParseGetAccountResp parses an HTTP response from a GetAccountWithResponse call
func (GetAccountResp) Status ¶
func (r GetAccountResp) Status() string
Status returns HTTPResponse.Status
func (GetAccountResp) StatusCode ¶
func (r GetAccountResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetBulkPeoplePropertiesJSONRequestBody ¶
type GetBulkPeoplePropertiesJSONRequestBody = BulkRequest
GetBulkPeoplePropertiesJSONRequestBody defines body for GetBulkPeopleProperties for application/json ContentType.
type GetBulkPeoplePropertiesResp ¶
type GetBulkPeoplePropertiesResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *BulkResponse
JSON400 *N400
}
func ParseGetBulkPeoplePropertiesResp ¶
func ParseGetBulkPeoplePropertiesResp(rsp *http.Response) (*GetBulkPeoplePropertiesResp, error)
ParseGetBulkPeoplePropertiesResp parses an HTTP response from a GetBulkPeoplePropertiesWithResponse call
func (GetBulkPeoplePropertiesResp) Status ¶
func (r GetBulkPeoplePropertiesResp) Status() string
Status returns HTTPResponse.Status
func (GetBulkPeoplePropertiesResp) StatusCode ¶
func (r GetBulkPeoplePropertiesResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetDirectoriesResponse ¶
type GetDirectoriesResponse struct {
// Directories A list of all directories.
Directories []Directory `json:"directories"`
}
GetDirectoriesResponse defines model for GetDirectoriesResponse.
type GetDirectoryAuthorizationURLResp ¶
type GetDirectoryAuthorizationURLResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *OAuth2AuthorizeResponse
JSON400 *N400
}
func ParseGetDirectoryAuthorizationURLResp ¶
func ParseGetDirectoryAuthorizationURLResp(rsp *http.Response) (*GetDirectoryAuthorizationURLResp, error)
ParseGetDirectoryAuthorizationURLResp parses an HTTP response from a GetDirectoryAuthorizationURLWithResponse call
func (GetDirectoryAuthorizationURLResp) Status ¶
func (r GetDirectoryAuthorizationURLResp) Status() string
Status returns HTTPResponse.Status
func (GetDirectoryAuthorizationURLResp) StatusCode ¶
func (r GetDirectoryAuthorizationURLResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetDirectoryResp ¶
type GetDirectoryResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *Directory
JSON400 *N400
}
func ParseGetDirectoryResp ¶
func ParseGetDirectoryResp(rsp *http.Response) (*GetDirectoryResp, error)
ParseGetDirectoryResp parses an HTTP response from a GetDirectoryWithResponse call
func (GetDirectoryResp) Status ¶
func (r GetDirectoryResp) Status() string
Status returns HTTPResponse.Status
func (GetDirectoryResp) StatusCode ¶
func (r GetDirectoryResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetEnvMicrometricsParams ¶ added in v0.1.16
type GetEnvMicrometricsParams struct {
Requestor *string `form:"requestor,omitempty" json:"requestor,omitempty"`
StatusFilter *EnvStatusFilterParams `form:"statusFilter,omitempty" json:"statusFilter,omitempty"`
UpdatedAt *EnvUpdatedAtFilterParams `form:"updatedAt,omitempty" json:"updatedAt,omitempty"`
}
GetEnvMicrometricsParams defines parameters for GetEnvMicrometrics.
type GetEnvMicrometricsResp ¶ added in v0.1.16
type GetEnvMicrometricsResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *GetMicrometricsResponse
JSON400 *N400
}
func ParseGetEnvMicrometricsResp ¶ added in v0.1.16
func ParseGetEnvMicrometricsResp(rsp *http.Response) (*GetEnvMicrometricsResp, error)
ParseGetEnvMicrometricsResp parses an HTTP response from a GetEnvMicrometricsWithResponse call
func (GetEnvMicrometricsResp) Status ¶ added in v0.1.16
func (r GetEnvMicrometricsResp) Status() string
Status returns HTTPResponse.Status
func (GetEnvMicrometricsResp) StatusCode ¶ added in v0.1.16
func (r GetEnvMicrometricsResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetEnvRequestResp ¶
type GetEnvRequestResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *Request
JSON400 *N400
}
func ParseGetEnvRequestResp ¶
func ParseGetEnvRequestResp(rsp *http.Response) (*GetEnvRequestResp, error)
ParseGetEnvRequestResp parses an HTTP response from a GetEnvRequestWithResponse call
func (GetEnvRequestResp) Status ¶
func (r GetEnvRequestResp) Status() string
Status returns HTTPResponse.Status
func (GetEnvRequestResp) StatusCode ¶
func (r GetEnvRequestResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetEnvResp ¶
func ParseGetEnvResp ¶
func ParseGetEnvResp(rsp *http.Response) (*GetEnvResp, error)
ParseGetEnvResp parses an HTTP response from a GetEnvWithResponse call
func (GetEnvResp) StatusCode ¶
func (r GetEnvResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetMicrometricsResponse ¶ added in v0.1.16
type GetMicrometricsResponse struct {
// SelfServiceCount Number of self-service requests
SelfServiceCount int64 `json:"self_service_count"`
// VerificationCount Total number of verification requests
VerificationCount int64 `json:"verification_count"`
// FraudCount Number of fraud requests
FraudCount int64 `json:"fraud_count"`
// HumansVerifiedCount Number of humans verified
HumansVerifiedCount int64 `json:"humans_verified_count"`
// ApiRequestsCount Number of API requests
ApiRequestsCount int64 `json:"api_requests_count"`
// CopilotCount Number of Copilot requests
CopilotCount int64 `json:"copilot_count"`
}
GetMicrometricsResponse defines model for GetMicrometricsResponse.
type GetOrgResp ¶
func ParseGetOrgResp ¶
func ParseGetOrgResp(rsp *http.Response) (*GetOrgResp, error)
ParseGetOrgResp parses an HTTP response from a GetOrgWithResponse call
func (GetOrgResp) StatusCode ¶
func (r GetOrgResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetPersonPropertiesParams ¶
type GetPersonPropertiesParams struct {
// Token The `id_token` you received from the `/token` endpoint. This may only be used if the subject is the special value `me`.
Token *string `form:"token,omitempty" json:"token,omitempty"`
Origin *string `json:"Origin,omitempty"`
}
GetPersonPropertiesParams defines parameters for GetPersonProperties.
type GetPersonPropertiesResp ¶
type GetPersonPropertiesResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *PropertiesResponse
JSON400 *N400
}
func ParseGetPersonPropertiesResp ¶
func ParseGetPersonPropertiesResp(rsp *http.Response) (*GetPersonPropertiesResp, error)
ParseGetPersonPropertiesResp parses an HTTP response from a GetPersonPropertiesWithResponse call
func (GetPersonPropertiesResp) Status ¶
func (r GetPersonPropertiesResp) Status() string
Status returns HTTPResponse.Status
func (GetPersonPropertiesResp) StatusCode ¶
func (r GetPersonPropertiesResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetRequestResp ¶
type GetRequestResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *Request
JSON400 *N400
}
func ParseGetRequestResp ¶
func ParseGetRequestResp(rsp *http.Response) (*GetRequestResp, error)
ParseGetRequestResp parses an HTTP response from a GetRequestWithResponse call
func (GetRequestResp) Status ¶
func (r GetRequestResp) Status() string
Status returns HTTPResponse.Status
func (GetRequestResp) StatusCode ¶
func (r GetRequestResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetRequestsResponse ¶
type GetRequestsResponse struct {
Requests []Request `json:"requests"`
NextOffset int `json:"next_offset"`
TotalResultCount int64 `json:"total_result_count"`
}
GetRequestsResponse defines model for GetRequestsResponse.
type GetSlackRequestDetailsResp ¶ added in v0.1.17
type GetSlackRequestDetailsResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *SlackRequestDetailsResponse
JSON400 *N400
}
func ParseGetSlackRequestDetailsResp ¶ added in v0.1.17
func ParseGetSlackRequestDetailsResp(rsp *http.Response) (*GetSlackRequestDetailsResp, error)
ParseGetSlackRequestDetailsResp parses an HTTP response from a GetSlackRequestDetailsWithResponse call
func (GetSlackRequestDetailsResp) Status ¶ added in v0.1.17
func (r GetSlackRequestDetailsResp) Status() string
Status returns HTTPResponse.Status
func (GetSlackRequestDetailsResp) StatusCode ¶ added in v0.1.17
func (r GetSlackRequestDetailsResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GovtidType ¶
type GovtidType string
GovtidType defines model for GovtidType.
const ( DriverLicense GovtidType = "driver_license" Passport GovtidType = "passport" )
Defines values for GovtidType.
type GovtidValue ¶ added in v0.1.16
type GovtidValue struct {
Type GovtidType `json:"type"`
// Issuer The issuer of the identity document, an [ISO 3166-1 alpha 3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) optionally followed by a jurisdiction code, e.g. `USA.CA` or `CAN.ON`
Issuer *string `json:"issuer,omitempty"`
// DocumentNumber The unique number of the identity document
DocumentNumber *string `json:"document_number,omitempty"`
// Expiration The date when the identity document expires
Expiration *openapi_types.Date `json:"expiration,omitempty"`
}
GovtidValue defines model for GovtidValue.
type GroupRecoveryPolicy ¶
type GroupRecoveryPolicy struct {
Group DirectoryGroup `json:"group"`
Policy RecoveryPolicy `json:"policy"`
}
GroupRecoveryPolicy defines model for GroupRecoveryPolicy.
type HttpRequestDoer ¶
Doer performs HTTP requests.
The standard http.Client implements this interface.
type InviteOrgMemberJSONRequestBody ¶
type InviteOrgMemberJSONRequestBody = InviteOrgMemberRequest
InviteOrgMemberJSONRequestBody defines body for InviteOrgMember for application/json ContentType.
type InviteOrgMemberRequest ¶
type InviteOrgMemberRequest struct {
// Email The email address of the person you want to invite.
Email openapi_types.Email `json:"email"`
// Envs The list of environments the member will have access to. If the list contains `*`, the member will have access to all environments.
Envs []string `json:"envs"`
Role Role `json:"role"`
}
InviteOrgMemberRequest defines model for InviteOrgMemberRequest.
type InviteOrgMemberResp ¶
func ParseInviteOrgMemberResp ¶
func ParseInviteOrgMemberResp(rsp *http.Response) (*InviteOrgMemberResp, error)
ParseInviteOrgMemberResp parses an HTTP response from a InviteOrgMemberWithResponse call
func (InviteOrgMemberResp) Status ¶
func (r InviteOrgMemberResp) Status() string
Status returns HTTPResponse.Status
func (InviteOrgMemberResp) StatusCode ¶
func (r InviteOrgMemberResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListAPIKeysResp ¶
type ListAPIKeysResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ListAPIKeysResponse
JSON400 *N400
}
func ParseListAPIKeysResp ¶
func ParseListAPIKeysResp(rsp *http.Response) (*ListAPIKeysResp, error)
ParseListAPIKeysResp parses an HTTP response from a ListAPIKeysWithResponse call
func (ListAPIKeysResp) Status ¶
func (r ListAPIKeysResp) Status() string
Status returns HTTPResponse.Status
func (ListAPIKeysResp) StatusCode ¶
func (r ListAPIKeysResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListAPIKeysResponse ¶
type ListAPIKeysResponse struct {
// APIKeys A list of API keys
APIKeys []APIKey `json:"apikeys"`
}
ListAPIKeysResponse defines model for ListAPIKeysResponse.
type ListAccountsParams ¶
type ListAccountsParams struct {
// Envs List only accounts in the specified environments
Envs *[]string `form:"env,omitempty" json:"env,omitempty"`
// Offset The offset to start from
Offset *string `form:"offset,omitempty" json:"offset,omitempty"`
// Count The number of items to return
Count *int `form:"count,omitempty" json:"count,omitempty"`
// Verified Show only verified accounts
Verified *bool `form:"verified,omitempty" json:"verified,omitempty"`
// Directories Show only accounts in these directories
Directories *[]string `form:"directory,omitempty" json:"directory,omitempty"`
// Q Search query
Q *string `form:"q,omitempty" json:"q,omitempty"`
}
ListAccountsParams defines parameters for ListAccounts.
type ListAccountsResp ¶
type ListAccountsResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *AccountsList
JSON400 *N400
}
func ParseListAccountsResp ¶
func ParseListAccountsResp(rsp *http.Response) (*ListAccountsResp, error)
ParseListAccountsResp parses an HTTP response from a ListAccountsWithResponse call
func (ListAccountsResp) Status ¶
func (r ListAccountsResp) Status() string
Status returns HTTPResponse.Status
func (ListAccountsResp) StatusCode ¶
func (r ListAccountsResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListAuditEventsParams ¶ added in v0.1.15
type ListAuditEventsParams struct {
// Start Show records created at or after this time
Start *time.Time `form:"start,omitempty" json:"start,omitempty"`
// End Show records created before this time
End *time.Time `form:"end,omitempty" json:"end,omitempty"`
// Reverse If false (the default), logs are emitted newest to oldest. If this parameter is true, logs are emitted oldest to newest.
Reverse *bool `form:"reverse,omitempty" json:"reverse,omitempty"`
// Count The number of items to return. Note that the API may return fewer items than specified (even zero) and there still may be more records available if the forward_cursor or backward_cursor response fields are set.
Count *int `form:"count,omitempty" json:"count,omitempty"`
// Env Limit audit events to those relating to the specified environment (or environments)
Env *[]string `form:"env,omitempty" json:"env,omitempty"`
// Kind Limit audit events to those matching the specified kind.
Kind *[]AuditEventKind `form:"kind,omitempty" json:"kind,omitempty"`
// Query Show only results containing the specified query string.
Query *string `form:"query,omitempty" json:"query,omitempty"`
// Cursor Continue a paginated query that previously returned a cursor.
Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`
}
ListAuditEventsParams defines parameters for ListAuditEvents.
type ListAuditEventsResp ¶ added in v0.1.15
type ListAuditEventsResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ListAuditEventsResponse
JSON400 *N400
}
func ParseListAuditEventsResp ¶ added in v0.1.15
func ParseListAuditEventsResp(rsp *http.Response) (*ListAuditEventsResp, error)
ParseListAuditEventsResp parses an HTTP response from a ListAuditEventsWithResponse call
func (ListAuditEventsResp) Status ¶ added in v0.1.15
func (r ListAuditEventsResp) Status() string
Status returns HTTPResponse.Status
func (ListAuditEventsResp) StatusCode ¶ added in v0.1.15
func (r ListAuditEventsResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListAuditEventsResponse ¶ added in v0.1.15
type ListAuditEventsResponse struct {
// Events A list of audit events
Events []AuditEvent `json:"events"`
BackwardCursor *string `json:"backward_cursor,omitempty"`
ForwardCursor *string `json:"forward_cursor,omitempty"`
}
ListAuditEventsResponse defines model for ListAuditEventsResponse.
type ListDirectoriesResp ¶
type ListDirectoriesResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *GetDirectoriesResponse
JSON400 *N400
}
func ParseListDirectoriesResp ¶
func ParseListDirectoriesResp(rsp *http.Response) (*ListDirectoriesResp, error)
ParseListDirectoriesResp parses an HTTP response from a ListDirectoriesWithResponse call
func (ListDirectoriesResp) Status ¶
func (r ListDirectoriesResp) Status() string
Status returns HTTPResponse.Status
func (ListDirectoriesResp) StatusCode ¶
func (r ListDirectoriesResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListEnvRequestsParams ¶
type ListEnvRequestsParams struct {
Q *string `form:"q,omitempty" json:"q,omitempty"`
Requestor *string `form:"requestor,omitempty" json:"requestor,omitempty"`
Count *int `form:"count,omitempty" json:"count,omitempty"`
Offset *int `form:"offset,omitempty" json:"offset,omitempty"`
Sort *ListEnvRequestsParamsSort `form:"sort,omitempty" json:"sort,omitempty"`
StatusFilter *EnvStatusFilterParams `form:"statusFilter,omitempty" json:"statusFilter,omitempty"`
UpdatedAt *EnvUpdatedAtFilterParams `form:"updatedAt,omitempty" json:"updatedAt,omitempty"`
}
ListEnvRequestsParams defines parameters for ListEnvRequests.
type ListEnvRequestsParamsSort ¶
type ListEnvRequestsParamsSort string
ListEnvRequestsParamsSort defines parameters for ListEnvRequests.
const ( LastCreated ListEnvRequestsParamsSort = "last_created" LastUpdated ListEnvRequestsParamsSort = "last_updated" MinusLastCreated ListEnvRequestsParamsSort = "-last_created" MinusLastUpdated ListEnvRequestsParamsSort = "-last_updated" )
Defines values for ListEnvRequestsParamsSort.
type ListEnvRequestsResp ¶
type ListEnvRequestsResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *GetRequestsResponse
JSON400 *N400
}
func ParseListEnvRequestsResp ¶
func ParseListEnvRequestsResp(rsp *http.Response) (*ListEnvRequestsResp, error)
ParseListEnvRequestsResp parses an HTTP response from a ListEnvRequestsWithResponse call
func (ListEnvRequestsResp) Status ¶
func (r ListEnvRequestsResp) Status() string
Status returns HTTPResponse.Status
func (ListEnvRequestsResp) StatusCode ¶
func (r ListEnvRequestsResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListEnvsResp ¶
type ListEnvsResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ListEnvsResponse
JSON400 *N400
}
func ParseListEnvsResp ¶
func ParseListEnvsResp(rsp *http.Response) (*ListEnvsResp, error)
ParseListEnvsResp parses an HTTP response from a ListEnvsWithResponse call
func (ListEnvsResp) Status ¶
func (r ListEnvsResp) Status() string
Status returns HTTPResponse.Status
func (ListEnvsResp) StatusCode ¶
func (r ListEnvsResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListEnvsResponse ¶
type ListEnvsResponse struct {
// Envs A list of all your environments.
Envs []Env `json:"envs"`
}
ListEnvsResponse defines model for ListEnvsResponse.
type ListOrgMembersResp ¶
type ListOrgMembersResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ListOrgMembersResponse
JSON400 *N400
}
func ParseListOrgMembersResp ¶
func ParseListOrgMembersResp(rsp *http.Response) (*ListOrgMembersResp, error)
ParseListOrgMembersResp parses an HTTP response from a ListOrgMembersWithResponse call
func (ListOrgMembersResp) Status ¶
func (r ListOrgMembersResp) Status() string
Status returns HTTPResponse.Status
func (ListOrgMembersResp) StatusCode ¶
func (r ListOrgMembersResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListOrgMembersResponse ¶
type ListOrgMembersResponse struct {
// Members A list of each member of the organization
Members []OrgMember `json:"members"`
}
ListOrgMembersResponse defines model for ListOrgMembersResponse.
type ListSlackIntegrationsResp ¶ added in v0.1.17
type ListSlackIntegrationsResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ListSlackIntegrationsResponse
JSON400 *N400
}
func ParseListSlackIntegrationsResp ¶ added in v0.1.17
func ParseListSlackIntegrationsResp(rsp *http.Response) (*ListSlackIntegrationsResp, error)
ParseListSlackIntegrationsResp parses an HTTP response from a ListSlackIntegrationsWithResponse call
func (ListSlackIntegrationsResp) Status ¶ added in v0.1.17
func (r ListSlackIntegrationsResp) Status() string
Status returns HTTPResponse.Status
func (ListSlackIntegrationsResp) StatusCode ¶ added in v0.1.17
func (r ListSlackIntegrationsResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListSlackIntegrationsResponse ¶ added in v0.1.17
type ListSlackIntegrationsResponse struct {
// Integrations A list of Slack integrations for this environment
Integrations []SlackIntegration `json:"integrations"`
}
ListSlackIntegrationsResponse defines model for ListSlackIntegrationsResponse.
type ListWebhooksResp ¶
type ListWebhooksResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ListWebhooksResponse
JSON400 *N400
}
func ParseListWebhooksResp ¶
func ParseListWebhooksResp(rsp *http.Response) (*ListWebhooksResp, error)
ParseListWebhooksResp parses an HTTP response from a ListWebhooksWithResponse call
func (ListWebhooksResp) Status ¶
func (r ListWebhooksResp) Status() string
Status returns HTTPResponse.Status
func (ListWebhooksResp) StatusCode ¶
func (r ListWebhooksResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListWebhooksResponse ¶
type ListWebhooksResponse struct {
Webhooks []Webhook `json:"webhooks"`
}
ListWebhooksResponse defines model for ListWebhooksResponse.
type Location ¶
type Location struct {
// Business Whether the location is a business.
Business bool `json:"business,omitempty"`
// City The city of the location.
City string `json:"city,omitempty"`
// Country The country of the location.
Country string `json:"country,omitempty"`
// Latitude The latitude of the location.
Latitude float64 `json:"latitude"`
// Longitude The longitude of the location.
Longitude float64 `json:"longitude"`
// PoBox Whether the location is a PO box.
PoBox bool `json:"po_box,omitempty"`
// Residential Whether the location is residential.
Residential bool `json:"residential,omitempty"`
// Subdivision The subdivision of the location (e.g. the state or province).
Subdivision string `json:"subdivision,omitempty"`
}
Location defines model for Location.
type NumericRequestStatus ¶
type NumericRequestStatus int
NumericRequestStatus defines model for NumericRequestStatus.
const ( NumericRequestStatusCancelled NumericRequestStatus = 404 NumericRequestStatusCompleted NumericRequestStatus = 200 NumericRequestStatusExpired NumericRequestStatus = 410 NumericRequestStatusExpiredScopes NumericRequestStatus = 411 NumericRequestStatusInProgress NumericRequestStatus = 101 NumericRequestStatusPending NumericRequestStatus = 100 NumericRequestStatusRejectedFraud NumericRequestStatus = 552 NumericRequestStatusRejectedInReview NumericRequestStatus = 550 NumericRequestStatusRejectedUnusable NumericRequestStatus = 551 NumericRequestStatusRevoked NumericRequestStatus = 403 )
Defines values for NumericRequestStatus.
type OAuth2AuthorizeAuditEvent ¶ added in v0.1.15
type OAuth2AuthorizeAuditEvent struct {
Request AuthorizeRequest `json:"request"`
Response AuthorizeResponse `json:"response"`
}
OAuth2AuthorizeAuditEvent defines model for OAuth2AuthorizeAuditEvent.
type OAuth2AuthorizeResponse ¶
type OAuth2AuthorizeResponse struct {
// RedirectURL The URL to redirect the user to authorize the directory.
RedirectURL string `json:"redirect_url"`
}
OAuth2AuthorizeResponse defines model for OAuth2AuthorizeResponse.
type OAuth2PushedAuthorizationRequestAuditEvent ¶ added in v0.1.16
type OAuth2PushedAuthorizationRequestAuditEvent struct {
Request PushedAuthorizationRequest `json:"request"`
Response PushedAuthorizationResponse `json:"response"`
}
OAuth2PushedAuthorizationRequestAuditEvent defines model for OAuth2PushedAuthorizationRequestAuditEvent.
type OAuth2RequestCanceledAuditEvent ¶ added in v0.1.15
type OAuth2RequestCanceledAuditEvent struct {
Request string `json:"request"`
}
OAuth2RequestCanceledAuditEvent defines model for OAuth2RequestCanceledAuditEvent.
type OAuth2TokenAuditEvent ¶ added in v0.1.15
type OAuth2TokenAuditEvent struct {
Request TokenRequest `json:"request"`
Response TokenResponse `json:"response"`
}
OAuth2TokenAuditEvent defines model for OAuth2TokenAuditEvent.
type OAuth2V2AuthorizeAuditEvent ¶ added in v0.1.16
type OAuth2V2AuthorizeAuditEvent struct {
Request AuthorizeV2Request `json:"request"`
Response AuthorizeResponse `json:"response"`
}
OAuth2V2AuthorizeAuditEvent defines model for OAuth2V2AuthorizeAuditEvent.
type OIDCDelegate ¶ added in v0.1.18
type OIDCDelegate struct {
// ID A unique identifier for the OIDC delegate.
ID string `json:"id"`
// Name The name of the delegate
Name string `json:"name"`
// ClientID The client ID for the OAuth delegate.
ClientID *string `json:"client_id,omitempty"`
// ClientSecret The client secret for the OAuth delegate.
ClientSecret *string `json:"client_secret,omitempty"`
// Issuer The URL of the issuer for the OIDC delegate.
Issuer string `json:"issuer"`
}
OIDCDelegate defines model for OIDCDelegate.
type OIDCDelegateUpdate ¶ added in v0.1.18
type OIDCDelegateUpdate struct {
ID string `json:"id"`
Name *string `json:"name,omitempty"`
ClientID *string `json:"client_id,omitempty"`
ClientSecret *string `json:"client_secret,omitempty"`
Issuer *string `json:"issuer,omitempty"`
}
OIDCDelegateUpdate defines model for OIDCDelegateUpdate.
type Oauth2AuthorizeIframeParams ¶
type Oauth2AuthorizeIframeParams struct {
// ClientId The client ID
ClientId string `form:"client_id" json:"client_id"`
// RedirectUri The redirect URI
RedirectUri string `form:"redirect_uri" json:"redirect_uri"`
// State The state
State string `form:"state" json:"state"`
// Scope Space-separated list of scopes
Scope string `form:"scope" json:"scope"`
// ResponseType The response type
ResponseType Oauth2AuthorizeIframeParamsResponseType `form:"response_type" json:"response_type"`
// ResponseMode The response mode
ResponseMode *Oauth2AuthorizeIframeParamsResponseMode `form:"response_mode,omitempty" json:"response_mode,omitempty"`
// CodeChallenge The code challenge
CodeChallenge *string `form:"code_challenge,omitempty" json:"code_challenge,omitempty"`
// CodeChallengeMethod The code challenge method
CodeChallengeMethod *Oauth2AuthorizeIframeParamsCodeChallengeMethod `form:"code_challenge_method,omitempty" json:"code_challenge_method,omitempty"`
// EmailHint The email hint
EmailHint *openapi_types.Email `form:"email_hint,omitempty" json:"email_hint,omitempty"`
// Template The template to use
Template *string `form:"template,omitempty" json:"template,omitempty"`
// ThemeColor The QR code color
ThemeColor *string `form:"theme_color,omitempty" json:"theme_color,omitempty"`
// Return The return URL
Return *AuthorizeReturn `form:"return,omitempty" json:"return,omitempty"`
}
Oauth2AuthorizeIframeParams defines parameters for Oauth2AuthorizeIframe.
type Oauth2AuthorizeIframeParamsCodeChallengeMethod ¶
type Oauth2AuthorizeIframeParamsCodeChallengeMethod string
Oauth2AuthorizeIframeParamsCodeChallengeMethod defines parameters for Oauth2AuthorizeIframe.
const ( Oauth2AuthorizeIframeParamsCodeChallengeMethodPlain Oauth2AuthorizeIframeParamsCodeChallengeMethod = "plain" Oauth2AuthorizeIframeParamsCodeChallengeMethodS256 Oauth2AuthorizeIframeParamsCodeChallengeMethod = "S256" )
Defines values for Oauth2AuthorizeIframeParamsCodeChallengeMethod.
type Oauth2AuthorizeIframeParamsResponseMode ¶
type Oauth2AuthorizeIframeParamsResponseMode string
Oauth2AuthorizeIframeParamsResponseMode defines parameters for Oauth2AuthorizeIframe.
const (
Oauth2AuthorizeIframeParamsResponseModeFragment Oauth2AuthorizeIframeParamsResponseMode = "fragment"
)
Defines values for Oauth2AuthorizeIframeParamsResponseMode.
type Oauth2AuthorizeIframeParamsResponseType ¶
type Oauth2AuthorizeIframeParamsResponseType string
Oauth2AuthorizeIframeParamsResponseType defines parameters for Oauth2AuthorizeIframe.
const (
Oauth2AuthorizeIframeParamsResponseTypeCode Oauth2AuthorizeIframeParamsResponseType = "code"
)
Defines values for Oauth2AuthorizeIframeParamsResponseType.
type Oauth2AuthorizeIframeResp ¶
func ParseOauth2AuthorizeIframeResp ¶
func ParseOauth2AuthorizeIframeResp(rsp *http.Response) (*Oauth2AuthorizeIframeResp, error)
ParseOauth2AuthorizeIframeResp parses an HTTP response from a Oauth2AuthorizeIframeWithResponse call
func (Oauth2AuthorizeIframeResp) Status ¶
func (r Oauth2AuthorizeIframeResp) Status() string
Status returns HTTPResponse.Status
func (Oauth2AuthorizeIframeResp) StatusCode ¶
func (r Oauth2AuthorizeIframeResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type Oauth2AuthorizeParams ¶
type Oauth2AuthorizeParams struct {
// ClientId The client ID
ClientId string `form:"client_id" json:"client_id"`
// RedirectUri The redirect URI
RedirectUri string `form:"redirect_uri" json:"redirect_uri"`
// State The state
State string `form:"state" json:"state"`
// Scope Space-separated list of scopes
Scope string `form:"scope" json:"scope"`
// ResponseType The response type
ResponseType Oauth2AuthorizeParamsResponseType `form:"response_type" json:"response_type"`
// ResponseMode The response mode
ResponseMode *Oauth2AuthorizeParamsResponseMode `form:"response_mode,omitempty" json:"response_mode,omitempty"`
// CodeChallenge The code challenge
CodeChallenge *string `form:"code_challenge,omitempty" json:"code_challenge,omitempty"`
// CodeChallengeMethod The code challenge method
CodeChallengeMethod *Oauth2AuthorizeParamsCodeChallengeMethod `form:"code_challenge_method,omitempty" json:"code_challenge_method,omitempty"`
// EmailHint The email hint
EmailHint *openapi_types.Email `form:"email_hint,omitempty" json:"email_hint,omitempty"`
// Template The template to use
Template *string `form:"template,omitempty" json:"template,omitempty"`
// Return The return URL
Return *AuthorizeReturn `form:"return,omitempty" json:"return,omitempty"`
}
Oauth2AuthorizeParams defines parameters for Oauth2Authorize.
type Oauth2AuthorizeParamsCodeChallengeMethod ¶
type Oauth2AuthorizeParamsCodeChallengeMethod string
Oauth2AuthorizeParamsCodeChallengeMethod defines parameters for Oauth2Authorize.
const ( Oauth2AuthorizeParamsCodeChallengeMethodPlain Oauth2AuthorizeParamsCodeChallengeMethod = "plain" Oauth2AuthorizeParamsCodeChallengeMethodS256 Oauth2AuthorizeParamsCodeChallengeMethod = "S256" )
Defines values for Oauth2AuthorizeParamsCodeChallengeMethod.
type Oauth2AuthorizeParamsResponseMode ¶
type Oauth2AuthorizeParamsResponseMode string
Oauth2AuthorizeParamsResponseMode defines parameters for Oauth2Authorize.
const (
Oauth2AuthorizeParamsResponseModeFragment Oauth2AuthorizeParamsResponseMode = "fragment"
)
Defines values for Oauth2AuthorizeParamsResponseMode.
type Oauth2AuthorizeParamsResponseType ¶
type Oauth2AuthorizeParamsResponseType string
Oauth2AuthorizeParamsResponseType defines parameters for Oauth2Authorize.
const (
Oauth2AuthorizeParamsResponseTypeCode Oauth2AuthorizeParamsResponseType = "code"
)
Defines values for Oauth2AuthorizeParamsResponseType.
type Oauth2AuthorizeResp ¶
type Oauth2AuthorizeResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *AuthorizeResponse
JSON400 *AuthorizeResponse
}
func ParseOauth2AuthorizeResp ¶
func ParseOauth2AuthorizeResp(rsp *http.Response) (*Oauth2AuthorizeResp, error)
ParseOauth2AuthorizeResp parses an HTTP response from a Oauth2AuthorizeWithResponse call
func (Oauth2AuthorizeResp) Status ¶
func (r Oauth2AuthorizeResp) Status() string
Status returns HTTPResponse.Status
func (Oauth2AuthorizeResp) StatusCode ¶
func (r Oauth2AuthorizeResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type Oauth2AuthorizeWithExperienceParams ¶
type Oauth2AuthorizeWithExperienceParams struct {
// ClientId The client ID
ClientId string `form:"client_id" json:"client_id"`
// RedirectUri The redirect URI
RedirectUri string `form:"redirect_uri" json:"redirect_uri"`
// State The state
State string `form:"state" json:"state"`
// Scope Space-separated list of scopes
Scope string `form:"scope" json:"scope"`
// ResponseType The response type
ResponseType Oauth2AuthorizeWithExperienceParamsResponseType `form:"response_type" json:"response_type"`
// ResponseMode The response mode
ResponseMode *Oauth2AuthorizeWithExperienceParamsResponseMode `form:"response_mode,omitempty" json:"response_mode,omitempty"`
// CodeChallenge The code challenge
CodeChallenge *string `form:"code_challenge,omitempty" json:"code_challenge,omitempty"`
// CodeChallengeMethod The code challenge method
CodeChallengeMethod *Oauth2AuthorizeWithExperienceParamsCodeChallengeMethod `form:"code_challenge_method,omitempty" json:"code_challenge_method,omitempty"`
// EmailHint The email hint
EmailHint *openapi_types.Email `form:"email_hint,omitempty" json:"email_hint,omitempty"`
// Template The template to use
Template *string `form:"template,omitempty" json:"template,omitempty"`
// Return The return URL
Return *AuthorizeReturn `form:"return,omitempty" json:"return,omitempty"`
}
Oauth2AuthorizeWithExperienceParams defines parameters for Oauth2AuthorizeWithExperience.
type Oauth2AuthorizeWithExperienceParamsCodeChallengeMethod ¶
type Oauth2AuthorizeWithExperienceParamsCodeChallengeMethod string
Oauth2AuthorizeWithExperienceParamsCodeChallengeMethod defines parameters for Oauth2AuthorizeWithExperience.
const ( Plain Oauth2AuthorizeWithExperienceParamsCodeChallengeMethod = "plain" S256 Oauth2AuthorizeWithExperienceParamsCodeChallengeMethod = "S256" )
Defines values for Oauth2AuthorizeWithExperienceParamsCodeChallengeMethod.
type Oauth2AuthorizeWithExperienceParamsResponseMode ¶
type Oauth2AuthorizeWithExperienceParamsResponseMode string
Oauth2AuthorizeWithExperienceParamsResponseMode defines parameters for Oauth2AuthorizeWithExperience.
const (
Fragment Oauth2AuthorizeWithExperienceParamsResponseMode = "fragment"
)
Defines values for Oauth2AuthorizeWithExperienceParamsResponseMode.
type Oauth2AuthorizeWithExperienceParamsResponseType ¶
type Oauth2AuthorizeWithExperienceParamsResponseType string
Oauth2AuthorizeWithExperienceParamsResponseType defines parameters for Oauth2AuthorizeWithExperience.
const (
Code Oauth2AuthorizeWithExperienceParamsResponseType = "code"
)
Defines values for Oauth2AuthorizeWithExperienceParamsResponseType.
type Oauth2AuthorizeWithExperienceResp ¶
type Oauth2AuthorizeWithExperienceResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *AuthorizeResponse
JSON400 *AuthorizeResponse
}
func ParseOauth2AuthorizeWithExperienceResp ¶
func ParseOauth2AuthorizeWithExperienceResp(rsp *http.Response) (*Oauth2AuthorizeWithExperienceResp, error)
ParseOauth2AuthorizeWithExperienceResp parses an HTTP response from a Oauth2AuthorizeWithExperienceWithResponse call
func (Oauth2AuthorizeWithExperienceResp) Status ¶
func (r Oauth2AuthorizeWithExperienceResp) Status() string
Status returns HTTPResponse.Status
func (Oauth2AuthorizeWithExperienceResp) StatusCode ¶
func (r Oauth2AuthorizeWithExperienceResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type Oauth2AuthorizeWithRequestAndExperienceParams ¶
type Oauth2AuthorizeWithRequestAndExperienceParams struct {
// QuerySession The session token
QuerySession *string `form:"session,omitempty" json:"session,omitempty"`
// CookieSession The session token
CookieSession *string `form:"session,omitempty" json:"session,omitempty"`
}
Oauth2AuthorizeWithRequestAndExperienceParams defines parameters for Oauth2AuthorizeWithRequestAndExperience.
type Oauth2AuthorizeWithRequestAndExperienceResp ¶
func ParseOauth2AuthorizeWithRequestAndExperienceResp ¶
func ParseOauth2AuthorizeWithRequestAndExperienceResp(rsp *http.Response) (*Oauth2AuthorizeWithRequestAndExperienceResp, error)
ParseOauth2AuthorizeWithRequestAndExperienceResp parses an HTTP response from a Oauth2AuthorizeWithRequestAndExperienceWithResponse call
func (Oauth2AuthorizeWithRequestAndExperienceResp) Status ¶
func (r Oauth2AuthorizeWithRequestAndExperienceResp) Status() string
Status returns HTTPResponse.Status
func (Oauth2AuthorizeWithRequestAndExperienceResp) StatusCode ¶
func (r Oauth2AuthorizeWithRequestAndExperienceResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type Oauth2AuthorizeWithRequestParams ¶
type Oauth2AuthorizeWithRequestParams struct {
// QuerySession The session token
QuerySession *string `form:"session,omitempty" json:"session,omitempty"`
// CookieSession The session token
CookieSession *string `form:"session,omitempty" json:"session,omitempty"`
}
Oauth2AuthorizeWithRequestParams defines parameters for Oauth2AuthorizeWithRequest.
type Oauth2AuthorizeWithRequestResp ¶
func ParseOauth2AuthorizeWithRequestResp ¶
func ParseOauth2AuthorizeWithRequestResp(rsp *http.Response) (*Oauth2AuthorizeWithRequestResp, error)
ParseOauth2AuthorizeWithRequestResp parses an HTTP response from a Oauth2AuthorizeWithRequestWithResponse call
func (Oauth2AuthorizeWithRequestResp) Status ¶
func (r Oauth2AuthorizeWithRequestResp) Status() string
Status returns HTTPResponse.Status
func (Oauth2AuthorizeWithRequestResp) StatusCode ¶
func (r Oauth2AuthorizeWithRequestResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type Oauth2CancelParams ¶
type Oauth2CancelParams struct {
// QuerySession The session token
QuerySession *string `form:"session,omitempty" json:"session,omitempty"`
// CookieSession The session token
CookieSession *string `form:"session,omitempty" json:"session,omitempty"`
}
Oauth2CancelParams defines parameters for Oauth2Cancel.
type Oauth2CancelResp ¶
type Oauth2CancelResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *CancelResponse
}
func ParseOauth2CancelResp ¶
func ParseOauth2CancelResp(rsp *http.Response) (*Oauth2CancelResp, error)
ParseOauth2CancelResp parses an HTTP response from a Oauth2CancelWithResponse call
func (Oauth2CancelResp) Status ¶
func (r Oauth2CancelResp) Status() string
Status returns HTTPResponse.Status
func (Oauth2CancelResp) StatusCode ¶
func (r Oauth2CancelResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type Oauth2LogoutResp ¶
func ParseOauth2LogoutResp ¶
func ParseOauth2LogoutResp(rsp *http.Response) (*Oauth2LogoutResp, error)
ParseOauth2LogoutResp parses an HTTP response from a Oauth2LogoutWithResponse call
func (Oauth2LogoutResp) Status ¶
func (r Oauth2LogoutResp) Status() string
Status returns HTTPResponse.Status
func (Oauth2LogoutResp) StatusCode ¶
func (r Oauth2LogoutResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type Oauth2PollParams ¶
type Oauth2PollParams struct {
// QuerySession The session token
QuerySession *string `form:"session,omitempty" json:"session,omitempty"`
// CookieSession The session token
CookieSession *string `form:"session,omitempty" json:"session,omitempty"`
}
Oauth2PollParams defines parameters for Oauth2Poll.
type Oauth2PollResp ¶
type Oauth2PollResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *PollResponse
}
func ParseOauth2PollResp ¶
func ParseOauth2PollResp(rsp *http.Response) (*Oauth2PollResp, error)
ParseOauth2PollResp parses an HTTP response from a Oauth2PollWithResponse call
func (Oauth2PollResp) Status ¶
func (r Oauth2PollResp) Status() string
Status returns HTTPResponse.Status
func (Oauth2PollResp) StatusCode ¶
func (r Oauth2PollResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type Oauth2TokenFormdataRequestBody ¶
type Oauth2TokenFormdataRequestBody = TokenRequest
Oauth2TokenFormdataRequestBody defines body for Oauth2Token for application/x-www-form-urlencoded ContentType.
type Oauth2TokenResp ¶
type Oauth2TokenResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *TokenResponse
JSON400 *TokenResponseError
}
func ParseOauth2TokenResp ¶
func ParseOauth2TokenResp(rsp *http.Response) (*Oauth2TokenResp, error)
ParseOauth2TokenResp parses an HTTP response from a Oauth2TokenWithResponse call
func (Oauth2TokenResp) Status ¶
func (r Oauth2TokenResp) Status() string
Status returns HTTPResponse.Status
func (Oauth2TokenResp) StatusCode ¶
func (r Oauth2TokenResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type OktaEamAuthorizeAuditEvent ¶ added in v0.1.15
type OktaEamAuthorizeAuditEvent struct {
Directory string `json:"directory"`
Request OktaEamAuthorizeRequest `json:"request"`
Response OktaEamAuthorizeResponse `json:"response"`
}
OktaEamAuthorizeAuditEvent defines model for OktaEamAuthorizeAuditEvent.
type OktaEamAuthorizeRequest ¶ added in v0.1.15
type OktaEamAuthorizeRequest struct {
Claims string `json:"claims"`
ClientId string `json:"client_id"`
LoginHint string `json:"login_hint"`
RedirectUri string `json:"redirect_uri"`
ResponseType string `json:"response_type"`
Scope string `json:"scope"`
State string `json:"state"`
}
OktaEamAuthorizeRequest defines model for OktaEamAuthorizeRequest.
type OktaEamAuthorizeResponse ¶ added in v0.1.15
type OktaEamAuthorizeResponse struct {
Oauth2ClientId string `json:"oauth2_client_id"`
Oauth2RedirectUri string `json:"oauth2_redirect_uri"`
Oauth2Server string `json:"oauth2_server"`
Oauth2Template string `json:"oauth2_template"`
State string `json:"state"`
}
OktaEamAuthorizeResponse defines model for OktaEamAuthorizeResponse.
type OktaEamFinishAuditEvent ¶ added in v0.1.15
type OktaEamFinishAuditEvent struct {
Directory string `json:"directory"`
Request OktaEamFinishRequest `json:"request"`
Response OktaEamFinishResponse `json:"response"`
}
OktaEamFinishAuditEvent defines model for OktaEamFinishAuditEvent.
type OktaEamFinishRequest ¶ added in v0.1.15
type OktaEamFinishRequest struct {
Code *string `json:"code,omitempty"`
Error *string `json:"error,omitempty"`
State string `json:"state"`
}
OktaEamFinishRequest defines model for OktaEamFinishRequest.
type OktaEamFinishResponse ¶ added in v0.1.15
type OktaEamFinishResponse struct {
BindingFailed *bool `json:"binding_failed,omitempty"`
Code *string `json:"code,omitempty"`
Error *string `json:"error,omitempty"`
IDToken *string `json:"id_token,omitempty"`
Oauth2State *string `json:"oauth2_state,omitempty"`
RedirectUri *string `json:"redirect_uri,omitempty"`
RequestTimeout *bool `json:"request_timeout,omitempty"`
}
OktaEamFinishResponse defines model for OktaEamFinishResponse.
type Org ¶
type Org struct {
// Name The name of the organization, typically the name of your company
Name string `json:"name"`
Role Role `json:"role"`
// Envs A list of the environment IDs that you have access to.
Envs []string `json:"envs"`
}
Org defines model for Org.
type OrgMember ¶
type OrgMember struct {
// MemberID A unique identifier of the member.
MemberID string `json:"member_id"`
Role Role `json:"role"`
// Envs The list of environments the member has access to. If the list contains `*`, the member has access to all environments.
Envs []string `json:"envs"`
// Name The name of the member.
Name string `json:"name"`
// Email The email address of the member.
Email string `json:"email"`
// ProfilePicture The URL of the profile picture of the member.
ProfilePicture string `json:"profile_picture"`
// InvitePending True if the member has been invited to the organization but has not yet signed in.
InvitePending bool `json:"invite_pending"`
// RequestsCount The number of requests the member has sent.
RequestsCount *int `json:"requests_count,omitempty"`
// Principal The principal of this org member
Principal string `json:"principal"`
}
OrgMember defines model for OrgMember.
type OrgMemberInvitedAuditEvent ¶ added in v0.1.15
type OrgMemberInvitedAuditEvent struct {
Request InviteOrgMemberRequest `json:"request"`
}
OrgMemberInvitedAuditEvent defines model for OrgMemberInvitedAuditEvent.
type OrgMemberRemovedAuditEvent ¶ added in v0.1.18
type OrgMemberRemovedAuditEvent struct {
OrgMember string `json:"org_member"`
}
OrgMemberRemovedAuditEvent defines model for OrgMemberRemovedAuditEvent.
type OrgMemberUpdatedAuditEvent ¶ added in v0.1.15
type OrgMemberUpdatedAuditEvent struct {
OrgMember string `json:"org_member"`
Request UpdateOrgMemberRequest `json:"request"`
}
OrgMemberUpdatedAuditEvent defines model for OrgMemberUpdatedAuditEvent.
type OrgUpdateRequest ¶
type OrgUpdateRequest struct {
// Name The name of the organization, typically the name of your company
Name *string `json:"name,omitempty"`
AllowedIPAddresses *[]string `json:"allowed_ip_addresses,omitempty"`
}
OrgUpdateRequest defines model for OrgUpdateRequest.
type OrgUpdatedAuditEvent ¶ added in v0.1.15
type OrgUpdatedAuditEvent struct {
Request OrgUpdateRequest `json:"request"`
}
OrgUpdatedAuditEvent defines model for OrgUpdatedAuditEvent.
type PartialCredentials ¶
type PartialCredentials struct {
// Account * For Duo, the integration key
// * For Okta, this field should be blank
// * For Onelogin, the client ID, e.g. `98ea6e4f216f2fb4b69fff9b3a44842c38686ca685f3f55dc48c5d3fb1107be4`
Account string `json:"account"`
// Partition * For Duo, the API hostname, e.g. `api-33091yc9.duosecurity.com`.
// * For Okta, the service hostname, e.g. `your-company.okta.com`.
// * For Onelogin, the subdomain, e.g. `example.onelogin.com`.
Partition string `json:"partition"`
}
PartialCredentials defines model for PartialCredentials.
type PeopleCompareAuditEvent ¶ added in v0.1.15
type PeopleCompareAuditEvent struct {
Request SubjectComparisonRequest `json:"request"`
Response ComparisonResult `json:"response"`
}
PeopleCompareAuditEvent defines model for PeopleCompareAuditEvent.
type PollResponse ¶
type PollResponse struct {
Status AuthorizeStatus `json:"status"`
RedirectURI string `json:"redirect_uri,omitempty"`
WaitingForReview bool `json:"waiting_for_review,omitempty"`
LastEvent interface{} `json:"last_event,omitempty"`
}
PollResponse defines model for PollResponse.
type PresignRecoveryMicrositeURLJSONRequestBody ¶ added in v0.1.12
type PresignRecoveryMicrositeURLJSONRequestBody = RecoveryMicrositePresignRequest
PresignRecoveryMicrositeURLJSONRequestBody defines body for PresignRecoveryMicrositeURL for application/json ContentType.
type PresignRecoveryMicrositeURLResp ¶ added in v0.1.12
type PresignRecoveryMicrositeURLResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *RecoveryMicrositePresignResponse
JSON400 *N400
}
func ParsePresignRecoveryMicrositeURLResp ¶ added in v0.1.12
func ParsePresignRecoveryMicrositeURLResp(rsp *http.Response) (*PresignRecoveryMicrositeURLResp, error)
ParsePresignRecoveryMicrositeURLResp parses an HTTP response from a PresignRecoveryMicrositeURLWithResponse call
func (PresignRecoveryMicrositeURLResp) Status ¶ added in v0.1.12
func (r PresignRecoveryMicrositeURLResp) Status() string
Status returns HTTPResponse.Status
func (PresignRecoveryMicrositeURLResp) StatusCode ¶ added in v0.1.12
func (r PresignRecoveryMicrositeURLResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type Principal ¶ added in v0.1.15
type Principal struct {
Role Role `json:"role"`
// OrgMember The ID of the OrgMember for the console user performing the action
OrgMember *string `json:"org_member,omitempty"`
// OrgMemberEmail The email address associated with the OrgMember
OrgMemberEmail *string `json:"org_member_email,omitempty"`
// APIKeyID The ID of the APIKey for the actor performing the action.
APIKeyID *string `json:"api_key,omitempty"`
// Impersonator Present if the request was made by a Nametag administrator on behalf of the user. The value is the email address of the Nametag administrator performing the action.
Impersonator *string `json:"impersonator,omitempty"`
// Subject If the request was authenticated using an ID token, then this is the subject of the ID token.
Subject *string `json:"subject,omitempty"`
}
Principal defines model for Principal.
type PropertiesResponse ¶
type PropertiesResponse struct {
// Subject The subject of the request. This is the person whose properties are being requested.
Subject string `json:"subject"`
// Requests The requests that were made to get the properties.
Requests []PropertyResponseRequest `json:"requests"`
// Properties Properties of the person.
Properties []PropertyResponse `json:"properties"`
}
PropertiesResponse defines model for PropertiesResponse.
type PropertyResponse ¶
type PropertyResponse struct {
// Expires When your access to this data expires
Expires string `json:"expires,omitempty"`
// Scope Scopes are used to describe the information you want people to share with you. In order to request a scope you must first define it in your environment and provide additional parameters, such as what type of data and how long you need the data. This is done separately for each environment you manage in the Nametag console.
Scope *Scope `json:"scope,omitempty"`
// Claim Claims are used to describe the information you want people to share with you. In order to request a claim you must first define it in your environment and provide additional parameters, such as what type of data and how long you need the data. This is done separately for each environment you manage in the Nametag console.
Claim Claim `json:"claim"`
// Value The value of the property. The type of this field varies depending on the claim. See [this table](#scopes).
Value interface{} `json:"value,omitempty"`
// Status A value that tells you the disposition of the property. The value `200` means the data was shared. The value `403` means the data has not been shared, the person has revoked your access, or `410` meaning the request has expired.
Status int `json:"status"`
}
PropertyResponse defines model for PropertyResponse.
type PropertyResponseRequest ¶
type PropertyResponseRequest struct {
// ID A unique identifier for the request.
ID string `json:"id"`
// CreatedAt The time that the request was initiated
CreatedAt time.Time `json:"created_at"`
// Status The status of the request, 200 means accepted, 403 means rejected or canceled.
Status int `json:"status"`
// Scopes The scopes requested
Scopes *[]Scope `json:"scopes,omitempty"`
// Claims The claims requested
Claims []Claim `json:"claims"`
}
PropertyResponseRequest defines model for PropertyResponseRequest.
type PushedAuthorizationRequest ¶ added in v0.1.16
type PushedAuthorizationRequest struct {
// Claim Space-separated list of claims
Claim *[]Claim `json:"claim,omitempty"`
// ClientId The client ID
ClientId string `json:"client_id"`
// ClientSecret The client secret
ClientSecret string `json:"client_secret"`
// CodeChallenge The code challenge
CodeChallenge *string `json:"code_challenge,omitempty"`
// CodeChallengeMethod The code challenge method
CodeChallengeMethod *PushedAuthorizationRequestCodeChallengeMethod `json:"code_challenge_method,omitempty"`
// EmailHint The email hint
EmailHint *openapi_types.Email `json:"email_hint,omitempty"`
// ExpirySeconds The expiration time in seconds for the PAR
ExpirySeconds *int `json:"expiry_seconds,omitempty"`
// RedirectUri The redirect URI
RedirectUri string `json:"redirect_uri"`
// ResponseMode The response mode
ResponseMode *PushedAuthorizationRequestResponseMode `json:"response_mode,omitempty"`
// ResponseType The response type
ResponseType *PushedAuthorizationRequestResponseType `json:"response_type,omitempty"`
Return *AuthorizeReturn `json:"return,omitempty"`
// Scope Space-separated list of scopes
Scope *[]Scope `json:"scope,omitempty"`
// State The state
State string `json:"state"`
// Template The template to use
Template *string `json:"template,omitempty"`
}
PushedAuthorizationRequest defines model for PushedAuthorizationRequest.
type PushedAuthorizationRequestCodeChallengeMethod ¶ added in v0.1.16
type PushedAuthorizationRequestCodeChallengeMethod string
PushedAuthorizationRequestCodeChallengeMethod The code challenge method
const ( PushedAuthorizationRequestCodeChallengeMethodPlain PushedAuthorizationRequestCodeChallengeMethod = "plain" PushedAuthorizationRequestCodeChallengeMethodS256 PushedAuthorizationRequestCodeChallengeMethod = "S256" )
Defines values for PushedAuthorizationRequestCodeChallengeMethod.
type PushedAuthorizationRequestResponseMode ¶ added in v0.1.16
type PushedAuthorizationRequestResponseMode string
PushedAuthorizationRequestResponseMode The response mode
const (
PushedAuthorizationRequestResponseModeFragment PushedAuthorizationRequestResponseMode = "fragment"
)
Defines values for PushedAuthorizationRequestResponseMode.
type PushedAuthorizationRequestResponseType ¶ added in v0.1.16
type PushedAuthorizationRequestResponseType string
PushedAuthorizationRequestResponseType The response type
const (
PushedAuthorizationRequestResponseTypeCode PushedAuthorizationRequestResponseType = "code"
)
Defines values for PushedAuthorizationRequestResponseType.
type PushedAuthorizationResponse ¶ added in v0.1.16
type PushedAuthorizationResponse struct {
RequestURI string `json:"request_uri"`
ExpiresIn int `json:"expires_in"`
}
PushedAuthorizationResponse defines model for PushedAuthorizationResponse.
type RecoveryMicrositeFlow ¶ added in v0.1.12
type RecoveryMicrositeFlow string
RecoveryMicrositeFlow defines model for RecoveryMicrositeFlow.
const ( MicrositeFlowBadge RecoveryMicrositeFlow = "badge" RecoveryMicrositeFlowEnroll RecoveryMicrositeFlow = "enroll" RecoveryMicrositeFlowRecover RecoveryMicrositeFlow = "recover" )
Defines values for RecoveryMicrositeFlow.
type RecoveryMicrositeOperation ¶ added in v0.1.12
type RecoveryMicrositeOperation string
RecoveryMicrositeOperation defines model for RecoveryMicrositeOperation.
const ( Mfa RecoveryMicrositeOperation = "mfa" Password RecoveryMicrositeOperation = "password" TemporaryAccessPass RecoveryMicrositeOperation = "temporary-access-pass" Unlock RecoveryMicrositeOperation = "unlock" )
Defines values for RecoveryMicrositeOperation.
type RecoveryMicrositePresignRequest ¶ added in v0.1.12
type RecoveryMicrositePresignRequest struct {
// Email The email address or identifier of the account. Use `*` to allow the presigned URL
// to apply to any account.
Email *string `json:"email,omitempty"`
// Ttl The duration for which the presigned URL is valid. The duration is specified as a string
// in the format `1h30m` for 1 hour and 30 minutes, or `1m20s` for 1 minute and 20 seconds.
Ttl jsonx.Duration `json:"ttl"`
// Operations The operations that the presigned URL should allow.
Operations *[]RecoveryMicrositeOperation `json:"operations,omitempty"`
// Directories The identifiers of the directories that the presigned URL should apply to.
Directories *[]string `json:"directories,omitempty"`
Flow *RecoveryMicrositeFlow `json:"flow,omitempty"`
}
RecoveryMicrositePresignRequest defines model for RecoveryMicrositePresignRequest.
type RecoveryMicrositePresignResponse ¶ added in v0.1.12
type RecoveryMicrositePresignResponse struct {
Url string `json:"url"`
}
RecoveryMicrositePresignResponse defines model for RecoveryMicrositePresignResponse.
type RecoveryOperationRateLimit ¶ added in v0.1.18
type RecoveryOperationRateLimit struct {
// Count The number of operations allowed in the window.
Count int `json:"count"`
// Window The duration of the window. The duration is specified as a string
// in the format `1h30m` for 1 hour and 30 minutes, or `1m20s` for 1 minute and 20 seconds.
Window jsonx.Duration `json:"window"`
}
RecoveryOperationRateLimit defines model for RecoveryOperationRateLimit.
type RecoveryPolicy ¶
type RecoveryPolicy string
RecoveryPolicy defines model for RecoveryPolicy.
const ( RecoveryPolicyDisabled RecoveryPolicy = "disabled" RecoveryPolicyNameAndBirthDate RecoveryPolicy = "name_and_birth_date" RecoveryPolicyNameMatch RecoveryPolicy = "name_match" RecoveryPolicyPhoto RecoveryPolicy = "photo" RecoveryPolicyWeakNameMatch RecoveryPolicy = "weak_name_match" )
Defines values for RecoveryPolicy.
type RecoveryPolicyRules ¶
type RecoveryPolicyRules struct {
// Groups A list of policies to apply based on an Account's group membership.
// When Nametag evaluates policy, the first entry in this list that matches will be applied. If no group matches, then the default policy is applied.
Groups []GroupRecoveryPolicy `json:"groups"`
Default RecoveryPolicy `json:"default"`
}
RecoveryPolicyRules defines model for RecoveryPolicyRules.
type RefreshWebhookSecretJSONRequestBody ¶ added in v0.1.12
type RefreshWebhookSecretJSONRequestBody = RefreshWebhookSecretRequest
RefreshWebhookSecretJSONRequestBody defines body for RefreshWebhookSecret for application/json ContentType.
type RefreshWebhookSecretRequest ¶ added in v0.1.12
type RefreshWebhookSecretRequest struct {
// EnvID The environment identifier for which the webhook secret is to be refreshed
EnvID string `json:"envID"`
}
RefreshWebhookSecretRequest defines model for RefreshWebhookSecretRequest.
type RefreshWebhookSecretResp ¶ added in v0.1.12
type RefreshWebhookSecretResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *RefreshWebhookSecretResponse
JSON400 *N400
}
func ParseRefreshWebhookSecretResp ¶ added in v0.1.12
func ParseRefreshWebhookSecretResp(rsp *http.Response) (*RefreshWebhookSecretResp, error)
ParseRefreshWebhookSecretResp parses an HTTP response from a RefreshWebhookSecretWithResponse call
func (RefreshWebhookSecretResp) Status ¶ added in v0.1.12
func (r RefreshWebhookSecretResp) Status() string
Status returns HTTPResponse.Status
func (RefreshWebhookSecretResp) StatusCode ¶ added in v0.1.12
func (r RefreshWebhookSecretResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RefreshWebhookSecretResponse ¶ added in v0.1.12
type RefreshWebhookSecretResponse struct {
WebhookSharedSecret string `json:"webhook_shared_secret"`
}
RefreshWebhookSecretResponse defines model for RefreshWebhookSecretResponse.
type RegenerateDirectoryAgentTokenResp ¶ added in v0.1.16
type RegenerateDirectoryAgentTokenResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *RegenerateDirectoryAgentTokenResponse
JSON400 *N400
}
func ParseRegenerateDirectoryAgentTokenResp ¶ added in v0.1.16
func ParseRegenerateDirectoryAgentTokenResp(rsp *http.Response) (*RegenerateDirectoryAgentTokenResp, error)
ParseRegenerateDirectoryAgentTokenResp parses an HTTP response from a RegenerateDirectoryAgentTokenWithResponse call
func (RegenerateDirectoryAgentTokenResp) Status ¶ added in v0.1.16
func (r RegenerateDirectoryAgentTokenResp) Status() string
Status returns HTTPResponse.Status
func (RegenerateDirectoryAgentTokenResp) StatusCode ¶ added in v0.1.16
func (r RegenerateDirectoryAgentTokenResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RegenerateDirectoryAgentTokenResponse ¶ added in v0.1.16
type RegenerateDirectoryAgentTokenResponse struct {
AgentToken string `json:"agent_token"`
// ID The unique identifier for the directory.
ID string `json:"id"`
}
RegenerateDirectoryAgentTokenResponse defines model for RegenerateDirectoryAgentTokenResponse.
type RemoveOrgMemberResp ¶
func ParseRemoveOrgMemberResp ¶
func ParseRemoveOrgMemberResp(rsp *http.Response) (*RemoveOrgMemberResp, error)
ParseRemoveOrgMemberResp parses an HTTP response from a RemoveOrgMemberWithResponse call
func (RemoveOrgMemberResp) Status ¶
func (r RemoveOrgMemberResp) Status() string
Status returns HTTPResponse.Status
func (RemoveOrgMemberResp) StatusCode ¶
func (r RemoveOrgMemberResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type Request ¶
type Request struct {
// ID A unique identifier for this request
ID string `json:"id"`
// CreatedAt Timestamp of when this request was created
CreatedAt time.Time `json:"created_at"`
// UpdatedAt Timestamp of the last time this request was updated
UpdatedAt time.Time `json:"updated_at"`
// ExpiresAt Timestamp of when this request expires
ExpiresAt time.Time `json:"expires_at"`
// Ticket The request ticket (used to construct the link)
Ticket string `json:"ticket"`
// Link The URL which should be sent to the user. This link launches the mobile app and prompts the user to verify their identity.
Link string `json:"link"`
// Phone The phone number that will receive an authorization link via SMS
Phone *string `json:"phone,omitempty"`
// Env The ID of the environment associated with the request
Env string `json:"env"`
Template string `json:"template"`
// Label The label for the request; can be empty
Label string `json:"label"`
Scopes []Scope `json:"scopes"`
Claims []Claim `json:"claims"`
Status RequestStatus `json:"status"`
Progress RequestProgress `json:"progress"`
// Subject The subject of the request. Present only when `status` is `shared`. Use this as a parameter to [the properties endpoint](#get-properties) to fetch the data shared.
Subject *string `json:"subject,omitempty"`
// SubjectText A description of the subject (e.g. their name or email address) suitable for presentation in a user interface.
SubjectText *string `json:"subject_text,omitempty"`
// Requester The [member ID](#OrgMember) of the user that created this request. This field is absent for requests created via the API.
Requester *string `json:"requester,omitempty"`
// RequesterText A description of the requester suitable for presentation in a user interface (e.g. their name or email address)
RequesterText *string `json:"requester_text,omitempty"`
Properties RequestProperties `json:"properties"`
Mobile *RequestMobileDevice `json:"mobile,omitempty"`
Browser *RequestBrowser `json:"browser,omitempty"`
// IsKnownUser If the user is known as an account
IsKnownUser *bool `json:"is_known_user,omitempty"`
// Photo The photo associated with this person
Photo *string `json:"photo,omitempty"`
// ExternalIds External IDs for accounts if the user is known
ExternalIds *[]string `json:"external_ids,omitempty"`
// MarkedForDeletionAfter Indicates whether the person associated with this request has asked for their data to be deleted and the earliest time that will occur at.
MarkedForDeletionAfter *time.Time `json:"marked_for_deletion_after,omitempty"`
VerificationSource *RequestVerificationSource `json:"verification_source,omitempty"`
}
Request defines model for Request.
type RequestBrowser ¶
type RequestBrowser struct {
// UserAgent The browser's user agent
UserAgent string `json:"user_agent"`
// RemoteAddress The IP address of the browser (This field is `null` unless the `location:ip` claim is specified in the request)
RemoteAddress *string `json:"remote_address,omitempty"`
RemoteAddressLocation *Location `json:"remote_address_location,omitempty"`
}
RequestBrowser defines model for RequestBrowser.
type RequestCanceledAuditEvent ¶ added in v0.1.15
type RequestCanceledAuditEvent struct {
RequestID string `json:"request_id"`
}
RequestCanceledAuditEvent defines model for RequestCanceledAuditEvent.
type RequestCreatedAuditEvent ¶ added in v0.1.15
type RequestCreatedAuditEvent struct {
Request CreateRequestRequest `json:"request"`
Response CreateRequestResponse `json:"response"`
}
RequestCreatedAuditEvent defines model for RequestCreatedAuditEvent.
type RequestEditorFn ¶
RequestEditorFn is the function signature for the RequestEditor callback function
type RequestMobileDevice ¶
type RequestMobileDevice struct {
// OS The full operating system name and version of the mobile device
OS string `json:"os"`
// Version The version of the Nametag app
Version string `json:"version"`
// IOS `true` if the device is an iOS device, otherwise `false`
IOS bool `json:"ios"`
// Android `true` if the device is an Android device, otherwise `false`
Android bool `json:"android"`
// FullApp `true` if the request was completed in the full Nametag app, otherwise `false`
FullApp bool `json:"full_app"`
// AppClip `true` if the request was completed in the iOS app clip, otherwise `false`
AppClip bool `json:"app_clip"`
// InstantApp `true` if the request was completed in the Android instant app, otherwise `false`
InstantApp bool `json:"instant_app"`
// RemoteAddress The IP address of the mobile device (This field is `null` unless the `location:ip` claim is specified in the request)
RemoteAddress *string `json:"remote_address,omitempty"`
RemoteAddressLocation *Location `json:"remote_address_location,omitempty"`
}
RequestMobileDevice defines model for RequestMobileDevice.
type RequestProgress ¶
type RequestProgress string
RequestProgress defines model for RequestProgress.
const ( RequestProgressAppOpened RequestProgress = "app_opened" RequestProgressConsentGiven RequestProgress = "consent_given" RequestProgressFaceScanned RequestProgress = "face_scanned" RequestProgressIDScanned RequestProgress = "id_scanned" RequestProgressInit RequestProgress = "created" RequestProgressLinkOpened RequestProgress = "link_opened" )
Defines values for RequestProgress.
type RequestProperties ¶
type RequestProperties struct {
// Phone The person's phone number
Phone *string `json:"phone,omitempty"`
// LegalName The person's name from their identity document
LegalName *string `json:"legal_name,omitempty"`
// LegalFirstName The given name (first name) from their identity document
LegalFirstName *string `json:"legal_first_name,omitempty"`
// LegalLastName The family name (last name) from their identity document
LegalLastName *string `json:"legal_last_name,omitempty"`
// Name The person's name from their identity document
Name *string `json:"name,omitempty"`
// FirstName The person's given (first) name from their identity document
FirstName *string `json:"first_name,omitempty"`
// LastName The person's family (last) name from their identity document
LastName *string `json:"last_name,omitempty"`
// BirthDate The person's date of birth
BirthDate *openapi_types.Date `json:"birth_date,omitempty"`
// Email Verified email address
Email *openapi_types.Email `json:"email,omitempty"`
// UnverifiedEmail The email address provided by a user but not verified
UnverifiedEmail *openapi_types.Email `json:"unverified_email,omitempty"`
// AgeOver18 `true` if the person is over 18 years old, otherwise `false`
AgeOver18 *bool `json:"age_over_18,omitempty"`
// AgeOver21 `true` if the person is over 21 years old, otherwise `false`
AgeOver21 *bool `json:"age_over_21,omitempty"`
// ProfilePicture A URL to the person's preferred profile picture. Nametag checks that the image provided is the same person as pictured on their identity document.
ProfilePicture *string `json:"profile_picture,omitempty"`
// Address Verified postal address
Address *string `json:"address,omitempty"`
Govtid *GovtidValue `json:"govtid,omitempty"`
// GovtidExpired `true` if we have a govtid expiration date and it is past that date; `false` if we either can't get an expiration date or it is not expired.
GovtidExpired *bool `json:"govtid_Expired,omitempty"`
Account *AccountValue `json:"account,omitempty"`
}
RequestProperties defines model for RequestProperties.
type RequestStatus ¶
type RequestStatus string
RequestStatus defines model for RequestStatus.
const ( RequestStatusCancelled RequestStatus = "cancelled" RequestStatusExpired RequestStatus = "expired" RequestStatusExpiredScopes RequestStatus = "expired_scopes" RequestStatusInProgress RequestStatus = "in_progress" RequestStatusPending RequestStatus = "pending" RequestStatusPersonDeleted RequestStatus = "person_deleted" RequestStatusRejectedFraud RequestStatus = "rejected_fraud" RequestStatusRejectedInReview RequestStatus = "rejected_appealed" RequestStatusRejectedUnusable RequestStatus = "rejected_unusable" RequestStatusRevoked RequestStatus = "revoked" )
Defines values for RequestStatus.
type RequestUpdatedAuditEvent ¶ added in v0.1.15
type RequestUpdatedAuditEvent struct {
RequestID string `json:"request_id"`
Request UpdateRequestRequest `json:"request"`
}
RequestUpdatedAuditEvent defines model for RequestUpdatedAuditEvent.
type RequestVerificationSource ¶ added in v0.1.18
type RequestVerificationSource string
RequestVerificationSource defines model for RequestVerificationSource.
const ( RequestVerificationSourceExpressReverification RequestVerificationSource = "express_reverification" RequestVerificationSourceFullIDV RequestVerificationSource = "full_idv" )
Defines values for RequestVerificationSource.
type Scope ¶
type Scope string
Scope Scopes are used to describe the information you want people to share with you. In order to request a scope you must first define it in your environment and provide additional parameters, such as what type of data and how long you need the data. This is done separately for each environment you manage in the Nametag console.
const ( NtAddress Scope = "nt:address" NtAgeOver18 Scope = "nt:age_over_18" NtAgeOver21 Scope = "nt:age_over_21" NtBirthDate Scope = "nt:birth_date" NtEmail Scope = "nt:email" NtEmailUnverified Scope = "nt:email:unverified" NtFirstName Scope = "nt:first_name" NtGovtidDetails Scope = "nt:govtid_details" NtLastName Scope = "nt:last_name" NtLegalFirstName Scope = "nt:legal_first_name" NtLegalLastName Scope = "nt:legal_last_name" NtLegalName Scope = "nt:legal_name" NtLocationGps Scope = "nt:location:gps" NtLocationIp Scope = "nt:location:ip" NtName Scope = "nt:name" NtPhone Scope = "nt:phone" NtProfilePicture Scope = "nt:profile_picture" Openid Scope = "openid" )
Defines values for Scope.
type SelfieCompareAuditEvent ¶ added in v0.1.15
type SelfieCompareAuditEvent struct {
Response CompareSelfieResult `json:"response"`
Subject string `json:"subject"`
}
SelfieCompareAuditEvent defines model for SelfieCompareAuditEvent.
type SetDirectoryCredentialsJSONRequestBody ¶
type SetDirectoryCredentialsJSONRequestBody = Credentials
SetDirectoryCredentialsJSONRequestBody defines body for SetDirectoryCredentials for application/json ContentType.
type SetDirectoryCredentialsResp ¶
func ParseSetDirectoryCredentialsResp ¶
func ParseSetDirectoryCredentialsResp(rsp *http.Response) (*SetDirectoryCredentialsResp, error)
ParseSetDirectoryCredentialsResp parses an HTTP response from a SetDirectoryCredentialsWithResponse call
func (SetDirectoryCredentialsResp) Status ¶
func (r SetDirectoryCredentialsResp) Status() string
Status returns HTTPResponse.Status
func (SetDirectoryCredentialsResp) StatusCode ¶
func (r SetDirectoryCredentialsResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type SharingRevokedAuditEvent ¶ added in v0.1.15
type SharingRevokedAuditEvent struct {
Claims []Claim `json:"claims"`
Scopes *[]Scope `json:"scopes,omitempty"`
Subject string `json:"subject"`
}
SharingRevokedAuditEvent defines model for SharingRevokedAuditEvent.
type SlackIntegration ¶ added in v0.1.17
type SlackIntegration struct {
// ID The unique identifier for the Slack integration
ID string `json:"id"`
// Name The name of the Slack workspace associated with this integration.
Name string `json:"name"`
// Icon The URL for the icon of the Slack workspace associated with this integration.
Icon string `json:"icon"`
// Connected Whether or not this integration is connected to Nametag. If this is `false`, there may be issues with the auth token that Nametag has that can be solved by reconnecting this workspace.
Connected bool `json:"connected"`
}
SlackIntegration defines model for SlackIntegration.
type SlackRequestDetailsResponse ¶ added in v0.1.17
type SlackRequestDetailsResponse struct {
OrgMember OrgMember `json:"orgMember"`
Request Request `json:"request"`
}
SlackRequestDetailsResponse defines model for SlackRequestDetailsResponse.
type SubjectComparisonRequest ¶
type SubjectComparisonRequest struct {
// Expectations A list of expectations to compare against the person's properties.
Expectations []Expectation `json:"expectations"`
}
SubjectComparisonRequest defines model for SubjectComparisonRequest.
type SyncDirectoryResp ¶
func ParseSyncDirectoryResp ¶
func ParseSyncDirectoryResp(rsp *http.Response) (*SyncDirectoryResp, error)
ParseSyncDirectoryResp parses an HTTP response from a SyncDirectoryWithResponse call
func (SyncDirectoryResp) Status ¶
func (r SyncDirectoryResp) Status() string
Status returns HTTPResponse.Status
func (SyncDirectoryResp) StatusCode ¶
func (r SyncDirectoryResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type Template ¶
type Template struct {
// ID A unique identifier for the template
ID string `json:"id"`
// CreatedAt When the template was created
CreatedAt time.Time `json:"created_at"`
// Name A descriptive name of the template
Name string `json:"name"`
// Headline The text that appears at the top of the mobile app when showing the request
Headline string `json:"headline"`
// QrHeadline The text that appears above the QR code when directing the user from desktop to mobile.
QrHeadline string `json:"qr_headline"`
// ExpirationText The text that describes when the request expires. This should include `{{.TTL}}` which is a placeholder for the expiration of the data sharing authorization in human-readable form, e.g. "3 hours"
ExpirationText string `json:"expiration_text"`
// AcceptText The text on the accept button in the mobile app.
AcceptText string `json:"accept_text"`
// AcceptedText The text that appears on the confirmation view after a request has been accepted.
AcceptedText string `json:"accepted_text"`
// InstallMessageSMS The contents of the SMS message sent to users to direct them to the mobile app. This must contain the `{{.Link}}` which is a placeholder for the actual link.
InstallMessageSMS string `json:"install_message_sms"`
// IsDefault If true then this is the default template used when a template is not explicitly specified. There must be exactly one default template.
IsDefault bool `json:"is_default"`
// ScopeDefinitions A list of scopes that are requested when requests are created with this template.
ScopeDefinitions []TemplateScopeDefinition `json:"scope_definitions"`
// ScopesExpireIn How long the data sharing authorization should last, in seconds.
ScopesExpireIn int `json:"scopes_expire_in"`
// ClaimDefinitions A list of claims that are requested when requests are created with this template.
ClaimDefinitions []TemplateClaimDefinition `json:"claim_definitions"`
// ClaimsExpireIn How long the data sharing authorization should last, in seconds.
ClaimsExpireIn int `json:"claims_expire_in"`
// Enabled If true, then this template is enabled for requests. The default template must be enabled.
Enabled bool `json:"enabled"`
// RequireSelfieReverification If true, existing users must provide a new selfie to validate their identity.
RequireSelfieReverification bool `json:"require_selfie_reverification"`
// QRCustomText The text that appears below the desktop QR page headline.
QRCustomText string `json:"qr_custom_text"`
}
Template defines model for Template.
type TemplateClaimDefinition ¶ added in v0.1.16
type TemplateClaimDefinition struct {
// Claim Claims are used to describe the information you want people to share with you. In order to request a claim you must first define it in your environment and provide additional parameters, such as what type of data and how long you need the data. This is done separately for each environment you manage in the Nametag console.
Claim Claim `json:"claim"`
}
TemplateClaimDefinition defines model for TemplateClaimDefinition.
type TemplateCreatedAuditEvent ¶ added in v0.1.15
type TemplateCreatedAuditEvent struct {
Request CreateTemplateRequest `json:"request"`
Response CreateTemplateResponse `json:"response"`
}
TemplateCreatedAuditEvent defines model for TemplateCreatedAuditEvent.
type TemplateDeletedAuditEvent ¶ added in v0.1.15
type TemplateDeletedAuditEvent struct {
Template string `json:"template"`
}
TemplateDeletedAuditEvent defines model for TemplateDeletedAuditEvent.
type TemplateScopeDefinition ¶
type TemplateScopeDefinition struct {
// Scope Scopes are used to describe the information you want people to share with you. In order to request a scope you must first define it in your environment and provide additional parameters, such as what type of data and how long you need the data. This is done separately for each environment you manage in the Nametag console.
Scope Scope `json:"scope"`
// RestrictEmailDomains If the scope definition is for nt:email or similar, require that the email domain match one of the provided values. If the scope definition is not for email, or if the list is empty, then emails from any domain are allowed.
RestrictEmailDomains []string `json:"restrict_email_domains,omitempty"`
}
TemplateScopeDefinition defines model for TemplateScopeDefinition.
type TemplateUpdatedAuditEvent ¶ added in v0.1.15
type TemplateUpdatedAuditEvent struct {
Request UpdateTemplateRequest `json:"request"`
Template string `json:"template"`
}
TemplateUpdatedAuditEvent defines model for TemplateUpdatedAuditEvent.
type TokenRequest ¶
type TokenRequest struct {
GrantType TokenRequestGrantType `json:"grant_type"`
ClientID string `json:"client_id"`
ClientSecret string `json:"client_secret"`
RedirectURI string `json:"redirect_uri"`
Code string `json:"code"`
CodeVerifier *string `json:"code_verifier,omitempty"`
}
TokenRequest defines model for TokenRequest.
type TokenRequestGrantType ¶
type TokenRequestGrantType string
TokenRequestGrantType defines model for TokenRequest.GrantType.
const (
AuthorizationCode TokenRequestGrantType = "authorization_code"
)
Defines values for TokenRequestGrantType.
type TokenResponse ¶
type TokenResponse struct {
AccessToken string `json:"access_token"`
RefreshToken string `json:"refresh_token"`
IDToken string `json:"id_token"`
Scope string `json:"scope"`
Claims string `json:"claims"`
ExpiresIn int `json:"expires_in"`
TokenType TokenResponseTokenType `json:"token_type"`
Subject string `json:"subject"`
}
TokenResponse defines model for TokenResponse.
type TokenResponseError ¶
type TokenResponseError struct {
Code string `json:"error"`
ErrorDescription string `json:"error_description,omitempty"`
URI string `json:"uri,omitempty"`
}
TokenResponseError defines model for TokenResponseError.
type TokenResponseTokenType ¶
type TokenResponseTokenType string
TokenResponseTokenType defines model for TokenResponse.TokenType.
const (
TokenTypeBearer TokenResponseTokenType = "Bearer"
)
Defines values for TokenResponseTokenType.
type UpdateAPIKeyJSONRequestBody ¶
type UpdateAPIKeyJSONRequestBody = APIKeyUpdateRequest
UpdateAPIKeyJSONRequestBody defines body for UpdateAPIKey for application/json ContentType.
type UpdateAPIKeyResp ¶
func ParseUpdateAPIKeyResp ¶
func ParseUpdateAPIKeyResp(rsp *http.Response) (*UpdateAPIKeyResp, error)
ParseUpdateAPIKeyResp parses an HTTP response from a UpdateAPIKeyWithResponse call
func (UpdateAPIKeyResp) Status ¶
func (r UpdateAPIKeyResp) Status() string
Status returns HTTPResponse.Status
func (UpdateAPIKeyResp) StatusCode ¶
func (r UpdateAPIKeyResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateAccountJSONRequestBody ¶
type UpdateAccountJSONRequestBody = AccountUpdateRequest
UpdateAccountJSONRequestBody defines body for UpdateAccount for application/json ContentType.
type UpdateAccountResp ¶
func ParseUpdateAccountResp ¶
func ParseUpdateAccountResp(rsp *http.Response) (*UpdateAccountResp, error)
ParseUpdateAccountResp parses an HTTP response from a UpdateAccountWithResponse call
func (UpdateAccountResp) Status ¶
func (r UpdateAccountResp) Status() string
Status returns HTTPResponse.Status
func (UpdateAccountResp) StatusCode ¶
func (r UpdateAccountResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateDirectoryJSONRequestBody ¶ added in v0.1.12
type UpdateDirectoryJSONRequestBody = UpdateDirectoryRequest
UpdateDirectoryJSONRequestBody defines body for UpdateDirectory for application/json ContentType.
type UpdateDirectoryRequest ¶ added in v0.1.12
type UpdateDirectoryRequest struct {
AuthenticatePolicy *RecoveryPolicyRules `json:"authenticate_policy,omitempty"`
PasswordPolicy *RecoveryPolicyRules `json:"password_policy,omitempty"`
MfaPolicy *RecoveryPolicyRules `json:"mfa_policy,omitempty"`
UnlockPolicy *RecoveryPolicyRules `json:"unlock_policy,omitempty"`
TemporaryAccessPassPolicy *RecoveryPolicyRules `json:"temporary_access_pass_policy,omitempty"`
// TemporaryAccessPassLifetimeMinutes The validity period of a temporary access pass in minutes
TemporaryAccessPassLifetimeMinutes *int `json:"temporary_access_pass_lifetime_minutes,omitempty"`
// TemporaryAccessPassReusable True if temporary access passes can be used more than once
TemporaryAccessPassReusable *bool `json:"temporary_access_pass_reusable,omitempty"`
// BirthDateHMACSecret A shared secret for hashed birth dates in the directory
BirthDateHMACSecret []byte `json:"birth_date_hmac_secret,omitempty"`
RecoveryOperationRateLimit *RecoveryOperationRateLimit `json:"recovery_operation_rate_limit,omitempty"`
}
UpdateDirectoryRequest defines model for UpdateDirectoryRequest.
type UpdateDirectoryResp ¶ added in v0.1.12
type UpdateDirectoryResp struct {
Body []byte
HTTPResponse *http.Response
JSON204 *Directory
JSON400 *N400
}
func ParseUpdateDirectoryResp ¶ added in v0.1.12
func ParseUpdateDirectoryResp(rsp *http.Response) (*UpdateDirectoryResp, error)
ParseUpdateDirectoryResp parses an HTTP response from a UpdateDirectoryWithResponse call
func (UpdateDirectoryResp) Status ¶ added in v0.1.12
func (r UpdateDirectoryResp) Status() string
Status returns HTTPResponse.Status
func (UpdateDirectoryResp) StatusCode ¶ added in v0.1.12
func (r UpdateDirectoryResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateEnvJSONRequestBody ¶
type UpdateEnvJSONRequestBody = EnvUpdateRequest
UpdateEnvJSONRequestBody defines body for UpdateEnv for application/json ContentType.
type UpdateEnvResp ¶
func ParseUpdateEnvResp ¶
func ParseUpdateEnvResp(rsp *http.Response) (*UpdateEnvResp, error)
ParseUpdateEnvResp parses an HTTP response from a UpdateEnvWithResponse call
func (UpdateEnvResp) Status ¶
func (r UpdateEnvResp) Status() string
Status returns HTTPResponse.Status
func (UpdateEnvResp) StatusCode ¶
func (r UpdateEnvResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateOrgJSONRequestBody ¶
type UpdateOrgJSONRequestBody = OrgUpdateRequest
UpdateOrgJSONRequestBody defines body for UpdateOrg for application/json ContentType.
type UpdateOrgMemberJSONRequestBody ¶
type UpdateOrgMemberJSONRequestBody = UpdateOrgMemberRequest
UpdateOrgMemberJSONRequestBody defines body for UpdateOrgMember for application/json ContentType.
type UpdateOrgMemberRequest ¶
type UpdateOrgMemberRequest struct {
// Envs The list of environments the member will have access to. If the list contains `*`, the member will have access
// to all environments.
Envs []string `json:"envs,omitempty"`
Role *Role `json:"role,omitempty"`
}
UpdateOrgMemberRequest defines model for UpdateOrgMemberRequest.
type UpdateOrgMemberResp ¶
func ParseUpdateOrgMemberResp ¶
func ParseUpdateOrgMemberResp(rsp *http.Response) (*UpdateOrgMemberResp, error)
ParseUpdateOrgMemberResp parses an HTTP response from a UpdateOrgMemberWithResponse call
func (UpdateOrgMemberResp) Status ¶
func (r UpdateOrgMemberResp) Status() string
Status returns HTTPResponse.Status
func (UpdateOrgMemberResp) StatusCode ¶
func (r UpdateOrgMemberResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateOrgResp ¶
func ParseUpdateOrgResp ¶
func ParseUpdateOrgResp(rsp *http.Response) (*UpdateOrgResp, error)
ParseUpdateOrgResp parses an HTTP response from a UpdateOrgWithResponse call
func (UpdateOrgResp) Status ¶
func (r UpdateOrgResp) Status() string
Status returns HTTPResponse.Status
func (UpdateOrgResp) StatusCode ¶
func (r UpdateOrgResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateRequestJSONRequestBody ¶
type UpdateRequestJSONRequestBody = UpdateRequestRequest
UpdateRequestJSONRequestBody defines body for UpdateRequest for application/json ContentType.
type UpdateRequestRequest ¶
type UpdateRequestRequest struct {
// Label An internal label for this request. You can use this field to help you track the request in your own systems. Nametag stores this field, but does not process it.
Label *string `json:"label,omitempty"`
}
UpdateRequestRequest defines model for UpdateRequestRequest.
type UpdateRequestResp ¶
func ParseUpdateRequestResp ¶
func ParseUpdateRequestResp(rsp *http.Response) (*UpdateRequestResp, error)
ParseUpdateRequestResp parses an HTTP response from a UpdateRequestWithResponse call
func (UpdateRequestResp) Status ¶
func (r UpdateRequestResp) Status() string
Status returns HTTPResponse.Status
func (UpdateRequestResp) StatusCode ¶
func (r UpdateRequestResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateTemplateJSONRequestBody ¶
type UpdateTemplateJSONRequestBody = UpdateTemplateRequest
UpdateTemplateJSONRequestBody defines body for UpdateTemplate for application/json ContentType.
type UpdateTemplateRequest ¶
type UpdateTemplateRequest struct {
// Name A descriptive name of the template
Name *string `json:"name,omitempty"`
// Headline The text that appears at the top of the mobile app when showing the request
Headline *string `json:"headline,omitempty"`
// QrHeadline The text that appears above the QR code when directing the user from desktop to mobile.
QrHeadline *string `json:"qr_headline,omitempty"`
// ExpirationText The text that describes when the request expires. This should include `{{.TTL}}` which is a placeholder for the expiration of the data sharing authorization in human-readable form, e.g. "3 hours"
ExpirationText *string `json:"expiration_text,omitempty"`
// AcceptText The text on the accept button in the mobile app.
AcceptText *string `json:"accept_text,omitempty"`
// AcceptedText The text that appears on the confirmation view after a request has been accepted.
AcceptedText *string `json:"accepted_text,omitempty"`
// InstallMessageSMS The contents of the SMS message sent to users to direct them to the mobile app. This must contain the `{{.Link}}` which is a placeholder for the actual link.
InstallMessageSMS *string `json:"install_message_sms,omitempty"`
// IsDefault If true then this is the default template used when a template is not explicitly specified. There must be exactly one default template.
IsDefault *bool `json:"is_default,omitempty"`
// ScopeDefinitions A list of scopes that are requested when requests are created with this template.
ScopeDefinitions []TemplateScopeDefinition `json:"scope_definitions,omitempty"`
// ScopesExpireIn How long the data sharing authorization should last, in seconds.
ScopesExpireIn *int `json:"scopes_expire_in,omitempty"`
// ClaimDefinitions A list of scopes that are requested when requests are created with this template.
ClaimDefinitions []TemplateClaimDefinition `json:"claim_definitions,omitempty"`
// ClaimsExpireIn How long the data sharing authorization should last, in seconds.
ClaimsExpireIn *int `json:"claims_expire_in,omitempty"`
// Enabled If true, then this template is enabled for requests. The default template must be enabled.
Enabled *bool `json:"enabled,omitempty"`
// RequireSelfieReverification If true, existing users must provide a new selfie to validate their identity.
RequireSelfieReverification *bool `json:"require_selfie_reverification,omitempty"`
// QRCustomText The text that appears below the desktop QR page headline.
QRCustomText *string `json:"qr_custom_text,omitempty"`
}
UpdateTemplateRequest defines model for UpdateTemplateRequest.
type UpdateTemplateResp ¶
func ParseUpdateTemplateResp ¶
func ParseUpdateTemplateResp(rsp *http.Response) (*UpdateTemplateResp, error)
ParseUpdateTemplateResp parses an HTTP response from a UpdateTemplateWithResponse call
func (UpdateTemplateResp) Status ¶
func (r UpdateTemplateResp) Status() string
Status returns HTTPResponse.Status
func (UpdateTemplateResp) StatusCode ¶
func (r UpdateTemplateResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UploadAccountPhotoResp ¶
func ParseUploadAccountPhotoResp ¶
func ParseUploadAccountPhotoResp(rsp *http.Response) (*UploadAccountPhotoResp, error)
ParseUploadAccountPhotoResp parses an HTTP response from a UploadAccountPhotoWithResponse call
func (UploadAccountPhotoResp) Status ¶
func (r UploadAccountPhotoResp) Status() string
Status returns HTTPResponse.Status
func (UploadAccountPhotoResp) StatusCode ¶
func (r UploadAccountPhotoResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UploadDirectoryLogoMultipartBody ¶ added in v0.1.16
type UploadDirectoryLogoMultipartBody struct {
Logo *openapi_types.File `json:"logo,omitempty"`
}
UploadDirectoryLogoMultipartBody defines parameters for UploadDirectoryLogo.
type UploadDirectoryLogoMultipartRequestBody ¶ added in v0.1.16
type UploadDirectoryLogoMultipartRequestBody UploadDirectoryLogoMultipartBody
UploadDirectoryLogoMultipartRequestBody defines body for UploadDirectoryLogo for multipart/form-data ContentType.
type UploadDirectoryLogoResp ¶ added in v0.1.16
func ParseUploadDirectoryLogoResp ¶ added in v0.1.16
func ParseUploadDirectoryLogoResp(rsp *http.Response) (*UploadDirectoryLogoResp, error)
ParseUploadDirectoryLogoResp parses an HTTP response from a UploadDirectoryLogoWithResponse call
func (UploadDirectoryLogoResp) Status ¶ added in v0.1.16
func (r UploadDirectoryLogoResp) Status() string
Status returns HTTPResponse.Status
func (UploadDirectoryLogoResp) StatusCode ¶ added in v0.1.16
func (r UploadDirectoryLogoResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UploadLogoMultipartBody ¶
type UploadLogoMultipartBody struct {
Logo *openapi_types.File `json:"logo,omitempty"`
}
UploadLogoMultipartBody defines parameters for UploadLogo.
type UploadLogoMultipartRequestBody ¶
type UploadLogoMultipartRequestBody UploadLogoMultipartBody
UploadLogoMultipartRequestBody defines body for UploadLogo for multipart/form-data ContentType.
type UploadLogoParams ¶
type UploadLogoParams struct {
// Kind The kind of logo to upload
Kind *LogoKind `form:"kind,omitempty" json:"kind,omitempty"`
}
UploadLogoParams defines parameters for UploadLogo.
type UploadLogoResp ¶
func ParseUploadLogoResp ¶
func ParseUploadLogoResp(rsp *http.Response) (*UploadLogoResp, error)
ParseUploadLogoResp parses an HTTP response from a UploadLogoWithResponse call
func (UploadLogoResp) Status ¶
func (r UploadLogoResp) Status() string
Status returns HTTPResponse.Status
func (UploadLogoResp) StatusCode ¶
func (r UploadLogoResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type Webhook ¶
type Webhook struct {
ID string `json:"id"`
Status int `json:"status"`
URL string `json:"url"`
Body string `json:"body"`
RequestHeader []WebhookHeader `json:"request_header"`
Attempts []WebhookAttempt `json:"attempts"`
}
Webhook defines model for Webhook.
type WebhookAttempt ¶
type WebhookAttempt struct {
StartTime time.Time `json:"start_time"`
EndTime time.Time `json:"end_time"`
Status int `json:"status"`
Header []WebhookHeader `json:"header"`
Body string `json:"body"`
Error string `json:"error,omitempty"`
}
WebhookAttempt defines model for WebhookAttempt.
type WebhookDefinition ¶
type WebhookDefinition struct {
// ID A unique identifier for the webhook definition.
ID string `json:"id"`
// URL The URL in your service that should be called, e.g. `https://example.com/__callback`
URL string `json:"url"`
// Enabled If true, then calls to this webhook should be made.
Enabled bool `json:"enabled"`
// Events The names of the events that should be sent.
Events []WebhookEventType `json:"events"`
// AuthorizationHeader The value of the Authorization header to include in the webhook request.
AuthorizationHeader *string `json:"authorization_header,omitempty"`
}
WebhookDefinition defines model for WebhookDefinition.
type WebhookDefinitionUpdate ¶
type WebhookDefinitionUpdate struct {
ID string `json:"id"`
URL *string `json:"url,omitempty"`
Enabled *bool `json:"enabled,omitempty"`
Events []WebhookEventType `json:"events,omitempty"`
// AuthorizationHeader The value of the Authorization header to include in the webhook request.
AuthorizationHeader *string `json:"authorization_header,omitempty"`
}
WebhookDefinitionUpdate defines model for WebhookDefinitionUpdate.
type WebhookEventType ¶
type WebhookEventType string
WebhookEventType defines model for WebhookEventType.
const ( WebhookEventTypeAudit WebhookEventType = "audit" WebhookEventTypeDirectoryProviderErr WebhookEventType = "directory_provider_err" WebhookEventTypePicture WebhookEventType = "picture" WebhookEventTypeRecover WebhookEventType = "recover" WebhookEventTypeReject WebhookEventType = "reject" WebhookEventTypeRequest WebhookEventType = "request" )
Defines values for WebhookEventType.
type WebhookHeader ¶
WebhookHeader defines model for WebhookHeader.
Source Files
Click to show internal directories.
Click to hide internal directories.