CloudIdentity

import { CloudIdentity } from "https://googleapis.deno.dev/v1/cloudidentity:v1.ts";

API for provisioning and managing identity resources.

class CloudIdentity {

constructor(client?: CredentialsClient, baseUrl?: string);

async customersUserinvitationsCancel(name: string, req: CancelUserInvitationRequest): Promise<Operation>;

async customersUserinvitationsGet(name: string): Promise<UserInvitation>;

async customersUserinvitationsIsInvitableUser(name: string): Promise<IsInvitableUserResponse>;

async customersUserinvitationsList(parent: string, opts?: CustomersUserinvitationsListOptions): Promise<ListUserInvitationsResponse>;

async customersUserinvitationsSend(name: string, req: SendUserInvitationRequest): Promise<Operation>;

async devicesCancelWipe(name: string, req: GoogleAppsCloudidentityDevicesV1CancelWipeDeviceRequest): Promise<Operation>;

async devicesCreate(req: GoogleAppsCloudidentityDevicesV1Device, opts?: DevicesCreateOptions): Promise<Operation>;

async devicesDelete(name: string, opts?: DevicesDeleteOptions): Promise<Operation>;

async devicesDeviceUsersApprove(name: string, req: GoogleAppsCloudidentityDevicesV1ApproveDeviceUserRequest): Promise<Operation>;

async devicesDeviceUsersBlock(name: string, req: GoogleAppsCloudidentityDevicesV1BlockDeviceUserRequest): Promise<Operation>;

async devicesDeviceUsersCancelWipe(name: string, req: GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserRequest): Promise<Operation>;

async devicesDeviceUsersClientStatesGet(name: string, opts?: DevicesDeviceUsersClientStatesGetOptions): Promise<GoogleAppsCloudidentityDevicesV1ClientState>;

async devicesDeviceUsersClientStatesList(parent: string, opts?: DevicesDeviceUsersClientStatesListOptions): Promise<GoogleAppsCloudidentityDevicesV1ListClientStatesResponse>;

async devicesDeviceUsersClientStatesPatch(

req: GoogleAppsCloudidentityDevicesV1ClientState,

opts?: DevicesDeviceUsersClientStatesPatchOptions,

): Promise<Operation>;

async devicesDeviceUsersDelete(name: string, opts?: DevicesDeviceUsersDeleteOptions): Promise<Operation>;

async devicesDeviceUsersGet(name: string, opts?: DevicesDeviceUsersGetOptions): Promise<GoogleAppsCloudidentityDevicesV1DeviceUser>;

async devicesDeviceUsersList(parent: string, opts?: DevicesDeviceUsersListOptions): Promise<GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse>;

async devicesDeviceUsersLookup(parent: string, opts?: DevicesDeviceUsersLookupOptions): Promise<GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse>;

async devicesDeviceUsersWipe(name: string, req: GoogleAppsCloudidentityDevicesV1WipeDeviceUserRequest): Promise<Operation>;

async devicesGet(name: string, opts?: DevicesGetOptions): Promise<GoogleAppsCloudidentityDevicesV1Device>;

async devicesList(opts?: DevicesListOptions): Promise<GoogleAppsCloudidentityDevicesV1ListDevicesResponse>;

async devicesWipe(name: string, req: GoogleAppsCloudidentityDevicesV1WipeDeviceRequest): Promise<Operation>;

async groupsCreate(req: Group, opts?: GroupsCreateOptions): Promise<Operation>;

async groupsDelete(name: string): Promise<Operation>;

async groupsGet(name: string): Promise<Group>;

async groupsGetSecuritySettings(name: string, opts?: GroupsGetSecuritySettingsOptions): Promise<SecuritySettings>;

async groupsList(opts?: GroupsListOptions): Promise<ListGroupsResponse>;

async groupsLookup(opts?: GroupsLookupOptions): Promise<LookupGroupNameResponse>;

async groupsMembershipsCheckTransitiveMembership(parent: string, opts?: GroupsMembershipsCheckTransitiveMembershipOptions): Promise<CheckTransitiveMembershipResponse>;

async groupsMembershipsCreate(parent: string, req: Membership): Promise<Operation>;

async groupsMembershipsDelete(name: string): Promise<Operation>;

async groupsMembershipsGet(name: string): Promise<Membership>;

async groupsMembershipsGetMembershipGraph(parent: string, opts?: GroupsMembershipsGetMembershipGraphOptions): Promise<Operation>;

async groupsMembershipsList(parent: string, opts?: GroupsMembershipsListOptions): Promise<ListMembershipsResponse>;

async groupsMembershipsLookup(parent: string, opts?: GroupsMembershipsLookupOptions): Promise<LookupMembershipNameResponse>;

async groupsMembershipsModifyMembershipRoles(name: string, req: ModifyMembershipRolesRequest): Promise<ModifyMembershipRolesResponse>;

async groupsMembershipsSearchDirectGroups(parent: string, opts?: GroupsMembershipsSearchDirectGroupsOptions): Promise<SearchDirectGroupsResponse>;

async groupsMembershipsSearchTransitiveGroups(parent: string, opts?: GroupsMembershipsSearchTransitiveGroupsOptions): Promise<SearchTransitiveGroupsResponse>;

async groupsMembershipsSearchTransitiveMemberships(parent: string, opts?: GroupsMembershipsSearchTransitiveMembershipsOptions): Promise<SearchTransitiveMembershipsResponse>;

async groupsPatch(

req: Group,

opts?: GroupsPatchOptions,

): Promise<Operation>;

async groupsSearch(opts?: GroupsSearchOptions): Promise<SearchGroupsResponse>;

async groupsUpdateSecuritySettings(

req: SecuritySettings,

opts?: GroupsUpdateSecuritySettingsOptions,

): Promise<Operation>;

async inboundSamlSsoProfilesCreate(req: InboundSamlSsoProfile): Promise<Operation>;

async inboundSamlSsoProfilesDelete(name: string): Promise<Operation>;

async inboundSamlSsoProfilesGet(name: string): Promise<InboundSamlSsoProfile>;

async inboundSamlSsoProfilesIdpCredentialsAdd(parent: string, req: AddIdpCredentialRequest): Promise<Operation>;

async inboundSamlSsoProfilesIdpCredentialsDelete(name: string): Promise<Operation>;

async inboundSamlSsoProfilesIdpCredentialsGet(name: string): Promise<IdpCredential>;

async inboundSamlSsoProfilesIdpCredentialsList(parent: string, opts?: InboundSamlSsoProfilesIdpCredentialsListOptions): Promise<ListIdpCredentialsResponse>;

async inboundSamlSsoProfilesList(opts?: InboundSamlSsoProfilesListOptions): Promise<ListInboundSamlSsoProfilesResponse>;

async inboundSamlSsoProfilesPatch(

req: InboundSamlSsoProfile,

opts?: InboundSamlSsoProfilesPatchOptions,

): Promise<Operation>;

async inboundSsoAssignmentsCreate(req: InboundSsoAssignment): Promise<Operation>;

async inboundSsoAssignmentsDelete(name: string): Promise<Operation>;

async inboundSsoAssignmentsGet(name: string): Promise<InboundSsoAssignment>;

async inboundSsoAssignmentsList(opts?: InboundSsoAssignmentsListOptions): Promise<ListInboundSsoAssignmentsResponse>;

async inboundSsoAssignmentsPatch(

req: InboundSsoAssignment,

opts?: InboundSsoAssignmentsPatchOptions,

): Promise<Operation>;

}

