Skip to content

Commit

Permalink
GITBOOK-7800: Admin: Provision users to Organizations using the Snyk …
Browse files Browse the repository at this point in the history
…API, upd title, links
  • Loading branch information
awileysnyk authored and gitbook-bot committed Aug 19, 2024
1 parent d3ec9e7 commit 8558b3e
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -835,7 +835,7 @@
* [Read-only CLI Tester role template](snyk-admin/user-roles/custom-role-templates/read-only-cli-tester-role-template.md)
* [Snyk Learn - Learning Admin](snyk-admin/user-roles/custom-role-templates/snyk-learn-learning-admin.md)
* [User management with the Snyk API](snyk-admin/user-management-with-the-snyk-api/README.md)
* [Provision users to Organizations using the V1 API](snyk-admin/user-management-with-the-snyk-api/provision-users-to-organizations-using-the-v1-api.md)
* [Provision users to Organizations using the Snyk API](snyk-admin/user-management-with-the-snyk-api/provision-users-to-organizations-using-the-snyk-api.md)
* [Update member roles using the V1 API](snyk-admin/user-management-with-the-snyk-api/update-member-roles-using-the-v1-api.md)
* [Remove members from Groups and Orgs using the API](snyk-admin/user-management-with-the-snyk-api/remove-members-from-groups-and-orgs-using-the-api.md)
* [Retrieve audit logs of user-initiated activity by API for an Org or Group](snyk-admin/user-management-with-the-snyk-api/retrieve-audit-logs-of-user-initiated-activity-by-api-for-an-org-or-group.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/snyk-admin/groups-and-organizations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Snyk has a hierarchy that allows you to control access to Snyk scanning and feat
* [**Organizations**](organizations/): An Organization represents a specific business area, such as a team. Organizations can contain multiple Projects.
* [**Projects**](../snyk-projects/)**:** A Project is established based on the item that Snyk scans for issues, such as a manifest file. Each Project shows the results of scans. You can configure your Projects to define how to scan for issues in that Project.

Snyk also has features to [manage users in Organizations](organizations/manage-users-in-organizations.md) and to [manage users in a Group](groups/manage-users-in-a-group.md). You can use the Snyk API v1 to [provision users to Orgs](../user-management-with-the-snyk-api/provision-users-to-organizations-using-the-v1-api.md) and [remove members from Groups and Orgs](../user-management-with-the-snyk-api/remove-members-from-groups-and-orgs-using-the-api.md).
Snyk also has features to [manage users in Organizations](organizations/manage-users-in-organizations.md) and to [manage users in a Group](groups/manage-users-in-a-group.md). You can use the Snyk API v1 to [provision users to Orgs](../user-management-with-the-snyk-api/provision-users-to-organizations-using-the-snyk-api.md) and [remove members from Groups and Orgs](../user-management-with-the-snyk-api/remove-members-from-groups-and-orgs-using-the-api.md).

You can [use Organization access requests](organizations/requests-for-access-to-an-organization.md) to add users and [configure session length for a Snyk Group](groups/configure-session-length-for-a-snyk-group.md).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ For more information, see [Plans and pricing](https://snyk.io/plans).

You can manage users through the Snyk Web UI, and also the Snyk API [V1](https://snyk.docs.apiary.io) and [REST](https://apidocs.snyk.io/?version=2024-01-04#overview). In addition, you can [manage service accounts](../../enterprise-configuration/service-accounts/manage-service-accounts-using-the-snyk-api.md) using the Snyk REST API.

* You can use the [provisioning endpoints ](provision-users-to-organizations-using-the-v1-api.md)to organize and grant permissions under a specified role for SSO users before initial log-on.
* You can use the [provisioning endpoints ](provision-users-to-organizations-using-the-snyk-api.md)to organize and grant permissions under a specified role for SSO users before initial log-on.
* You must use the API to [update member roles](update-member-roles-using-the-v1-api.md).
* You can [remove users from Groups and Organizations](remove-members-from-groups-and-orgs-using-the-api.md) programmatically using the member endpoints.
* You can retrieve [audit logs](retrieve-audit-logs-of-user-initiated-activity-by-api-for-an-org-or-group.md) for the past 90 days using the Group-level audit logs endpoint to monitor user activity.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Provision users to Organizations using the V1 API
# Provision users to Organizations using the Snyk API

The [Provision user endpoints](https://snyk.docs.apiary.io/#reference/organizations/provision-user/provision-a-user-to-the-organization) allow you to organize and grant permissions to your single sign-on users before the users log in to the Snyk platform.
The Provision user endpoints allow you to organize and grant permissions to your single sign-on users before the users log in to the Snyk platform. The endpoints are [Provision a user to the organizaton](../../snyk-api/reference/organizations-v1.md#org-orgid-provision), [List pending user provisions](../../snyk-api/reference/organizations-v1.md#org-orgid-provision-1), and [Delete pending user provisions](../../snyk-api/reference/organizations-v1.md#org-orgid-provision-2).

Provisioned users do not need to accept invites. When provisioned users first log in to Snyk, they will have all their permissions. You can use the [Provision a user to the organization](https://snyk.docs.apiary.io/#reference/organizations/provision-user/provision-a-user-to-the-organization) endpoint to add users to Organizations at scale before their first login.

Expand All @@ -20,7 +20,7 @@ The API does not support using service accounts as the inviting user or provisio

## How to use the Provision user API

The following explains how to use the Provision user endpoints. For more information, see the [API documentation](https://snyk.docs.apiary.io/#reference/organizations/provision-user/provision-a-user-to-the-organization).
The following explains how to use the Provision user endpoints. For more information, see the API documentation: [Provision a user to the organizaton](../../snyk-api/reference/organizations-v1.md#org-orgid-provision), [List pending user provisions](../../snyk-api/reference/organizations-v1.md#org-orgid-provision-1), and [Delete pending user provisions](../../snyk-api/reference/organizations-v1.md#org-orgid-provision-2).

### Provision a user to the Organization

Expand Down Expand Up @@ -62,7 +62,7 @@ You can use either `role` or `rolePublicId` but not both in the same call.

### List pending user provisions

The List pending user permissions endpoint returns pending provisioned users in the response.
The [List pending user provisions](../../snyk-api/reference/organizations-v1.md#org-orgid-provision-1) endpoint returns pending provisioned users in the response.

**`GET`** `https://api.snyk.io/v1/org/orgId/provision`

Expand Down Expand Up @@ -90,7 +90,7 @@ The List pending user permissions endpoint returns pending provisioned users in

### Delete pending user provision

Use the Delete pending use provision endpoint to remove a pending provision request.
Use the [Delete pending use provision endpoint to remove a pending provision request](../../snyk-api/reference/organizations-v1.md#org-orgid-provision-2).

**`DELETE`** `https://api.snyk.io/v1/org/orgId/provision`

Expand Down
2 changes: 1 addition & 1 deletion docs/snyk-api/api-endpoints-index-and-notes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -358,7 +358,7 @@ More information: [ Reachability](../../manage-risk/prioritize-issues-for-fixing

### [Provision a user to the organization](../reference/organizations-v1.md#org-orgid-provision)

**More information:** [Provision users to Organizations using the V1 API](../../snyk-admin/user-management-with-the-snyk-api/provision-users-to-organizations-using-the-v1-api.md).
**More information:** [Provision users to Organizations using the V1 API](../../snyk-admin/user-management-with-the-snyk-api/provision-users-to-organizations-using-the-snyk-api.md).

### [List pending user provisions](../reference/organizations-v1.md#org-orgid-provision-1)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ API v1 [Invite users](https://snyk.docs.apiary.io/#reference/groups/list-all-rol

### Add users to organizations at scale ahead of the first login

Scenario: [Provision users to Orgs via API](../../snyk-admin/user-management-with-the-snyk-api/provision-users-to-organizations-using-the-v1-api.md)
Scenario: [Provision users to Orgs via API](../../snyk-admin/user-management-with-the-snyk-api/provision-users-to-organizations-using-the-snyk-api.md)

**Endpoint used:**\
API v1 [Provision a user to the organization](https://snyk.docs.apiary.io/#reference/organizations/provision-user/provision-a-user-to-the-organization)
Expand Down Expand Up @@ -238,7 +238,7 @@ API v1 [Import targets](https://snyk.docs.apiary.io/#reference/import-projects)
## API v1 Users and Roles

SEE:\
[Provision users to Orgs via API](../../snyk-admin/user-management-with-the-snyk-api/provision-users-to-organizations-using-the-v1-api.md)\
[Provision users to Orgs via API](../../snyk-admin/user-management-with-the-snyk-api/provision-users-to-organizations-using-the-snyk-api.md)\
[Remove members from Groups and Orgs via API](../../snyk-admin/user-management-with-the-snyk-api/remove-members-from-groups-and-orgs-using-the-api.md)\
[Update Member Roles via API](../../snyk-admin/user-management-with-the-snyk-api/update-member-roles-using-the-v1-api.md) (also Snyk REST API Users endpoint `PATCH https://api.snyk.io/rest/groups/{group_id}/users/{id}?version=2023-01-30~beta)`

Expand Down

0 comments on commit 8558b3e

Please sign in to comment.