vcenter_sso

Client for vCenter SSO identity APIs under /api/vcenter/identity.

Covers the vSphere 9 SSO identity surface used for platform authentication: external identity providers (Active Directory / LDAP / OIDC federation), and the local vsphere.local group and user CRUD endpoints.

Auth is delegated to saltext.vcf.utils.vcenter which manages the /api/session token session.

saltext.vcf.clients.vcenter_sso.providers_list(opts, profile=None)

Return the list of registered identity providers.

saltext.vcf.clients.vcenter_sso.providers_get(opts, provider_id, profile=None)

Return a single identity provider by id.

saltext.vcf.clients.vcenter_sso.providers_get_or_none(opts, provider_id, profile=None)

Return the provider or None if it does not exist.

saltext.vcf.clients.vcenter_sso.providers_create(opts, spec, profile=None)

Create a new identity provider.

spec is passed through as the POST body; typical keys include config_tag (ActiveDirectory, LDAP, Oauth2, Oidc), domain_name, auth_type, username, password, and any provider-specific *_configuration block.

saltext.vcf.clients.vcenter_sso.providers_update(opts, provider_id, spec, profile=None)

PATCH an existing identity provider.

saltext.vcf.clients.vcenter_sso.providers_delete(opts, provider_id, profile=None)

Delete an identity provider by id.

saltext.vcf.clients.vcenter_sso.groups_list(opts, domain=None, profile=None)

List groups, optionally filtered to a specific domain.

saltext.vcf.clients.vcenter_sso.groups_get(opts, group, profile=None)

Return a single group by id.

saltext.vcf.clients.vcenter_sso.groups_get_or_none(opts, group, profile=None)

Return the group or None if it does not exist.

saltext.vcf.clients.vcenter_sso.groups_create(opts, name, domain, description='', profile=None)

Create a group in domain.

Extra fields (e.g. initial members) may be provided by the caller wrapping them via spec; this helper covers the common name / domain / description shape used against vsphere.local.

saltext.vcf.clients.vcenter_sso.groups_update(opts, group, spec, profile=None)

PATCH a group. spec accepts description and other mutable fields.

saltext.vcf.clients.vcenter_sso.groups_delete(opts, group, profile=None)

Delete a group by id.

saltext.vcf.clients.vcenter_sso.group_add_member(opts, group, member, profile=None)

Add a user or nested group to group.

member is the fully-qualified principal (user@domain or the SSO group id); vSphere accepts either a user or a group here.

saltext.vcf.clients.vcenter_sso.group_remove_member(opts, group, member, profile=None)

Remove a member from group.

saltext.vcf.clients.vcenter_sso.users_list(opts, domain=None, profile=None)

List users, optionally filtered to a specific domain.

saltext.vcf.clients.vcenter_sso.users_get(opts, user, profile=None)

Return a single user by id.

saltext.vcf.clients.vcenter_sso.users_get_or_none(opts, user, profile=None)

Return the user or None if it does not exist.

saltext.vcf.clients.vcenter_sso.users_create(opts, username, domain, password, description='', email=None, profile=None)

Create a local SSO user.

Only supported against the local (vsphere.local) domain; external identity providers manage their own users.

saltext.vcf.clients.vcenter_sso.users_update(opts, user, spec, profile=None)

PATCH a user. spec accepts password, description, email etc.

saltext.vcf.clients.vcenter_sso.users_delete(opts, user, profile=None)

Delete a user by id.