Documentation
¶
Index ¶
- type AccountComplexValue
- type AccountGetSortOrder
- type AccountGetSortOrder_GetSortOrder
- type AccountGroup
- type AccountListSort
- type AccountListSort_Order
- type AccountName
- type AccountPatch
- type AccountPatchOp
- type AccountPatchOp_PatchOp
- type AccountPatchSchema
- type AccountPatchSchema_PatchSchema
- type AccountResourceMeta
- type AccountServicePrincipal
- type AccountUser
- type Client
- func (c *Client) CreateAccountGroup(ctx context.Context, req CreateAccountGroupRequest, opts ...call.Option) (*AccountGroup, error)
- func (c *Client) CreateAccountServicePrincipal(ctx context.Context, req CreateAccountServicePrincipalRequest, ...) (*AccountServicePrincipal, error)
- func (c *Client) CreateAccountUser(ctx context.Context, req CreateAccountUserRequest, opts ...call.Option) (*AccountUser, error)
- func (c *Client) CreateGroup(ctx context.Context, req CreateGroupRequest, opts ...call.Option) (*Group, error)
- func (c *Client) CreateServicePrincipal(ctx context.Context, req CreateServicePrincipalRequest, opts ...call.Option) (*ServicePrincipal, error)
- func (c *Client) CreateUser(ctx context.Context, req CreateUserRequest, opts ...call.Option) (*User, error)
- func (c *Client) DeleteAccountGroup(ctx context.Context, req DeleteAccountGroupRequest, opts ...call.Option) error
- func (c *Client) DeleteAccountServicePrincipal(ctx context.Context, req DeleteAccountServicePrincipalRequest, ...) error
- func (c *Client) DeleteAccountUser(ctx context.Context, req DeleteAccountUserRequest, opts ...call.Option) error
- func (c *Client) DeleteGroup(ctx context.Context, req DeleteGroupRequest, opts ...call.Option) error
- func (c *Client) DeleteServicePrincipal(ctx context.Context, req DeleteServicePrincipalRequest, opts ...call.Option) error
- func (c *Client) DeleteUser(ctx context.Context, req DeleteUserRequest, opts ...call.Option) error
- func (c *Client) GetAccountGroup(ctx context.Context, req GetAccountGroupRequest, opts ...call.Option) (*AccountGroup, error)
- func (c *Client) GetAccountServicePrincipal(ctx context.Context, req GetAccountServicePrincipalRequest, ...) (*AccountServicePrincipal, error)
- func (c *Client) GetAccountUser(ctx context.Context, req GetAccountUserRequest, opts ...call.Option) (*AccountUser, error)
- func (c *Client) GetGroup(ctx context.Context, req GetGroupRequest, opts ...call.Option) (*Group, error)
- func (c *Client) GetPermissionLevels(ctx context.Context, req GetPasswordPermissionLevelsRequest, ...) (*GetPasswordPermissionLevelsResponse, error)
- func (c *Client) GetPermissions(ctx context.Context, req GetPasswordPermissionsRequest, opts ...call.Option) (*PasswordPermissions, error)
- func (c *Client) GetServicePrincipal(ctx context.Context, req GetServicePrincipalRequest, opts ...call.Option) (*ServicePrincipal, error)
- func (c *Client) GetUser(ctx context.Context, req GetUserRequest, opts ...call.Option) (*User, error)
- func (c *Client) ListAccountGroups(ctx context.Context, req ListAccountGroupsRequest, opts ...call.Option) (*ListAccountGroupsResponse, error)
- func (c *Client) ListAccountGroupsIter(ctx context.Context, req ListAccountGroupsRequest, opts ...call.Option) iter.Seq2[*AccountGroup, error]
- func (c *Client) ListAccountServicePrincipals(ctx context.Context, req ListAccountServicePrincipalsRequest, ...) (*ListAccountServicePrincipalsResponse, error)
- func (c *Client) ListAccountServicePrincipalsIter(ctx context.Context, req ListAccountServicePrincipalsRequest, ...) iter.Seq2[*AccountServicePrincipal, error]
- func (c *Client) ListAccountUsers(ctx context.Context, req ListAccountUsersRequest, opts ...call.Option) (*ListAccountUsersResponse, error)
- func (c *Client) ListAccountUsersIter(ctx context.Context, req ListAccountUsersRequest, opts ...call.Option) iter.Seq2[*AccountUser, error]
- func (c *Client) ListGroups(ctx context.Context, req ListGroupsRequest, opts ...call.Option) (*ListGroupsResponse, error)
- func (c *Client) ListGroupsIter(ctx context.Context, req ListGroupsRequest, opts ...call.Option) iter.Seq2[*Group, error]
- func (c *Client) ListServicePrincipals(ctx context.Context, req ListServicePrincipalsRequest, opts ...call.Option) (*ListServicePrincipalResponse, error)
- func (c *Client) ListServicePrincipalsIter(ctx context.Context, req ListServicePrincipalsRequest, opts ...call.Option) iter.Seq2[*ServicePrincipal, error]
- func (c *Client) ListUsers(ctx context.Context, req ListUsersRequest, opts ...call.Option) (*ListUsersResponse, error)
- func (c *Client) ListUsersIter(ctx context.Context, req ListUsersRequest, opts ...call.Option) iter.Seq2[*User, error]
- func (c *Client) Me(ctx context.Context, req MeRequest, opts ...call.Option) (*User, error)
- func (c *Client) PatchAccountGroup(ctx context.Context, req PatchAccountGroupRequest, opts ...call.Option) error
- func (c *Client) PatchAccountServicePrincipal(ctx context.Context, req PatchAccountServicePrincipalRequest, ...) error
- func (c *Client) PatchAccountUser(ctx context.Context, req PatchAccountUserRequest, opts ...call.Option) error
- func (c *Client) PatchGroup(ctx context.Context, req PatchGroupRequest, opts ...call.Option) error
- func (c *Client) PatchServicePrincipal(ctx context.Context, req PatchServicePrincipalRequest, opts ...call.Option) error
- func (c *Client) PatchUser(ctx context.Context, req PatchUserRequest, opts ...call.Option) error
- func (c *Client) SetPermissions(ctx context.Context, req PasswordPermissionsRequest, opts ...call.Option) (*PasswordPermissions, error)
- func (c *Client) UpdateAccountGroup(ctx context.Context, req UpdateAccountGroupRequest, opts ...call.Option) error
- func (c *Client) UpdateAccountServicePrincipal(ctx context.Context, req UpdateAccountServicePrincipalRequest, ...) error
- func (c *Client) UpdateAccountUser(ctx context.Context, req UpdateAccountUserRequest, opts ...call.Option) error
- func (c *Client) UpdateGroup(ctx context.Context, req UpdateGroupRequest, opts ...call.Option) error
- func (c *Client) UpdatePermissions(ctx context.Context, req PasswordPermissionsRequest, opts ...call.Option) (*PasswordPermissions, error)
- func (c *Client) UpdateServicePrincipal(ctx context.Context, req UpdateServicePrincipalRequest, opts ...call.Option) error
- func (c *Client) UpdateUser(ctx context.Context, req UpdateUserRequest, opts ...call.Option) error
- type ComplexValue
- type CreateAccountGroupRequest
- type CreateAccountServicePrincipalRequest
- type CreateAccountUserRequest
- type CreateGroupRequest
- type CreateServicePrincipalRequest
- type CreateUserRequest
- type DeleteAccountGroupRequest
- type DeleteAccountServicePrincipalRequest
- type DeleteAccountUserRequest
- type DeleteGroupRequest
- type DeleteServicePrincipalRequest
- type DeleteUserRequest
- type GetAccountGroupRequest
- type GetAccountServicePrincipalRequest
- type GetAccountUserRequest
- type GetGroupRequest
- type GetPasswordPermissionLevelsRequest
- type GetPasswordPermissionLevelsResponse
- type GetPasswordPermissionsRequest
- type GetServicePrincipalRequest
- type GetSortOrder
- type GetUserRequest
- type Group
- type GroupSchema
- type ListAccountGroupsRequest
- type ListAccountGroupsResponse
- type ListAccountServicePrincipalsRequest
- type ListAccountServicePrincipalsResponse
- type ListAccountUsersRequest
- type ListAccountUsersResponse
- type ListGroupsRequest
- type ListGroupsResponse
- type ListResponseSchema
- type ListServicePrincipalResponse
- type ListServicePrincipalsRequest
- type ListSort
- type ListSort_Order
- type ListUsersRequest
- type ListUsersResponse
- type MeRequest
- type Name
- type PasswordAccessControlRequest
- type PasswordAccessControlResponse
- type PasswordPermission
- type PasswordPermission_Level
- type PasswordPermissions
- type PasswordPermissionsDescription
- type PasswordPermissionsRequest
- type Patch
- type PatchAccountGroupRequest
- type PatchAccountServicePrincipalRequest
- type PatchAccountUserRequest
- type PatchGroupRequest
- type PatchOp
- type PatchSchema
- type PatchServicePrincipalRequest
- type PatchUserRequest
- type ResourceMeta
- type ServicePrincipal
- type ServicePrincipalSchema
- type UpdateAccountGroupRequest
- type UpdateAccountServicePrincipalRequest
- type UpdateAccountUserRequest
- type UpdateGroupRequest
- type UpdateServicePrincipalRequest
- type UpdateUserRequest
- type User
- type UserSchema
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccountComplexValue ¶
type AccountGetSortOrder ¶
type AccountGetSortOrder struct {
}
type AccountGetSortOrder_GetSortOrder ¶
type AccountGetSortOrder_GetSortOrder string
const ( AccountGetSortOrder_GetSortOrder_Unspecified AccountGetSortOrder_GetSortOrder = "" AccountGetSortOrder_GetSortOrder_Ascending AccountGetSortOrder_GetSortOrder = "ascending" AccountGetSortOrder_GetSortOrder_Descending AccountGetSortOrder_GetSortOrder = "descending" )
type AccountGroup ¶
type AccountGroup struct {
// String that represents a human-readable group name
DisplayName *string
// external_id should be unique for identifying groups
ExternalId *string
// <Databricks> group ID
Id *string
Members []AccountComplexValue
// Container for the group identifier. Workspace local versus account.
Meta *AccountResourceMeta
// Indicates if the group has the admin role.
Roles []AccountComplexValue
// <Databricks> account ID
AccountId *string
}
type AccountListSort ¶
type AccountListSort struct {
}
ListSortOrder and GetSortOrder share enum values, which is not supported. We use nesting as a workaround..
type AccountListSort_Order ¶
type AccountListSort_Order string
const ( AccountListSort_Order_Unspecified AccountListSort_Order = "" AccountListSort_Order_Ascending AccountListSort_Order = "ascending" AccountListSort_Order_Descending AccountListSort_Order = "descending" )
type AccountName ¶
type AccountPatch ¶
type AccountPatch struct {
// Type of patch operation.
Op AccountPatchOp_PatchOp
// Selection of patch operation
Path *string
// Value to modify
Value json.RawMessage
}
type AccountPatchOp ¶
type AccountPatchOp struct {
}
type AccountPatchOp_PatchOp ¶
type AccountPatchOp_PatchOp string
Type of patch operation.
const ( AccountPatchOp_PatchOp_Unspecified AccountPatchOp_PatchOp = "" AccountPatchOp_PatchOp_Add AccountPatchOp_PatchOp = "add" AccountPatchOp_PatchOp_Remove AccountPatchOp_PatchOp = "remove" AccountPatchOp_PatchOp_Replace AccountPatchOp_PatchOp = "replace" )
type AccountPatchSchema ¶
type AccountPatchSchema struct {
}
type AccountPatchSchema_PatchSchema ¶
type AccountPatchSchema_PatchSchema string
const ( AccountPatchSchema_PatchSchema_Unspecified AccountPatchSchema_PatchSchema = "" AccountPatchSchema_PatchSchema_UrnIetfParamsScimApiMessages20PatchOp AccountPatchSchema_PatchSchema = "urn:ietf:params:scim:api:messages:2.0:PatchOp" )
type AccountResourceMeta ¶
type AccountResourceMeta struct {
// Identifier for group type. Can be local workspace group (`WorkspaceGroup`) or
// account group (`Group`).
ResourceType *string
}
type AccountServicePrincipal ¶
type AccountServicePrincipal struct {
// If this user is active
Active *bool
// UUID relating to the service principal
ApplicationId *string
// String that represents a concatenation of given and family names.
DisplayName *string
ExternalId *string
// <Databricks> service principal ID.
Id *string
// Indicates if the group has the admin role.
Roles []AccountComplexValue
// <Databricks> account ID
AccountId *string
}
type AccountUser ¶
type AccountUser struct {
// If this user is active
Active *bool
// String that represents a concatenation of given and family names. For example
// `John Smith`.
DisplayName *string
// All the emails associated with the <Databricks> user. This attribute cannot
// be updated through the SCIM PATCH or PUT APIs; any supplied change is
// ignored.
Emails []AccountComplexValue
// External ID is not currently supported. It is reserved for future use.
ExternalId *string
// <Databricks> user ID.
Id *string
Name *AccountName
// Indicates if the group has the admin role.
Roles []AccountComplexValue
// Email address of the <Databricks> user. This attribute cannot be updated
// through the SCIM PATCH or PUT APIs; any supplied change is ignored.
UserName *string
// <Databricks> account ID
AccountId *string
}
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func (*Client) CreateAccountGroup ¶
func (c *Client) CreateAccountGroup(ctx context.Context, req CreateAccountGroupRequest, opts ...call.Option) (*AccountGroup, error)
Creates a group in the <Databricks> account with a unique name, using the supplied group details. Account-level method. Uses the Client's accountID, overridable per call via req.AccountId.
func (*Client) CreateAccountServicePrincipal ¶
func (c *Client) CreateAccountServicePrincipal(ctx context.Context, req CreateAccountServicePrincipalRequest, opts ...call.Option) (*AccountServicePrincipal, error)
Creates a new service principal in the <Databricks> account. Account-level method. Uses the Client's accountID, overridable per call via req.AccountId.
func (*Client) CreateAccountUser ¶
func (c *Client) CreateAccountUser(ctx context.Context, req CreateAccountUserRequest, opts ...call.Option) (*AccountUser, error)
Creates a new user in the <Databricks> account. This new user will also be added to the <Databricks> account. Account-level method. Uses the Client's accountID, overridable per call via req.AccountId.
func (*Client) CreateGroup ¶
func (c *Client) CreateGroup(ctx context.Context, req CreateGroupRequest, opts ...call.Option) (*Group, error)
Creates a group in the <Databricks> workspace with a unique name, using the supplied group details.
func (*Client) CreateServicePrincipal ¶
func (c *Client) CreateServicePrincipal(ctx context.Context, req CreateServicePrincipalRequest, opts ...call.Option) (*ServicePrincipal, error)
Creates a new service principal in the <Databricks> workspace.
func (*Client) CreateUser ¶
func (c *Client) CreateUser(ctx context.Context, req CreateUserRequest, opts ...call.Option) (*User, error)
Creates a new user in the <Databricks> workspace. This new user will also be added to the <Databricks> account.
func (*Client) DeleteAccountGroup ¶
func (c *Client) DeleteAccountGroup(ctx context.Context, req DeleteAccountGroupRequest, opts ...call.Option) error
Deletes a group from the <Databricks> account. Account-level method. Uses the Client's accountID, overridable per call via req.AccountId.
func (*Client) DeleteAccountServicePrincipal ¶
func (c *Client) DeleteAccountServicePrincipal(ctx context.Context, req DeleteAccountServicePrincipalRequest, opts ...call.Option) error
Delete a single service principal in the <Databricks> account. Account-level method. Uses the Client's accountID, overridable per call via req.AccountId.
func (*Client) DeleteAccountUser ¶
func (c *Client) DeleteAccountUser(ctx context.Context, req DeleteAccountUserRequest, opts ...call.Option) error
Deletes a user. Deleting a user from a <Databricks> account also removes objects associated with the user. Account-level method. Uses the Client's accountID, overridable per call via req.AccountId.
func (*Client) DeleteGroup ¶
func (c *Client) DeleteGroup(ctx context.Context, req DeleteGroupRequest, opts ...call.Option) error
Deletes a group from the <Databricks> workspace.
func (*Client) DeleteServicePrincipal ¶
func (c *Client) DeleteServicePrincipal(ctx context.Context, req DeleteServicePrincipalRequest, opts ...call.Option) error
Delete a single service principal in the <Databricks> workspace.
func (*Client) DeleteUser ¶
Deletes a user. Deleting a user from a <Databricks> workspace also removes objects associated with the user.
func (*Client) GetAccountGroup ¶
func (c *Client) GetAccountGroup(ctx context.Context, req GetAccountGroupRequest, opts ...call.Option) (*AccountGroup, error)
Gets the information for a specific group in the <Databricks> account. Account-level method. Uses the Client's accountID, overridable per call via req.AccountId.
func (*Client) GetAccountServicePrincipal ¶
func (c *Client) GetAccountServicePrincipal(ctx context.Context, req GetAccountServicePrincipalRequest, opts ...call.Option) (*AccountServicePrincipal, error)
Gets the details for a single service principal define in the <Databricks> account. Account-level method. Uses the Client's accountID, overridable per call via req.AccountId.
func (*Client) GetAccountUser ¶
func (c *Client) GetAccountUser(ctx context.Context, req GetAccountUserRequest, opts ...call.Option) (*AccountUser, error)
Gets information for a specific user in <Databricks> account. Account-level method. Uses the Client's accountID, overridable per call via req.AccountId.
func (*Client) GetGroup ¶
func (c *Client) GetGroup(ctx context.Context, req GetGroupRequest, opts ...call.Option) (*Group, error)
Gets the information for a specific group in the <Databricks> workspace.
func (*Client) GetPermissionLevels ¶
func (c *Client) GetPermissionLevels(ctx context.Context, req GetPasswordPermissionLevelsRequest, opts ...call.Option) (*GetPasswordPermissionLevelsResponse, error)
Gets the permission levels that a user can have on an object.
func (*Client) GetPermissions ¶
func (c *Client) GetPermissions(ctx context.Context, req GetPasswordPermissionsRequest, opts ...call.Option) (*PasswordPermissions, error)
Gets the permissions of all passwords. Passwords can inherit permissions from their root object.
func (*Client) GetServicePrincipal ¶
func (c *Client) GetServicePrincipal(ctx context.Context, req GetServicePrincipalRequest, opts ...call.Option) (*ServicePrincipal, error)
Gets the details for a single service principal define in the <Databricks> workspace.
func (*Client) GetUser ¶
func (c *Client) GetUser(ctx context.Context, req GetUserRequest, opts ...call.Option) (*User, error)
Gets information for a specific user in <Databricks> workspace.
func (*Client) ListAccountGroups ¶
func (c *Client) ListAccountGroups(ctx context.Context, req ListAccountGroupsRequest, opts ...call.Option) (*ListAccountGroupsResponse, error)
Gets all details of the groups associated with the <Databricks> account. As of 08/22/2025, this endpoint will no longer return members. Instead, members should be retrieved by iterating through `Get group details`. Existing accounts that rely on this attribute will not be impacted and will continue receiving member data as before. Account-level method. Uses the Client's accountID, overridable per call via req.AccountId.
func (*Client) ListAccountGroupsIter ¶
func (c *Client) ListAccountGroupsIter(ctx context.Context, req ListAccountGroupsRequest, opts ...call.Option) iter.Seq2[*AccountGroup, error]
ListAccountGroupsIter returns an iterator that iterates over the results of ListAccountGroups.
For example:
for item, err := range c.ListAccountGroupsIter(ctx, ListAccountGroupsRequest{}) {
if err != nil {
return err
}
fmt.Println(item)
}
Options opts are passed to each ListAccountGroups call made by the iterator under the hood.
Callers who need custom pagination logic should use ListAccountGroups directly.
func (*Client) ListAccountServicePrincipals ¶
func (c *Client) ListAccountServicePrincipals(ctx context.Context, req ListAccountServicePrincipalsRequest, opts ...call.Option) (*ListAccountServicePrincipalsResponse, error)
Gets the set of service principals associated with a <Databricks> account. Account-level method. Uses the Client's accountID, overridable per call via req.AccountId.
func (*Client) ListAccountServicePrincipalsIter ¶
func (c *Client) ListAccountServicePrincipalsIter(ctx context.Context, req ListAccountServicePrincipalsRequest, opts ...call.Option) iter.Seq2[*AccountServicePrincipal, error]
ListAccountServicePrincipalsIter returns an iterator that iterates over the results of ListAccountServicePrincipals.
For example:
for item, err := range c.ListAccountServicePrincipalsIter(ctx, ListAccountServicePrincipalsRequest{}) {
if err != nil {
return err
}
fmt.Println(item)
}
Options opts are passed to each ListAccountServicePrincipals call made by the iterator under the hood.
Callers who need custom pagination logic should use ListAccountServicePrincipals directly.
func (*Client) ListAccountUsers ¶
func (c *Client) ListAccountUsers(ctx context.Context, req ListAccountUsersRequest, opts ...call.Option) (*ListAccountUsersResponse, error)
Gets details for all the users associated with a <Databricks> account. Account-level method. Uses the Client's accountID, overridable per call via req.AccountId.
func (*Client) ListAccountUsersIter ¶
func (c *Client) ListAccountUsersIter(ctx context.Context, req ListAccountUsersRequest, opts ...call.Option) iter.Seq2[*AccountUser, error]
ListAccountUsersIter returns an iterator that iterates over the results of ListAccountUsers.
For example:
for item, err := range c.ListAccountUsersIter(ctx, ListAccountUsersRequest{}) {
if err != nil {
return err
}
fmt.Println(item)
}
Options opts are passed to each ListAccountUsers call made by the iterator under the hood.
Callers who need custom pagination logic should use ListAccountUsers directly.
func (*Client) ListGroups ¶
func (c *Client) ListGroups(ctx context.Context, req ListGroupsRequest, opts ...call.Option) (*ListGroupsResponse, error)
Gets all details of the groups associated with the <Databricks> workspace.
func (*Client) ListGroupsIter ¶
func (c *Client) ListGroupsIter(ctx context.Context, req ListGroupsRequest, opts ...call.Option) iter.Seq2[*Group, error]
ListGroupsIter returns an iterator that iterates over the results of ListGroups.
For example:
for item, err := range c.ListGroupsIter(ctx, ListGroupsRequest{}) {
if err != nil {
return err
}
fmt.Println(item)
}
Options opts are passed to each ListGroups call made by the iterator under the hood.
Callers who need custom pagination logic should use ListGroups directly.
func (*Client) ListServicePrincipals ¶
func (c *Client) ListServicePrincipals(ctx context.Context, req ListServicePrincipalsRequest, opts ...call.Option) (*ListServicePrincipalResponse, error)
Gets the set of service principals associated with a <Databricks> workspace.
func (*Client) ListServicePrincipalsIter ¶
func (c *Client) ListServicePrincipalsIter(ctx context.Context, req ListServicePrincipalsRequest, opts ...call.Option) iter.Seq2[*ServicePrincipal, error]
ListServicePrincipalsIter returns an iterator that iterates over the results of ListServicePrincipals.
For example:
for item, err := range c.ListServicePrincipalsIter(ctx, ListServicePrincipalsRequest{}) {
if err != nil {
return err
}
fmt.Println(item)
}
Options opts are passed to each ListServicePrincipals call made by the iterator under the hood.
Callers who need custom pagination logic should use ListServicePrincipals directly.
func (*Client) ListUsers ¶
func (c *Client) ListUsers(ctx context.Context, req ListUsersRequest, opts ...call.Option) (*ListUsersResponse, error)
Gets details for all the users associated with a <Databricks> workspace.
func (*Client) ListUsersIter ¶
func (c *Client) ListUsersIter(ctx context.Context, req ListUsersRequest, opts ...call.Option) iter.Seq2[*User, error]
ListUsersIter returns an iterator that iterates over the results of ListUsers.
For example:
for item, err := range c.ListUsersIter(ctx, ListUsersRequest{}) {
if err != nil {
return err
}
fmt.Println(item)
}
Options opts are passed to each ListUsers call made by the iterator under the hood.
Callers who need custom pagination logic should use ListUsers directly.
func (*Client) PatchAccountGroup ¶
func (c *Client) PatchAccountGroup(ctx context.Context, req PatchAccountGroupRequest, opts ...call.Option) error
Partially updates the details of a group. Account-level method. Uses the Client's accountID, overridable per call via req.AccountId.
func (*Client) PatchAccountServicePrincipal ¶
func (c *Client) PatchAccountServicePrincipal(ctx context.Context, req PatchAccountServicePrincipalRequest, opts ...call.Option) error
Partially updates the details of a single service principal in the <Databricks> account. Account-level method. Uses the Client's accountID, overridable per call via req.AccountId.
func (*Client) PatchAccountUser ¶
func (c *Client) PatchAccountUser(ctx context.Context, req PatchAccountUserRequest, opts ...call.Option) error
Partially updates a user resource by applying the supplied operations on specific user attributes. The `userName` and `emails` attributes cannot be updated through this API; any supplied changes to them are ignored (no-op). Account-level method. Uses the Client's accountID, overridable per call via req.AccountId.
func (*Client) PatchGroup ¶
Partially updates the details of a group.
func (*Client) PatchServicePrincipal ¶
func (c *Client) PatchServicePrincipal(ctx context.Context, req PatchServicePrincipalRequest, opts ...call.Option) error
Partially updates the details of a single service principal in the <Databricks> workspace.
func (*Client) PatchUser ¶
Partially updates a user resource by applying the supplied operations on specific user attributes. The `userName` and `emails` attributes cannot be updated through this API; any supplied changes to them are ignored (no-op).
func (*Client) SetPermissions ¶
func (c *Client) SetPermissions(ctx context.Context, req PasswordPermissionsRequest, opts ...call.Option) (*PasswordPermissions, error)
Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object.
func (*Client) UpdateAccountGroup ¶
func (c *Client) UpdateAccountGroup(ctx context.Context, req UpdateAccountGroupRequest, opts ...call.Option) error
Updates the details of a group by replacing the entire group entity. Account-level method. Uses the Client's accountID, overridable per call via req.AccountId.
func (*Client) UpdateAccountServicePrincipal ¶
func (c *Client) UpdateAccountServicePrincipal(ctx context.Context, req UpdateAccountServicePrincipalRequest, opts ...call.Option) error
Updates the details of a single service principal.
This action replaces the existing service principal with the same name. Account-level method. Uses the Client's accountID, overridable per call via req.AccountId.
func (*Client) UpdateAccountUser ¶
func (c *Client) UpdateAccountUser(ctx context.Context, req UpdateAccountUserRequest, opts ...call.Option) error
Replaces a user's information with the data supplied in request. The `userName` and `emails` attributes cannot be updated through this API; any supplied changes to them are ignored (no-op). Account-level method. Uses the Client's accountID, overridable per call via req.AccountId.
func (*Client) UpdateGroup ¶
func (c *Client) UpdateGroup(ctx context.Context, req UpdateGroupRequest, opts ...call.Option) error
Updates the details of a group by replacing the entire group entity.
func (*Client) UpdatePermissions ¶
func (c *Client) UpdatePermissions(ctx context.Context, req PasswordPermissionsRequest, opts ...call.Option) (*PasswordPermissions, error)
Updates the permissions on all passwords. Passwords can inherit permissions from their root object.
func (*Client) UpdateServicePrincipal ¶
func (c *Client) UpdateServicePrincipal(ctx context.Context, req UpdateServicePrincipalRequest, opts ...call.Option) error
Updates the details of a single service principal.
This action replaces the existing service principal with the same name.
func (*Client) UpdateUser ¶
Replaces a user's information with the data supplied in request. The `userName` and `emails` attributes cannot be updated through this API; any supplied changes to them are ignored (no-op).
type ComplexValue ¶
type CreateAccountGroupRequest ¶
type CreateAccountGroupRequest struct {
// String that represents a human-readable group name
DisplayName *string
ExternalId *string
// <Databricks> group ID
Id *string
Members []AccountComplexValue
// Container for the group identifier. Workspace local versus account.
Meta *AccountResourceMeta
// Indicates if the group has the admin role.
Roles []AccountComplexValue
// <Databricks> account ID
AccountId *string
}
type CreateAccountServicePrincipalRequest ¶
type CreateAccountServicePrincipalRequest struct {
// If this user is active
Active *bool
// UUID relating to the service principal
ApplicationId *string
// String that represents a concatenation of given and family names.
DisplayName *string
ExternalId *string
// <Databricks> service principal ID.
Id *string
// Indicates if the group has the admin role.
Roles []AccountComplexValue
// <Databricks> account ID
AccountId *string
}
type CreateAccountUserRequest ¶
type CreateAccountUserRequest struct {
// If this user is active
Active *bool
// String that represents a concatenation of given and family names. For example
// `John Smith`.
DisplayName *string
// All the emails associated with the <Databricks> user.
Emails []AccountComplexValue
// External ID is not currently supported. It is reserved for future use.
ExternalId *string
// <Databricks> user ID.
Id *string
Name *AccountName
// Indicates if the group has the admin role.
Roles []AccountComplexValue
// Email address of the <Databricks> user.
UserName *string
// <Databricks> account ID
AccountId *string
}
type CreateGroupRequest ¶
type CreateGroupRequest struct {
// String that represents a human-readable group name
DisplayName *string
// Entitlements assigned to the group. See [assigning entitlements] for a full
// list of supported values.
//
// [assigning entitlements]: https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements
Entitlements []ComplexValue
ExternalId *string
Groups []ComplexValue
// <Databricks> group ID
Id *string
Members []ComplexValue
// Container for the group identifier. Workspace local versus account.
Meta *ResourceMeta
// Corresponds to AWS instance profile/arn role.
Roles []ComplexValue
// The schema of the group.
Schemas []GroupSchema
}
type CreateServicePrincipalRequest ¶
type CreateServicePrincipalRequest struct {
// If this user is active
Active *bool
// UUID relating to the service principal
ApplicationId *string
// String that represents a concatenation of given and family names.
DisplayName *string
// Entitlements assigned to the service principal. See [assigning entitlements]
// for a full list of supported values.
//
// [assigning entitlements]: https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements
Entitlements []ComplexValue
ExternalId *string
Groups []ComplexValue
// <Databricks> service principal ID.
Id *string
// Corresponds to AWS instance profile/arn role.
Roles []ComplexValue
// The schema of the List response.
Schemas []ServicePrincipalSchema
}
type CreateUserRequest ¶
type CreateUserRequest struct {
// If this user is active
Active *bool
// String that represents a concatenation of given and family names. For example
// `John Smith`. This field cannot be updated through the Workspace SCIM APIs
// when [identity federation is enabled]. Use Account SCIM APIs to update
// `displayName`.
//
// [identity federation is enabled]: https://docs.databricks.com/administration-guide/users-groups/best-practices.html#enable-identity-federation
DisplayName *string
// All the emails associated with the <Databricks> user.
Emails []ComplexValue
// Entitlements assigned to the user. See [assigning entitlements] for a full
// list of supported values.
//
// [assigning entitlements]: https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements
Entitlements []ComplexValue
// External ID is not currently supported. It is reserved for future use.
ExternalId *string
Groups []ComplexValue
// <Databricks> user ID.
Id *string
Name *Name
// Corresponds to AWS instance profile/arn role.
Roles []ComplexValue
// The schema of the user.
Schemas []UserSchema
// Email address of the <Databricks> user.
UserName *string
}
type DeleteAccountGroupRequest ¶
type DeleteAccountGroupRequest struct {
// Unique ID for a group in the <Databricks> account.
Id *string
// <Databricks> account ID
AccountId *string
}
Delete a group.
type DeleteAccountServicePrincipalRequest ¶
type DeleteAccountServicePrincipalRequest struct {
// Unique ID for a service principal in the <Databricks> account.
Id *string
// <Databricks> account ID
AccountId *string
}
Delete a service principal.
type DeleteAccountUserRequest ¶
type DeleteAccountUserRequest struct {
// Unique ID for a user in the <Databricks> account.
Id *string
// <Databricks> account ID
AccountId *string
}
Delete a user.
type DeleteGroupRequest ¶
type DeleteGroupRequest struct {
// Unique ID for a group in the <Databricks> workspace.
Id *string
}
Delete a group.
type DeleteServicePrincipalRequest ¶
type DeleteServicePrincipalRequest struct {
// Unique ID for a service principal in the <Databricks> workspace.
Id *string
}
Delete a service principal.
type DeleteUserRequest ¶
type DeleteUserRequest struct {
// Unique ID for a user in the <Databricks> workspace.
Id *string
}
Delete a user.
type GetAccountGroupRequest ¶
type GetAccountGroupRequest struct {
// Unique ID for a group in the <Databricks> account.
Id *string
// <Databricks> account ID
AccountId *string
}
Get group details.
type GetAccountServicePrincipalRequest ¶
type GetAccountServicePrincipalRequest struct {
// Unique ID for a service principal in the <Databricks> account.
Id *string
// <Databricks> account ID
AccountId *string
}
Get service principal details.
type GetAccountUserRequest ¶
type GetAccountUserRequest struct {
// Comma-separated list of attributes to return in response.
Attributes *string
// Desired number of results per page. Default is 10000.
Count *int
// Comma-separated list of attributes to exclude in response.
ExcludedAttributes *string
// Query by which the results have to be filtered. Supported operators are
// equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`).
// Additionally, simple expressions can be formed using logical operators -
// `and` and `or`. The [SCIM RFC] has more details but we currently only support
// simple expressions.
//
// [SCIM RFC]: https://tools.ietf.org/html/rfc7644#section-3.4.2.2
Filter *string
// Unique ID for a user in the <Databricks> account.
Id *string
// Attribute to sort the results. Multi-part paths are supported. For example,
// `userName`, `name.givenName`, and `emails`.
SortBy *string
// The order to sort the results.
SortOrder AccountGetSortOrder_GetSortOrder
// Specifies the index of the first result. First item is number 1.
StartIndex *int
// <Databricks> account ID
AccountId *string
}
Get user details.
type GetGroupRequest ¶
type GetGroupRequest struct {
// Unique ID for a group in the <Databricks> workspace.
Id *string
}
Get group details.
type GetPasswordPermissionLevelsRequest ¶
type GetPasswordPermissionLevelsRequest struct {
}
Get object permission levels.
type GetPasswordPermissionLevelsResponse ¶
type GetPasswordPermissionLevelsResponse struct {
// Specific permission levels
PermissionLevels []PasswordPermissionsDescription
}
type GetPasswordPermissionsRequest ¶
type GetPasswordPermissionsRequest struct {
}
type GetServicePrincipalRequest ¶
type GetServicePrincipalRequest struct {
// Unique ID for a service principal in the <Databricks> workspace.
Id *string
}
Get service principal details.
type GetSortOrder ¶
type GetSortOrder string
const ( GetSortOrder_Unspecified GetSortOrder = "" GetSortOrder_Ascending GetSortOrder = "ascending" GetSortOrder_Descending GetSortOrder = "descending" )
type GetUserRequest ¶
type GetUserRequest struct {
// Comma-separated list of attributes to return in response.
Attributes *string
// Desired number of results per page.
Count *int
// Comma-separated list of attributes to exclude in response.
ExcludedAttributes *string
// Query by which the results have to be filtered. Supported operators are
// equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`).
// Additionally, simple expressions can be formed using logical operators -
// `and` and `or`. The [SCIM RFC] has more details but we currently only support
// simple expressions.
//
// [SCIM RFC]: https://tools.ietf.org/html/rfc7644#section-3.4.2.2
Filter *string
// Unique ID for a user in the <Databricks> workspace.
Id *string
// Attribute to sort the results. Multi-part paths are supported. For example,
// `userName`, `name.givenName`, and `emails`.
SortBy *string
// The order to sort the results.
SortOrder GetSortOrder
// Specifies the index of the first result. First item is number 1.
StartIndex *int
}
Get user details.
type Group ¶
type Group struct {
// String that represents a human-readable group name
DisplayName *string
// Entitlements assigned to the group. See [assigning entitlements] for a full
// list of supported values.
//
// [assigning entitlements]: https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements
Entitlements []ComplexValue
// external_id should be unique for identifying groups
ExternalId *string
Groups []ComplexValue
// <Databricks> group ID
Id *string
Members []ComplexValue
// Container for the group identifier. Workspace local versus account.
Meta *ResourceMeta
// Corresponds to AWS instance profile/arn role.
Roles []ComplexValue
// The schema of the group.
Schemas []GroupSchema
}
type GroupSchema ¶
type GroupSchema string
const ( GroupSchema_Unspecified GroupSchema = "" GroupSchema_UrnIetfParamsScimSchemasCore20Group GroupSchema = "urn:ietf:params:scim:schemas:core:2.0:Group" )
type ListAccountGroupsRequest ¶
type ListAccountGroupsRequest struct {
// <Databricks> account ID
AccountId *string
// Query by which the results have to be filtered. Supported operators are
// equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`).
// Additionally, simple expressions can be formed using logical operators -
// `and` and `or`. The [SCIM RFC] has more details but we currently only support
// simple expressions.
//
// [SCIM RFC]: https://tools.ietf.org/html/rfc7644#section-3.4.2.2
Filter *string
// Comma-separated list of attributes to return in response.
Attributes *string
// Comma-separated list of attributes to exclude in response.
ExcludedAttributes *string
// Specifies the index of the first result. First item is number 1.
StartIndex *int64
// Desired number of results per page. Default is 10000.
Count *int64
// Attribute to sort the results.
SortBy *string
// The order to sort the results.
SortOrder AccountListSort_Order
}
List group details.
type ListAccountGroupsResponse ¶
type ListAccountGroupsResponse struct {
// Total results returned in the response.
ItemsPerPage *int
// User objects returned in the response.
Resources []AccountGroup
// Starting index of all the results that matched the request filters. First
// item is number 1.
StartIndex *int64
// Total results that match the request filters.
TotalResults *int
}
type ListAccountServicePrincipalsRequest ¶
type ListAccountServicePrincipalsRequest struct {
// Comma-separated list of attributes to return in response.
Attributes *string
// Desired number of results per page. Default is 10000.
Count *int64
// Comma-separated list of attributes to exclude in response.
ExcludedAttributes *string
// Query by which the results have to be filtered. Supported operators are
// equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`).
// Additionally, simple expressions can be formed using logical operators -
// `and` and `or`. The [SCIM RFC] has more details but we currently only support
// simple expressions.
//
// [SCIM RFC]: https://tools.ietf.org/html/rfc7644#section-3.4.2.2
Filter *string
// Attribute to sort the results.
SortBy *string
// The order to sort the results.
SortOrder AccountListSort_Order
// Specifies the index of the first result. First item is number 1.
StartIndex *int64
// <Databricks> account ID
AccountId *string
}
List service principals.
type ListAccountServicePrincipalsResponse ¶
type ListAccountServicePrincipalsResponse struct {
// Total results returned in the response.
ItemsPerPage *int
// User objects returned in the response.
Resources []AccountServicePrincipal
// Starting index of all the results that matched the request filters. First
// item is number 1.
StartIndex *int64
// Total results that match the request filters.
TotalResults *int
}
type ListAccountUsersRequest ¶
type ListAccountUsersRequest struct {
// Comma-separated list of attributes to return in response.
Attributes *string
// Desired number of results per page. Default is 10000.
Count *int64
// Comma-separated list of attributes to exclude in response.
ExcludedAttributes *string
// Query by which the results have to be filtered. Supported operators are
// equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`).
// Additionally, simple expressions can be formed using logical operators -
// `and` and `or`. The [SCIM RFC] has more details but we currently only support
// simple expressions.
//
// [SCIM RFC]: https://tools.ietf.org/html/rfc7644#section-3.4.2.2
Filter *string
// Attribute to sort the results. Multi-part paths are supported. For example,
// `userName`, `name.givenName`, and `emails`.
SortBy *string
// The order to sort the results.
SortOrder AccountListSort_Order
// Specifies the index of the first result. First item is number 1.
StartIndex *int64
// <Databricks> account ID
AccountId *string
}
List users.
type ListAccountUsersResponse ¶
type ListAccountUsersResponse struct {
// Total results returned in the response.
ItemsPerPage *int
// User objects returned in the response.
Resources []AccountUser
// Starting index of all the results that matched the request filters. First
// item is number 1.
StartIndex *int64
// Total results that match the request filters.
TotalResults *int
}
type ListGroupsRequest ¶
type ListGroupsRequest struct {
// Query by which the results have to be filtered. Supported operators are
// equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`).
// Additionally, simple expressions can be formed using logical operators -
// `and` and `or`. The [SCIM RFC] has more details but we currently only support
// simple expressions.
//
// [SCIM RFC]: https://tools.ietf.org/html/rfc7644#section-3.4.2.2
Filter *string
// Comma-separated list of attributes to return in response.
Attributes *string
// Comma-separated list of attributes to exclude in response.
ExcludedAttributes *string
// Specifies the index of the first result. First item is number 1.
StartIndex *int64
// Desired number of results per page.
Count *int64
// Attribute to sort the results.
SortBy *string
// The order to sort the results.
SortOrder ListSort_Order
}
List group details.
type ListGroupsResponse ¶
type ListGroupsResponse struct {
// Total results returned in the response.
ItemsPerPage *int
// User objects returned in the response.
Resources []Group
// The schema of the service principal.
Schemas []ListResponseSchema
// Starting index of all the results that matched the request filters. First
// item is number 1.
StartIndex *int64
// Total results that match the request filters.
TotalResults *int
}
type ListResponseSchema ¶
type ListResponseSchema string
const ( ListResponseSchema_Unspecified ListResponseSchema = "" ListResponseSchema_UrnIetfParamsScimApiMessages20ListResponse ListResponseSchema = "urn:ietf:params:scim:api:messages:2.0:ListResponse" )
type ListServicePrincipalResponse ¶
type ListServicePrincipalResponse struct {
// Total results returned in the response.
ItemsPerPage *int
// User objects returned in the response.
Resources []ServicePrincipal
// The schema of the List response.
Schemas []ListResponseSchema
// Starting index of all the results that matched the request filters. First
// item is number 1.
StartIndex *int64
// Total results that match the request filters.
TotalResults *int
}
type ListServicePrincipalsRequest ¶
type ListServicePrincipalsRequest struct {
// Comma-separated list of attributes to return in response.
Attributes *string
// Desired number of results per page.
Count *int64
// Comma-separated list of attributes to exclude in response.
ExcludedAttributes *string
// Query by which the results have to be filtered. Supported operators are
// equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`).
// Additionally, simple expressions can be formed using logical operators -
// `and` and `or`. The [SCIM RFC] has more details but we currently only support
// simple expressions.
//
// [SCIM RFC]: https://tools.ietf.org/html/rfc7644#section-3.4.2.2
Filter *string
// Attribute to sort the results.
SortBy *string
// The order to sort the results.
SortOrder ListSort_Order
// Specifies the index of the first result. First item is number 1.
StartIndex *int64
}
List service principals.
type ListSort ¶
type ListSort struct {
}
ListSortOrder and GetSortOrder share enum values, which is not supported. We use nesting as a workaround..
type ListSort_Order ¶
type ListSort_Order string
const ( ListSort_Order_Unspecified ListSort_Order = "" ListSort_Order_Ascending ListSort_Order = "ascending" ListSort_Order_Descending ListSort_Order = "descending" )
type ListUsersRequest ¶
type ListUsersRequest struct {
// Comma-separated list of attributes to return in response.
Attributes *string
// Desired number of results per page.
Count *int64
// Comma-separated list of attributes to exclude in response.
ExcludedAttributes *string
// Query by which the results have to be filtered. Supported operators are
// equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`).
// Additionally, simple expressions can be formed using logical operators -
// `and` and `or`. The [SCIM RFC] has more details but we currently only support
// simple expressions.
//
// [SCIM RFC]: https://tools.ietf.org/html/rfc7644#section-3.4.2.2
Filter *string
// Attribute to sort the results. Multi-part paths are supported. For example,
// `userName`, `name.givenName`, and `emails`.
SortBy *string
// The order to sort the results.
SortOrder ListSort_Order
// Specifies the index of the first result. First item is number 1.
StartIndex *int64
}
List users.
type ListUsersResponse ¶
type ListUsersResponse struct {
// Total results returned in the response.
ItemsPerPage *int
// User objects returned in the response.
Resources []User
// The schema of the List response.
Schemas []ListResponseSchema
// Starting index of all the results that matched the request filters. First
// item is number 1.
StartIndex *int64
// Total results that match the request filters.
TotalResults *int
}
type PasswordAccessControlRequest ¶
type PasswordAccessControlRequest struct {
// name of the group
GroupName *string
// Permission level
PermissionLevel PasswordPermission_Level
// application ID of a service principal
ServicePrincipalName *string
// name of the user
UserName *string
}
type PasswordAccessControlResponse ¶
type PasswordAccessControlResponse struct {
// All permissions.
AllPermissions []PasswordPermission
// Display name of the user or service principal.
DisplayName *string
// name of the group
GroupName *string
// Name of the service principal.
ServicePrincipalName *string
// name of the user
UserName *string
}
type PasswordPermission ¶
type PasswordPermission struct {
Inherited *bool
InheritedFromObject []string
// Permission level
PermissionLevel PasswordPermission_Level
}
type PasswordPermission_Level ¶
type PasswordPermission_Level string
Permission level
const ( PasswordPermission_Level_Unspecified PasswordPermission_Level = "" PasswordPermission_Level_CanUse PasswordPermission_Level = "CAN_USE" )
type PasswordPermissions ¶
type PasswordPermissions struct {
AccessControlList []PasswordAccessControlResponse
ObjectId *string
ObjectType *string
}
type PasswordPermissionsDescription ¶
type PasswordPermissionsDescription struct {
Description *string
// Permission level
PermissionLevel PasswordPermission_Level
}
type PasswordPermissionsRequest ¶
type PasswordPermissionsRequest struct {
AccessControlList []PasswordAccessControlRequest
}
type Patch ¶
type Patch struct {
// Type of patch operation.
Op PatchOp
// Selection of patch operation
Path *string
// Value to modify
Value json.RawMessage
}
type PatchAccountGroupRequest ¶
type PatchAccountGroupRequest struct {
// Unique ID in the <Databricks> workspace.
Id *string
Operations []AccountPatch
// The schema of the patch request. Must be
// ["urn:ietf:params:scim:api:messages:2.0:PatchOp"].
Schemas []AccountPatchSchema_PatchSchema
// <Databricks> account ID
AccountId *string
}
type PatchAccountServicePrincipalRequest ¶
type PatchAccountServicePrincipalRequest struct {
// Unique ID in the <Databricks> workspace.
Id *string
Operations []AccountPatch
// The schema of the patch request. Must be
// ["urn:ietf:params:scim:api:messages:2.0:PatchOp"].
Schemas []AccountPatchSchema_PatchSchema
// <Databricks> account ID
AccountId *string
}
type PatchAccountUserRequest ¶
type PatchAccountUserRequest struct {
// Unique ID in the <Databricks> workspace.
Id *string
Operations []AccountPatch
// The schema of the patch request. Must be
// ["urn:ietf:params:scim:api:messages:2.0:PatchOp"].
Schemas []AccountPatchSchema_PatchSchema
// <Databricks> account ID
AccountId *string
}
type PatchGroupRequest ¶
type PatchGroupRequest struct {
// Unique ID in the <Databricks> workspace.
Id *string
Operations []Patch
// The schema of the patch request. Must be
// ["urn:ietf:params:scim:api:messages:2.0:PatchOp"].
Schemas []PatchSchema
}
type PatchSchema ¶
type PatchSchema string
const ( PatchSchema_Unspecified PatchSchema = "" PatchSchema_UrnIetfParamsScimApiMessages20PatchOp PatchSchema = "urn:ietf:params:scim:api:messages:2.0:PatchOp" )
type PatchServicePrincipalRequest ¶
type PatchServicePrincipalRequest struct {
// Unique ID in the <Databricks> workspace.
Id *string
Operations []Patch
// The schema of the patch request. Must be
// ["urn:ietf:params:scim:api:messages:2.0:PatchOp"].
Schemas []PatchSchema
}
type PatchUserRequest ¶
type PatchUserRequest struct {
// Unique ID in the <Databricks> workspace.
Id *string
Operations []Patch
// The schema of the patch request. Must be
// ["urn:ietf:params:scim:api:messages:2.0:PatchOp"].
Schemas []PatchSchema
}
type ResourceMeta ¶
type ResourceMeta struct {
// Identifier for group type. Can be local workspace group (`WorkspaceGroup`) or
// account group (`Group`).
ResourceType *string
}
type ServicePrincipal ¶
type ServicePrincipal struct {
// If this user is active
Active *bool
// UUID relating to the service principal
ApplicationId *string
// String that represents a concatenation of given and family names.
DisplayName *string
// Entitlements assigned to the service principal. See [assigning entitlements]
// for a full list of supported values.
//
// [assigning entitlements]: https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements
Entitlements []ComplexValue
ExternalId *string
Groups []ComplexValue
// <Databricks> service principal ID.
Id *string
// Corresponds to AWS instance profile/arn role.
Roles []ComplexValue
// The schema of the List response.
Schemas []ServicePrincipalSchema
}
type ServicePrincipalSchema ¶
type ServicePrincipalSchema string
const ( ServicePrincipalSchema_Unspecified ServicePrincipalSchema = "" ServicePrincipalSchema_UrnIetfParamsScimSchemasCore20ServicePrincipal ServicePrincipalSchema = "urn:ietf:params:scim:schemas:core:2.0:ServicePrincipal" )
type UpdateAccountGroupRequest ¶
type UpdateAccountGroupRequest struct {
// String that represents a human-readable group name
DisplayName *string
ExternalId *string
// <Databricks> group ID
Id *string
Members []AccountComplexValue
// Container for the group identifier. Workspace local versus account.
Meta *AccountResourceMeta
// Indicates if the group has the admin role.
Roles []AccountComplexValue
// <Databricks> account ID
AccountId *string
}
type UpdateAccountServicePrincipalRequest ¶
type UpdateAccountServicePrincipalRequest struct {
// If this user is active
Active *bool
// UUID relating to the service principal
ApplicationId *string
// String that represents a concatenation of given and family names.
DisplayName *string
ExternalId *string
// <Databricks> service principal ID.
Id *string
// Indicates if the group has the admin role.
Roles []AccountComplexValue
// <Databricks> account ID
AccountId *string
}
type UpdateAccountUserRequest ¶
type UpdateAccountUserRequest struct {
// If this user is active
Active *bool
// String that represents a concatenation of given and family names. For example
// `John Smith`.
DisplayName *string
// All the emails associated with the <Databricks> user. This attribute cannot
// be updated through the SCIM PATCH or PUT APIs; any supplied change is
// ignored.
Emails []AccountComplexValue
// External ID is not currently supported. It is reserved for future use.
ExternalId *string
// <Databricks> user ID.
Id *string
Name *AccountName
// Indicates if the group has the admin role.
Roles []AccountComplexValue
// Email address of the <Databricks> user. This attribute cannot be updated
// through the SCIM PATCH or PUT APIs; any supplied change is ignored.
UserName *string
// <Databricks> account ID
AccountId *string
}
type UpdateGroupRequest ¶
type UpdateGroupRequest struct {
// String that represents a human-readable group name
DisplayName *string
// Entitlements assigned to the group. See [assigning entitlements] for a full
// list of supported values.
//
// [assigning entitlements]: https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements
Entitlements []ComplexValue
ExternalId *string
Groups []ComplexValue
// <Databricks> group ID
Id *string
Members []ComplexValue
// Container for the group identifier. Workspace local versus account.
Meta *ResourceMeta
// Corresponds to AWS instance profile/arn role.
Roles []ComplexValue
// The schema of the group.
Schemas []GroupSchema
}
type UpdateServicePrincipalRequest ¶
type UpdateServicePrincipalRequest struct {
// If this user is active
Active *bool
// UUID relating to the service principal
ApplicationId *string
// String that represents a concatenation of given and family names.
DisplayName *string
// Entitlements assigned to the service principal. See [assigning entitlements]
// for a full list of supported values.
//
// [assigning entitlements]: https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements
Entitlements []ComplexValue
ExternalId *string
Groups []ComplexValue
// <Databricks> service principal ID.
Id *string
// Corresponds to AWS instance profile/arn role.
Roles []ComplexValue
// The schema of the List response.
Schemas []ServicePrincipalSchema
}
type UpdateUserRequest ¶
type UpdateUserRequest struct {
// If this user is active
Active *bool
// String that represents a concatenation of given and family names. For example
// `John Smith`. This field cannot be updated through the Workspace SCIM APIs
// when [identity federation is enabled]. Use Account SCIM APIs to update
// `displayName`.
//
// [identity federation is enabled]: https://docs.databricks.com/administration-guide/users-groups/best-practices.html#enable-identity-federation
DisplayName *string
// All the emails associated with the <Databricks> user. This attribute cannot
// be updated through the SCIM PATCH or PUT APIs; any supplied change is
// ignored.
Emails []ComplexValue
// Entitlements assigned to the user. See [assigning entitlements] for a full
// list of supported values.
//
// [assigning entitlements]: https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements
Entitlements []ComplexValue
// External ID is not currently supported. It is reserved for future use.
ExternalId *string
Groups []ComplexValue
// <Databricks> user ID.
Id *string
Name *Name
// Corresponds to AWS instance profile/arn role.
Roles []ComplexValue
// The schema of the user.
Schemas []UserSchema
// Email address of the <Databricks> user. This attribute cannot be updated
// through the SCIM PATCH or PUT APIs; any supplied change is ignored.
UserName *string
}
type User ¶
type User struct {
// If this user is active
Active *bool
// String that represents a concatenation of given and family names. For example
// `John Smith`. This field cannot be updated through the Workspace SCIM APIs
// when [identity federation is enabled]. Use Account SCIM APIs to update
// `displayName`.
//
// [identity federation is enabled]: https://docs.databricks.com/administration-guide/users-groups/best-practices.html#enable-identity-federation
DisplayName *string
// All the emails associated with the <Databricks> user. This attribute cannot
// be updated through the SCIM PATCH or PUT APIs; any supplied change is
// ignored.
Emails []ComplexValue
// Entitlements assigned to the user. See [assigning entitlements] for a full
// list of supported values.
//
// [assigning entitlements]: https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements
Entitlements []ComplexValue
// External ID is not currently supported. It is reserved for future use.
ExternalId *string
Groups []ComplexValue
// <Databricks> user ID.
Id *string
Name *Name
// Corresponds to AWS instance profile/arn role.
Roles []ComplexValue
// The schema of the user.
Schemas []UserSchema
// Email address of the <Databricks> user. This attribute cannot be updated
// through the SCIM PATCH or PUT APIs; any supplied change is ignored.
UserName *string
}
type UserSchema ¶
type UserSchema string
const ( UserSchema_Unspecified UserSchema = "" UserSchema_UrnIetfParamsScimSchemasCore20User UserSchema = "urn:ietf:params:scim:schemas:core:2.0:User" UserSchema_UrnIetfParamsScimSchemasExtensionWorkspace20User UserSchema = "urn:ietf:params:scim:schemas:extension:workspace:2.0:User" )