scim_enterprise_groups
Overview
| Name | scim_enterprise_groups |
| Type | Resource |
| Id | github.enterprise_admin.scim_enterprise_groups |
Fields
| Name | Datatype |
|---|---|
id | string |
schemas | array |
displayName | string |
externalId | string |
members | array |
meta | object |
Methods
| Name | Accessible by | Required Params | Description |
|---|---|---|---|
get_provisioning_information_for_enterprise_group | SELECT | enterprise, scim_group_id | Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. |
list_provisioned_groups_enterprise | SELECT | enterprise | Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. |
provision_and_invite_enterprise_group | INSERT | enterprise, data__displayName, data__schemas | Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. Provision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to. |
delete_scim_group_from_enterprise | DELETE | enterprise, scim_group_id | Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. |
set_information_for_provisioned_enterprise_group | EXEC | enterprise, scim_group_id, data__displayName, data__schemas | Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. Replaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the Update an attribute for a SCIM enterprise group endpoint instead. |
update_attribute_for_enterprise_group | EXEC | enterprise, scim_group_id, data__Operations, data__schemas | Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. Allows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification. |