§Constructors

new CloudIdentity(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

customersUserinvitationsCancel(name: string, req: CancelUserInvitationRequest): Promise<Operation>

[src]

Cancels a UserInvitation that was already sent.

@param name

Required. UserInvitation name in the format customers/{customer}/userinvitations/{user_email_address}

customersUserinvitationsGet(name: string): Promise<UserInvitation>

[src]

Retrieves a UserInvitation resource. Note: New consumer accounts with the customer's verified domain created within the previous 48 hours will not appear in the result. This delay also applies to newly-verified domains.

@param name

Required. UserInvitation name in the format customers/{customer}/userinvitations/{user_email_address}

customersUserinvitationsIsInvitableUser(name: string): Promise<IsInvitableUserResponse>

[src]

Verifies whether a user account is eligible to receive a UserInvitation (is an unmanaged account). Eligibility is based on the following criteria:

the email address is a consumer account and it's the primary email address of the account, and * the domain of the email address matches an existing verified Google Workspace or Cloud Identity domain If both conditions are met, the user is eligible. Note: This method is not supported for Workspace Essentials customers.

@param name

Required. UserInvitation name in the format customers/{customer}/userinvitations/{user_email_address}

customersUserinvitationsList(parent: string, opts?: CustomersUserinvitationsListOptions): Promise<ListUserInvitationsResponse>

[src]

Retrieves a list of UserInvitation resources. Note: New consumer accounts with the customer's verified domain created within the previous 48 hours will not appear in the result. This delay also applies to newly-verified domains.

@param parent

Required. The customer ID of the Google Workspace or Cloud Identity account the UserInvitation resources are associated with.

customersUserinvitationsSend(name: string, req: SendUserInvitationRequest): Promise<Operation>

[src]

Sends a UserInvitation to email. If the UserInvitation does not exist for this request and it is a valid request, the request creates a UserInvitation. Note: The get and list methods have a 48-hour delay where newly-created consumer accounts will not appear in the results. You can still send a UserInvitation to those accounts if you know the unmanaged email address and IsInvitableUser==True.

@param name

Required. UserInvitation name in the format customers/{customer}/userinvitations/{user_email_address}

devicesCancelWipe(name: string, req: GoogleAppsCloudidentityDevicesV1CancelWipeDeviceRequest): Promise<Operation>

[src]

Cancels an unfinished device wipe. This operation can be used to cancel device wipe in the gap between the wipe operation returning success and the device being wiped. This operation is possible when the device is in a "pending wipe" state. The device enters the "pending wipe" state when a wipe device command is issued, but has not yet been sent to the device. The cancel wipe will fail if the wipe command has already been issued to the device.

@param name

Required. Resource name of the Device in format: devices/{device}, where device is the unique ID assigned to the Device.

devicesCreate(req: GoogleAppsCloudidentityDevicesV1Device, opts?: DevicesCreateOptions): Promise<Operation>

[src]

Creates a device. Only company-owned device may be created. Note: This method is available only to customers who have one of the following SKUs: Enterprise Standard, Enterprise Plus, Enterprise for Education, and Cloud Identity Premium

devicesDelete(name: string, opts?: DevicesDeleteOptions): Promise<Operation>

[src]

Deletes the specified device.

@param name

Required. Resource name of the Device in format: devices/{device}, where device is the unique ID assigned to the Device.

devicesDeviceUsersApprove(name: string, req: GoogleAppsCloudidentityDevicesV1ApproveDeviceUserRequest): Promise<Operation>

[src]

Approves device to access user data.

@param name

Required. Resource name of the Device in format: devices/{device}/deviceUsers/{device_user}, where device is the unique ID assigned to the Device, and device_user is the unique ID assigned to the User.

devicesDeviceUsersBlock(name: string, req: GoogleAppsCloudidentityDevicesV1BlockDeviceUserRequest): Promise<Operation>

[src]

Blocks device from accessing user data

@param name

devicesDeviceUsersCancelWipe(name: string, req: GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserRequest): Promise<Operation>

[src]

Cancels an unfinished user account wipe. This operation can be used to cancel device wipe in the gap between the wipe operation returning success and the device being wiped.

@param name

devicesDeviceUsersClientStatesGet(name: string, opts?: DevicesDeviceUsersClientStatesGetOptions): Promise<GoogleAppsCloudidentityDevicesV1ClientState>

[src]

Gets the client state for the device user

@param name

Required. Resource name of the ClientState in format: devices/{device}/deviceUsers/{device_user}/clientStates/{partner}, where device is the unique ID assigned to the Device, device_user is the unique ID assigned to the User and partner identifies the partner storing the data. To get the client state for devices belonging to your own organization, the partnerId is in the format: customerId-*anystring*. Where the customerId is your organization's customer ID and anystring is any suffix. This suffix is used in setting up Custom Access Levels in Context-Aware Access. You may use my_customer instead of the customer ID for devices managed by your own organization. You may specify - in place of the {device}, so the ClientState resource name can be: devices/-/deviceUsers/{device_user_resource}/clientStates/{partner}.

devicesDeviceUsersClientStatesList(parent: string, opts?: DevicesDeviceUsersClientStatesListOptions): Promise<GoogleAppsCloudidentityDevicesV1ListClientStatesResponse>

[src]

Lists the client states for the given search query.

@param parent

Required. To list all ClientStates, set this to "devices/-/deviceUsers/-". To list all ClientStates owned by a DeviceUser, set this to the resource name of the DeviceUser. Format: devices/{device}/deviceUsers/{deviceUser}

devicesDeviceUsersClientStatesPatch(name: string, req: GoogleAppsCloudidentityDevicesV1ClientState, opts?: DevicesDeviceUsersClientStatesPatchOptions): Promise<Operation>

[src]

Updates the client state for the device user Note: This method is available only to customers who have one of the following SKUs: Enterprise Standard, Enterprise Plus, Enterprise for Education, and Cloud Identity Premium

@param name

Output only. Resource name of the ClientState in format: devices/{device}/deviceUsers/{device_user}/clientState/{partner}, where partner corresponds to the partner storing the data. For partners belonging to the "BeyondCorp Alliance", this is the partner ID specified to you by Google. For all other callers, this is a string of the form: {customer}-suffix, where customer is your customer ID. The suffix is any string the caller specifies. This string will be displayed verbatim in the administration console. This suffix is used in setting up Custom Access Levels in Context-Aware Access. Your organization's customer ID can be obtained from the URL: GET https://www.googleapis.com/admin/directory/v1/customers/my_customer The id field in the response contains the customer ID starting with the letter 'C'. The customer ID to be used in this API is the string after the letter 'C' (not including 'C')

devicesDeviceUsersDelete(name: string, opts?: DevicesDeviceUsersDeleteOptions): Promise<Operation>

[src]

Deletes the specified DeviceUser. This also revokes the user's access to device data.

@param name

devicesDeviceUsersGet(name: string, opts?: DevicesDeviceUsersGetOptions): Promise<GoogleAppsCloudidentityDevicesV1DeviceUser>

[src]

Retrieves the specified DeviceUser

@param name

devicesDeviceUsersList(parent: string, opts?: DevicesDeviceUsersListOptions): Promise<GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse>

[src]

Lists/Searches DeviceUsers.

@param parent

Required. To list all DeviceUsers, set this to "devices/-". To list all DeviceUsers owned by a device, set this to the resource name of the device. Format: devices/{device}

devicesDeviceUsersLookup(parent: string, opts?: DevicesDeviceUsersLookupOptions): Promise<GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse>

[src]

Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: No properties need to be passed, the caller's credentials are sufficient to identify the corresponding DeviceUser. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.

@param parent

Must be set to "devices/-/deviceUsers" to search across all DeviceUser belonging to the user.

devicesDeviceUsersWipe(name: string, req: GoogleAppsCloudidentityDevicesV1WipeDeviceUserRequest): Promise<Operation>

[src]

Wipes the user's account on a device. Other data on the device that is not associated with the user's work account is not affected. For example, if a Gmail app is installed on a device that is used for personal and work purposes, and the user is logged in to the Gmail app with their personal account as well as their work account, wiping the "deviceUser" by their work administrator will not affect their personal account within Gmail or other apps such as Photos.

@param name

devicesGet(name: string, opts?: DevicesGetOptions): Promise<GoogleAppsCloudidentityDevicesV1Device>

[src]

Retrieves the specified device.

@param name

Required. Resource name of the Device in the format: devices/{device}, where device is the unique ID assigned to the Device.

devicesList(opts?: DevicesListOptions): Promise<GoogleAppsCloudidentityDevicesV1ListDevicesResponse>

[src]

Lists/Searches devices.

devicesWipe(name: string, req: GoogleAppsCloudidentityDevicesV1WipeDeviceRequest): Promise<Operation>

[src]

Wipes all data on the specified device.

@param name

groupsCreate(req: Group, opts?: GroupsCreateOptions): Promise<Operation>

[src]

Creates a Group.

groupsDelete(name: string): Promise<Operation>

[src]

Deletes a Group.

@param name

Required. The resource name of the Group to retrieve. Must be of the form groups/{group}.

groupsGet(name: string): Promise<Group>

[src]

Retrieves a Group.

@param name

Required. The resource name of the Group to retrieve. Must be of the form groups/{group}.

groupsGetSecuritySettings(name: string, opts?: GroupsGetSecuritySettingsOptions): Promise<SecuritySettings>

[src]

Get Security Settings

@param name

Required. The security settings to retrieve. Format: groups/{group_id}/securitySettings

groupsList(opts?: GroupsListOptions): Promise<ListGroupsResponse>

[src]

Lists the Group resources under a customer or namespace.

groupsLookup(opts?: GroupsLookupOptions): Promise<LookupGroupNameResponse>

[src]

Looks up the resource name of a Group by its EntityKey.

groupsMembershipsCheckTransitiveMembership(parent: string, opts?: GroupsMembershipsCheckTransitiveMembershipOptions): Promise<CheckTransitiveMembershipResponse>

[src]

Check a potential member for membership in a group. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the member is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A member has membership to a group as long as there is a single viewable transitive membership between the group and the member. The actor must have view permissions to at least one transitive membership between the member and group.

@param parent

Resource name of the group to check the transitive membership in. Format: groups/{group}, where group is the unique id assigned to the Group to which the Membership belongs to.

groupsMembershipsCreate(parent: string, req: Membership): Promise<Operation>

[src]

Creates a Membership.

@param parent

Required. The parent Group resource under which to create the Membership. Must be of the form groups/{group}.

groupsMembershipsDelete(name: string): Promise<Operation>

[src]

Deletes a Membership.

@param name

Required. The resource name of the Membership to delete. Must be of the form groups/{group}/memberships/{membership}

groupsMembershipsGet(name: string): Promise<Membership>

[src]

Retrieves a Membership.

@param name

Required. The resource name of the Membership to retrieve. Must be of the form groups/{group}/memberships/{membership}.

groupsMembershipsGetMembershipGraph(parent: string, opts?: GroupsMembershipsGetMembershipGraphOptions): Promise<Operation>

[src]

Get a membership graph of just a member or both a member and a group. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the member is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. Given a member, the response will contain all membership paths from the member. Given both a group and a member, the response will contain all membership paths between the group and the member.

@param parent

Required. Resource name of the group to search transitive memberships in. Format: groups/{group}, where group is the unique ID assigned to the Group to which the Membership belongs to. group can be a wildcard collection id "-". When a group is specified, the membership graph will be constrained to paths between the member (defined in the query) and the parent. If a wildcard collection is provided, all membership paths connected to the member will be returned.

groupsMembershipsList(parent: string, opts?: GroupsMembershipsListOptions): Promise<ListMembershipsResponse>

[src]

Lists the Memberships within a Group.

@param parent

Required. The parent Group resource under which to lookup the Membership name. Must be of the form groups/{group}.

groupsMembershipsLookup(parent: string, opts?: GroupsMembershipsLookupOptions): Promise<LookupMembershipNameResponse>

[src]

Looks up the resource name of a Membership by its EntityKey.

@param parent

Required. The parent Group resource under which to lookup the Membership name. Must be of the form groups/{group}.

groupsMembershipsModifyMembershipRoles(name: string, req: ModifyMembershipRolesRequest): Promise<ModifyMembershipRolesResponse>

[src]

Modifies the MembershipRoles of a Membership.

@param name

Required. The resource name of the Membership whose roles are to be modified. Must be of the form groups/{group}/memberships/{membership}.

groupsMembershipsSearchDirectGroups(parent: string, opts?: GroupsMembershipsSearchDirectGroupsOptions): Promise<SearchDirectGroupsResponse>

[src]

Searches direct groups of a member.

@param parent

Resource name of the group to search transitive memberships in. Format: groups/{group_id}, where group_id is always '-' as this API will search across all groups for a given member.

groupsMembershipsSearchTransitiveGroups(parent: string, opts?: GroupsMembershipsSearchTransitiveGroupsOptions): Promise<SearchTransitiveGroupsResponse>

[src]

Search transitive groups of a member. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the member is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A transitive group is any group that has a direct or indirect membership to the member. Actor must have view permissions all transitive groups.

@param parent

Resource name of the group to search transitive memberships in. Format: groups/{group}, where group is always '-' as this API will search across all groups for a given member.

groupsMembershipsSearchTransitiveMemberships(parent: string, opts?: GroupsMembershipsSearchTransitiveMembershipsOptions): Promise<SearchTransitiveMembershipsResponse>

[src]

Search transitive memberships of a group. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the group is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A transitive membership is any direct or indirect membership of a group. Actor must have view permissions to all transitive memberships.

@param parent

Resource name of the group to search transitive memberships in. Format: groups/{group}, where group is the unique ID assigned to the Group.

groupsPatch(name: string, req: Group, opts?: GroupsPatchOptions): Promise<Operation>

[src]

Updates a Group.

@param name

Output only. The resource name of the Group. Shall be of the form groups/{group}.

groupsSearch(opts?: GroupsSearchOptions): Promise<SearchGroupsResponse>

[src]

Searches for Group resources matching a specified query.

groupsUpdateSecuritySettings(name: string, req: SecuritySettings, opts?: GroupsUpdateSecuritySettingsOptions): Promise<Operation>

[src]

Update Security Settings

@param name

Output only. The resource name of the security settings. Shall be of the form groups/{group_id}/securitySettings.

inboundSamlSsoProfilesCreate(req: InboundSamlSsoProfile): Promise<Operation>

[src]

Creates an InboundSamlSsoProfile for a customer.

inboundSamlSsoProfilesDelete(name: string): Promise<Operation>

[src]

Deletes an InboundSamlSsoProfile.

@param name

Required. The resource name of the InboundSamlSsoProfile to delete. Format: inboundSamlSsoProfiles/{sso_profile_id}

inboundSamlSsoProfilesGet(name: string): Promise<InboundSamlSsoProfile>

[src]

Gets an InboundSamlSsoProfile.

@param name

Required. The resource name of the InboundSamlSsoProfile to get. Format: inboundSamlSsoProfiles/{sso_profile_id}

inboundSamlSsoProfilesIdpCredentialsAdd(parent: string, req: AddIdpCredentialRequest): Promise<Operation>

[src]

Adds an IdpCredential. Up to 2 credentials are allowed.

@param parent

Required. The InboundSamlSsoProfile that owns the IdpCredential. Format: inboundSamlSsoProfiles/{sso_profile_id}

inboundSamlSsoProfilesIdpCredentialsDelete(name: string): Promise<Operation>

[src]

Deletes an IdpCredential.

@param name

Required. The resource name of the IdpCredential to delete. Format: inboundSamlSsoProfiles/{sso_profile_id}/idpCredentials/{idp_credential_id}

inboundSamlSsoProfilesIdpCredentialsGet(name: string): Promise<IdpCredential>

[src]

Gets an IdpCredential.

@param name

Required. The resource name of the IdpCredential to retrieve. Format: inboundSamlSsoProfiles/{sso_profile_id}/idpCredentials/{idp_credential_id}

inboundSamlSsoProfilesIdpCredentialsList(parent: string, opts?: InboundSamlSsoProfilesIdpCredentialsListOptions): Promise<ListIdpCredentialsResponse>

[src]

Returns a list of IdpCredentials in an InboundSamlSsoProfile.

@param parent

Required. The parent, which owns this collection of IdpCredentials. Format: inboundSamlSsoProfiles/{sso_profile_id}

inboundSamlSsoProfilesList(opts?: InboundSamlSsoProfilesListOptions): Promise<ListInboundSamlSsoProfilesResponse>

[src]

Lists InboundSamlSsoProfiles for a customer.

inboundSamlSsoProfilesPatch(name: string, req: InboundSamlSsoProfile, opts?: InboundSamlSsoProfilesPatchOptions): Promise<Operation>

[src]

Updates an InboundSamlSsoProfile.

@param name

Output only. Resource name of the SAML SSO profile.

inboundSsoAssignmentsCreate(req: InboundSsoAssignment): Promise<Operation>

[src]

Creates an InboundSsoAssignment for users and devices in a Customer under a given Group or OrgUnit.

inboundSsoAssignmentsDelete(name: string): Promise<Operation>

[src]

Deletes an InboundSsoAssignment. To disable SSO, Create (or Update) an assignment that has sso_mode == SSO_OFF.

@param name

Required. The resource name of the InboundSsoAssignment to delete. Format: inboundSsoAssignments/{assignment}

inboundSsoAssignmentsGet(name: string): Promise<InboundSsoAssignment>

[src]

Gets an InboundSsoAssignment.

@param name

Required. The resource name of the InboundSsoAssignment to fetch. Format: inboundSsoAssignments/{assignment}

inboundSsoAssignmentsList(opts?: InboundSsoAssignmentsListOptions): Promise<ListInboundSsoAssignmentsResponse>

[src]

Lists the InboundSsoAssignments for a Customer.

inboundSsoAssignmentsPatch(name: string, req: InboundSsoAssignment, opts?: InboundSsoAssignmentsPatchOptions): Promise<Operation>

[src]

Updates an InboundSsoAssignment. The body of this request is the inbound_sso_assignment field and the update_mask is relative to that. For example: a PATCH to /v1/inboundSsoAssignments/0abcdefg1234567&update_mask=rank with a body of { "rank": 1 } moves that (presumably group-targeted) SSO assignment to the highest priority and shifts any other group-targeted assignments down in priority.

@param name

Output only. Resource name of the Inbound SSO Assignment.