authentication

type Client struct {
	// contains filtered or unexported fields
}

type CreateAccountFederationPolicyRequest struct {
	// The account id for the federation policy.
	AccountId *string
	// The service principal id for the federation policy.
	ServicePrincipalId *int64
	// The identifier for the federation policy. The identifier must contain only
	// lowercase alphanumeric characters, numbers, hyphens, and slashes. If
	// unspecified, the id will be assigned by <Databricks>.
	PolicyId *string
	Policy   *FederationPolicy
}

type CreateServicePrincipalFederationPolicyRequest struct {
	// The account id for the federation policy.
	AccountId *string
	// The service principal id for the federation policy.
	ServicePrincipalId *int64
	// The identifier for the federation policy. The identifier must contain only
	// lowercase alphanumeric characters, numbers, hyphens, and slashes. If
	// unspecified, the id will be assigned by <Databricks>.
	PolicyId *string
	Policy   *FederationPolicy
}

type CreateServicePrincipalSecretRequest struct {
	// The account ID.
	AccountId *string
	// The service principal ID.
	ServicePrincipal *string
	// The lifetime of the secret in seconds. If this parameter is not provided, the
	// secret will have a default lifetime of 730 days (63072000s).
	Lifetime *types.Duration
}

type CreateServicePrincipalSecretResponse struct {
	// ID of the secret
	Id *string
	// Secret Value
	Secret *string
	// Secret Hash
	SecretHash *string
	// UTC time when the secret was created
	CreateTime *string
	// UTC time when the secret was updated
	UpdateTime *string
	// Status of the secret
	Status *string
	// UTC time when the secret will expire. If the field is not present, the secret
	// does not expire.
	ExpireTime *types.Time
}

type DeleteAccountFederationPolicyRequest struct {
	// The account id for the federation policy.
	AccountId *string
	// The service principal id for the federation policy.
	ServicePrincipalId *int64
	// The identifier for the federation policy.
	PolicyId *string
}

type DeleteServicePrincipalFederationPolicyRequest struct {
	// The account id for the federation policy.
	AccountId *string
	// The service principal id for the federation policy.
	ServicePrincipalId *int64
	// The identifier for the federation policy.
	PolicyId *string
}

type DeleteServicePrincipalSecretRequest struct {
	// The account ID.
	AccountId *string
	// The service principal ID.
	ServicePrincipal *string
	// The secret ID.
	SecretId *string
}

type DeleteServicePrincipalSecretResponse struct {
}

type FederationPolicy struct {
	// Resource name for the federation policy. Example values include
	// `accounts/<account-id>/federationPolicies/my-federation-policy` for Account
	// Federation Policies, and
	// `accounts/<account-id>/servicePrincipals/<service-principal-id>/federationPolicies/my-federation-policy`
	// for Service Principal Federation Policies. Typically an output parameter,
	// which does not need to be specified in create or update requests. If
	// specified in a request, must match the value in the request URL.
	Name *string `fieldmask:"name"`
	// Description of the federation policy.
	Description *string `fieldmask:"description"`
	Policy      isFederationPolicy_Policy
	// Creation time of the federation policy.
	CreateTime *types.Time `fieldmask:"create_time"`
	// Last update time of the federation policy.
	UpdateTime *types.Time `fieldmask:"update_time"`
	// Unique, immutable id of the federation policy.
	Uid *string `fieldmask:"uid"`
	// The service principal ID that this federation policy applies to. Output only.
	// Only set for service principal federation policies.
	ServicePrincipalId *int64 `fieldmask:"service_principal_id"`
	// The ID of the federation policy. Output only.
	PolicyId *string `fieldmask:"policy_id"`
	// contains filtered or unexported fields
}

type FederationPolicy_Policy_OidcPolicy struct {
	OidcPolicy OidcFederationPolicy `fieldmask:"oidc_policy"`
}

type GetAccountFederationPolicyRequest struct {
	// The account id for the federation policy.
	AccountId *string
	// The service principal id for the federation policy.
	ServicePrincipalId *int64
	// The identifier for the federation policy.
	PolicyId *string
}

type GetServicePrincipalFederationPolicyRequest struct {
	// The account id for the federation policy.
	AccountId *string
	// The service principal id for the federation policy.
	ServicePrincipalId *int64
	// The identifier for the federation policy.
	PolicyId *string
}

type ListAccountFederationPoliciesRequest struct {
	// The account id for the federation policy.
	AccountId *string
	// The service principal id for the federation policy.
	ServicePrincipalId *int64
	PageSize           *int
	PageToken          *string
}

type ListFederationPoliciesResponse struct {
	Policies      []FederationPolicy
	NextPageToken *string
}

