Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Private device management teams assignment #2941

Merged
merged 2 commits into from
Sep 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 23 additions & 27 deletions docs/basics/acct-team-mgmt/private-device-mgmt.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,12 @@

Private device management allows an organization admin to view and manage the private devices in an organization via the [Private Device Management](https://app.saucelabs.com/team-management/devices) panel. These features can improve device availability and optimize manual and automation workflows.

- Assign a private device to a team.
- Assign a private device to one or multiple teams.
- Customize a private device to allow apps, system apps, and accounts to persist between sessions.

:::important

By assigning a private device to a team, you restrict access to that device to that team. **Note:** organization admins are not affected by this. Organization admins have access to all devices of their organization.

Assigning a private device to specific teams restricts access to only those teams. Organization admins are not affected by this restriction, as they have access to all devices within their organization.

Check warning on line 20 in docs/basics/acct-team-mgmt/private-device-mgmt.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/basics/acct-team-mgmt/private-device-mgmt.md#L20

[sauce.WordList] Use 'in' instead of 'within'.
Raw output
{"message": "[sauce.WordList] Use 'in' instead of 'within'.", "location": {"path": "docs/basics/acct-team-mgmt/private-device-mgmt.md", "range": {"start": {"line": 20, "column": 177}}}, "severity": "WARNING"}
:::

:::note
Expand All @@ -33,30 +32,27 @@
1. On Sauce Labs, click **ACCOUNT** and then click **Organization Management**.
<img src={useBaseUrl('img/team-mgmt/team-mgmt-nav.png')} alt="Organization management navigation" width="450"/>
2. Click the **DEVICES** tab. The devices assigned to your organization will be listed.
<img src={useBaseUrl('img/team-mgmt/device-mgmt-devices-tab.png')} alt="Devices tab" width="600"/>

## Assigning a Private Device to a Team
<img src={useBaseUrl('img/team-mgmt/device-mgmt-devices-tab.png')} alt="Devices tab" width="700"/>

:::note
A device can be assigned to only 1 team at a time.
:::
## Customizing Private Devices

1. On Sauce Labs, click **ACCOUNT** and then click **Organization Management**.
2. On the **DEVICES** tab, in the **Team** dropdown, select a team to assign the device to.
<img src={useBaseUrl('img/team-mgmt/device-mgmt-assign-team.png')} alt="Assign a team" width="600"/>
2. On the **DEVICES** tab, click on the Pencil icon under the Action column to edit a device.
<img src={useBaseUrl('img/team-mgmt/device-mgmt-device-edit.png')} alt="Private device management edit" width="700"/>
3. In the device modal, you can configure your private device: Team Assignment, App Allow List, Account Allow List, System App Allow List, Retain folders, Enable Apple Pay.

Check warning on line 43 in docs/basics/acct-team-mgmt/private-device-mgmt.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/basics/acct-team-mgmt/private-device-mgmt.md#L43

[sauce.EOLWhitespace] Remove whitespace characters from the end of the line.
Raw output
{"message": "[sauce.EOLWhitespace] Remove whitespace characters from the end of the line.", "location": {"path": "docs/basics/acct-team-mgmt/private-device-mgmt.md", "range": {"start": {"line": 43, "column": 1}}}, "severity": "WARNING"}
<img src={useBaseUrl('img/team-mgmt/device-mgmt-device-edit-modal.png')} alt="Private device management modal view" width="450" height="600"/>

### Assigning a Private Device to Teams
Select one or more teams from the dropdown menu to assign the private device. By assigning a private device to one or more teams, you restrict access to that device to only the teams it is assigned to. However, this restriction does not apply to organization admins, who continue to have access to all devices within their organization. To grant access to the device for all teams, remove any current team assignments.

Check warning on line 47 in docs/basics/acct-team-mgmt/private-device-mgmt.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/basics/acct-team-mgmt/private-device-mgmt.md#L47

[sauce.Dropdown] Use 'dropdown list' to refer to the UI element. Do not use dropdown without list after it. Do not use drop-down (hyphenated), dropdown menu, or other variants. For example: 'From the Visibility dropdown list, select Public.'
Raw output
{"message": "[sauce.Dropdown] Use 'dropdown list' to refer to the UI element. Do not use dropdown without list after it. Do not use drop-down (hyphenated), dropdown menu, or other variants. For example: 'From the Visibility dropdown list, select Public.'", "location": {"path": "docs/basics/acct-team-mgmt/private-device-mgmt.md", "range": {"start": {"line": 47, "column": 35}}}, "severity": "WARNING"}

Check warning on line 47 in docs/basics/acct-team-mgmt/private-device-mgmt.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/basics/acct-team-mgmt/private-device-mgmt.md#L47

[sauce.WordList] Use 'in' instead of 'within'.
Raw output
{"message": "[sauce.WordList] Use 'in' instead of 'within'.", "location": {"path": "docs/basics/acct-team-mgmt/private-device-mgmt.md", "range": {"start": {"line": 47, "column": 311}}}, "severity": "WARNING"}

# Customizing Private devices:

1. On Sauce Labs, click **ACCOUNT** and then click **Organization Management**.
2. On the **DEVICES** tab, click on the Pencil icon under Action column.
3. Under the Action column, click the Pencil icon to edit a device.
4. In the new device modal, you can configure your private device: App Allow List, Account Allow List, System App Allow List, Retain folders, Enable Apple Pay
:::note
Any new team assignments will override the existing ones.
:::

<img src={useBaseUrl('img/team-mgmt/private-device-management-edit.png')} alt="Private device management edit" width="450"/>
<img src={useBaseUrl('img/team-mgmt/private-device-management-modal.png')} alt="Private device management modal view" width="450"/>
<img src={useBaseUrl('img/team-mgmt/device-mgmt-team-assignment.png')} alt="Assign teams" width="700"/>

## App Allow List
### App Allow List
The [device cleaning process](/mobile-apps/real-device-cleaning) will remove apps installed from [Sauce Storage](/mobile-apps/app-storage) and the App Store/Play Store between sessions. To have installed apps and app data persist between sessions, update this setting for each of the application identifiers. This might be the app you are testing or dependent apps, e.g. MFA app, Microsoft Authenticator, etc.

:::important
Expand All @@ -73,7 +69,7 @@
*Multiple entries must be comma-separated.*
:::

## System App Allow List (iOS)
### System App Allow List (iOS)

Certain iOS preinstalled apps are hidden by default, e.g. Messages, Mail, Notes. To access iOS preinstalled applications, add the bundle ID for each app.

Expand All @@ -87,12 +83,12 @@
*Multiple entries must be comma-separated.*
:::

## Account Allow List
### Account Allow List

Update this setting for each account email to preserve store and payment account sign-ins between sessions.

- Google accounts signed into the Play Store/Google Pay/In-App Purchase can be preserved between sessions.
- Apple IDs signed into the device and App Store/TestFlight/Apple Pay/In-App Purchase can be preserved between sessions.
- Google accounts signed in to the Play Store/Google Pay/In-App Purchase can be preserved between sessions.
- Apple IDs signed in to the device and App Store/TestFlight/Apple Pay/In-App Purchase can be preserved between sessions.

:::important
`[email protected]`
Expand All @@ -101,7 +97,7 @@
*Multiple entries must be comma-separated.*
:::

## Retain folders/filepath (Android)
### Retain folders/filepath (Android)

Check warning on line 100 in docs/basics/acct-team-mgmt/private-device-mgmt.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/basics/acct-team-mgmt/private-device-mgmt.md#L100

[sauce.Headings] 'Retain folders/filepath (Android)' should use title case capitalization.
Raw output
{"message": "[sauce.Headings] 'Retain folders/filepath (Android)' should use title case capitalization.", "location": {"path": "docs/basics/acct-team-mgmt/private-device-mgmt.md", "range": {"start": {"line": 100, "column": 5}}}, "severity": "WARNING"}

You have the option to retain specific filepaths or folders on your private Android devices between sessions.
This feature ensures that selected data remains intact during the device cleaning process.
Expand All @@ -128,7 +124,7 @@
*Multiple entries must be comma-separated.*
:::

## Enable Apple Pay
### Enable Apple Pay

Enable this setting to test Apple Pay. This will persist assistive touch on the device, which is required to confirm payment.
Please send us a support ticket to set up Confirm with AssistiveTouch on your device. This requires manual intervention from our side.
Expand All @@ -140,4 +136,4 @@

## Private Device Management API
Easily manage your private real devices with our [Device Management API endpoints](/dev/api/rdc/#private-real-device-management)
to obtain device information, assign devices to a specific team, and update device settings efficiently.
to obtain device information, assign devices to specific teams, and update device settings efficiently.

Check warning on line 139 in docs/basics/acct-team-mgmt/private-device-mgmt.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/basics/acct-team-mgmt/private-device-mgmt.md#L139

[sauce.EOLWhitespace] Remove whitespace characters from the end of the line.
Raw output
{"message": "[sauce.EOLWhitespace] Remove whitespace characters from the end of the line.", "location": {"path": "docs/basics/acct-team-mgmt/private-device-mgmt.md", "range": {"start": {"line": 139, "column": 104}}}, "severity": "WARNING"}
Binary file removed static/img/team-mgmt/device-mgmt-assign-team.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/team-mgmt/device-mgmt-device-edit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/team-mgmt/device-mgmt-devices-tab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.