type ListServicePrincipalFederationPoliciesRequest struct {
	// The account id for the federation policy.
	AccountId *string
	// The service principal id for the federation policy.
	ServicePrincipalId *int64
	PageSize           *int
	PageToken          *string
}

type ListServicePrincipalSecretsRequest struct {
	// The account ID.
	AccountId *string
	// The service principal ID.
	ServicePrincipal *string
	// An opaque page token which was the `next_page_token` in the response of the
	// previous request to list the secrets for this service principal. Provide this
	// token to retrieve the next page of secret entries. When providing a
	// `page_token`, all other parameters provided to the request must match the
	// previous request. To list all of the secrets for a service principal, it is
	// necessary to continue requesting pages of entries until the response contains
	// no `next_page_token`. Note that the number of entries returned must not be
	// used to determine when the listing is complete.
	PageToken *string
	PageSize  *int
}

type ListServicePrincipalSecretsResponse struct {
	// List of the secrets
	Secrets []ServicePrincipalSecret
	// A token, which can be sent as `page_token` to retrieve the next page.
	NextPageToken *string
}

type OidcFederationPolicy struct {
	// The required token issuer, as specified in the 'iss' claim of federated
	// tokens.
	Issuer *string `fieldmask:"issuer"`
	// The required token subject, as specified in the subject claim of federated
	// tokens. Must be specified for service principal federation policies. Must not
	// be specified for account federation policies.
	Subject *string `fieldmask:"subject"`
	// The allowed token audiences, as specified in the 'aud' claim of federated
	// tokens. The audience identifier is intended to represent the recipient of the
	// token. Can be any non-empty string value. As long as the audience in the
	// token matches at least one audience in the policy, the token is considered a
	// match. If audiences is unspecified, defaults to your <Databricks> account id.
	Audiences []string `fieldmask:"audiences"`
	// The claim that contains the subject of the token. If unspecified, the default
	// value is 'sub'.
	SubjectClaim *string `fieldmask:"subject_claim"`
	// URL of the public keys used to validate the signature of federated tokens, in
	// JWKS format. Most use cases should not need to specify this field. If
	// jwks_uri and jwks_json are both unspecified (recommended), <Databricks>
	// automatically fetches the public keys from your issuer’s well known
	// endpoint. Databricks strongly recommends relying on your issuer’s well
	// known endpoint for discovering public keys.
	JwksUri *string `fieldmask:"jwks_uri"`
	// The public keys used to validate the signature of federated tokens, in JWKS
	// format. Most use cases should not need to specify this field. If jwks_uri and
	// jwks_json are both unspecified (recommended), <Databricks> automatically
	// fetches the public keys from your issuer’s well known endpoint. Databricks
	// strongly recommends relying on your issuer’s well known endpoint for
	// discovering public keys.
	JwksJson *string `fieldmask:"jwks_json"`
}

type ServicePrincipalSecret struct {
	// ID of the secret
	Id *string
	// Secret Value
	Secret *string
	// Secret Hash
	SecretHash *string
	// UTC time when the secret was created
	CreateTime *string
	// UTC time when the secret was updated
	UpdateTime *string
	// Status of the secret
	Status *string
	// UTC time when the secret will expire. If the field is not present, the secret
	// does not expire.
	ExpireTime *types.Time
}

type UpdateAccountFederationPolicyRequest struct {
	// The account id for the federation policy.
	AccountId *string
	// The service principal id for the federation policy.
	ServicePrincipalId *int64
	// The identifier for the federation policy.
	PolicyId *string
	Policy   *FederationPolicy
	// The field mask specifies which fields of the policy to update. To specify
	// multiple fields in the field mask, use comma as the separator (no space). The
	// special value '*' indicates that all fields should be updated (full
	// replacement). If unspecified, all fields that are set in the policy provided
	// in the update request will overwrite the corresponding fields in the existing
	// policy. Example value: 'description,oidc_policy.audiences'.
	UpdateMask *types.FieldMask[FederationPolicy]
}

type UpdateServicePrincipalFederationPolicyRequest struct {
	// The account id for the federation policy.
	AccountId *string
	// The service principal id for the federation policy.
	ServicePrincipalId *int64
	// The identifier for the federation policy.
	PolicyId *string
	Policy   *FederationPolicy
	// The field mask specifies which fields of the policy to update. To specify
	// multiple fields in the field mask, use comma as the separator (no space). The
	// special value '*' indicates that all fields should be updated (full
	// replacement). If unspecified, all fields that are set in the policy provided
	// in the update request will overwrite the corresponding fields in the existing
	// policy. Example value: 'description,oidc_policy.audiences'.
	UpdateMask *types.FieldMask[FederationPolicy]
}