scim

package
v0.0.6-GHES.3.11 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 20, 2024 License: MIT Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ScimRequestBuilder 

type ScimRequestBuilder struct {
	i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}

ScimRequestBuilder builds and executes requests for operations under \scim

func NewScimRequestBuilder 

func NewScimRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ScimRequestBuilder

NewScimRequestBuilder instantiates a new ScimRequestBuilder and sets the default values.

func NewScimRequestBuilderInternal 

func NewScimRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ScimRequestBuilder

NewScimRequestBuilderInternal instantiates a new ScimRequestBuilder and sets the default values.

func (*ScimRequestBuilder) V2 

func (m *ScimRequestBuilder) V2() *V2RequestBuilder

V2 the v2 property returns a *V2RequestBuilder when successful

type V2EnterprisesItemGroupsRequestBuilder 

type V2EnterprisesItemGroupsRequestBuilder struct {
	i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}

V2EnterprisesItemGroupsRequestBuilder builds and executes requests for operations under \scim\v2\enterprises\{enterprise}\Groups

func NewV2EnterprisesItemGroupsRequestBuilder 

func NewV2EnterprisesItemGroupsRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *V2EnterprisesItemGroupsRequestBuilder

NewV2EnterprisesItemGroupsRequestBuilder instantiates a new V2EnterprisesItemGroupsRequestBuilder and sets the default values.

func NewV2EnterprisesItemGroupsRequestBuilderInternal 

func NewV2EnterprisesItemGroupsRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *V2EnterprisesItemGroupsRequestBuilder

NewV2EnterprisesItemGroupsRequestBuilderInternal instantiates a new V2EnterprisesItemGroupsRequestBuilder and sets the default values.

func (*V2EnterprisesItemGroupsRequestBuilder) ByScim_group_id 

func (m *V2EnterprisesItemGroupsRequestBuilder) ByScim_group_id(scim_group_id string) *V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder

ByScim_group_id gets an item from the github.com/octokit/go-sdk-enterprise-server/pkg/github.scim.v2.enterprises.item.Groups.item collection returns a *V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder when successful

func (*V2EnterprisesItemGroupsRequestBuilder) Get 

func (m *V2EnterprisesItemGroupsRequestBuilder) Get(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[V2EnterprisesItemGroupsRequestBuilderGetQueryParameters]) (ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.ScimEnterpriseGroupListable, error)

Get > [!NOTE]> The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.Lists provisioned SCIM groups in an enterprise.You can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response. returns a ScimEnterpriseGroupListable when successful returns a ScimError error when the service returns a 400 status code returns a ScimError error when the service returns a 429 status code returns a ScimError error when the service returns a 500 status code API method documentation

func (*V2EnterprisesItemGroupsRequestBuilder) Post 

func (m *V2EnterprisesItemGroupsRequestBuilder) Post(ctx context.Context, body ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.Groupable, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.ScimEnterpriseGroupResponseable, error)

Post > [!NOTE]> The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.Creates a SCIM group for an enterprise.If members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user. returns a ScimEnterpriseGroupResponseable when successful returns a ScimError error when the service returns a 400 status code returns a ScimError error when the service returns a 429 status code returns a ScimError error when the service returns a 500 status code API method documentation

func (*V2EnterprisesItemGroupsRequestBuilder) ToGetRequestInformation 

func (m *V2EnterprisesItemGroupsRequestBuilder) ToGetRequestInformation(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[V2EnterprisesItemGroupsRequestBuilderGetQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)

ToGetRequestInformation > [!NOTE]> The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.Lists provisioned SCIM groups in an enterprise.You can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response. returns a *RequestInformation when successful

func (*V2EnterprisesItemGroupsRequestBuilder) ToPostRequestInformation 

func (m *V2EnterprisesItemGroupsRequestBuilder) ToPostRequestInformation(ctx context.Context, body ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.Groupable, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)

ToPostRequestInformation > [!NOTE]> The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.Creates a SCIM group for an enterprise.If members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user. returns a *RequestInformation when successful

func (*V2EnterprisesItemGroupsRequestBuilder) WithUrl 

func (m *V2EnterprisesItemGroupsRequestBuilder) WithUrl(rawUrl string) *V2EnterprisesItemGroupsRequestBuilder

WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *V2EnterprisesItemGroupsRequestBuilder when successful

type V2EnterprisesItemGroupsRequestBuilderGetQueryParameters 

type V2EnterprisesItemGroupsRequestBuilderGetQueryParameters struct {
	// Used for pagination: the number of results to return per page.
	Count *int32 `uriparametername:"count"`
	// Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time.
	ExcludedAttributes *string `uriparametername:"excludedAttributes"`
	// If specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are `externalId`, `id`, and `displayName`. For example, `?filter="externalId eq '9138790-10932-109120392-12321'"`.
	Filter *string `uriparametername:"filter"`
	// Used for pagination: the starting index of the first result to return when paginating through values.
	StartIndex *int32 `uriparametername:"startIndex"`
}

V2EnterprisesItemGroupsRequestBuilderGetQueryParameters > [!NOTE]> The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.Lists provisioned SCIM groups in an enterprise.You can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response.

type V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder 

type V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder struct {
	i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}

V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder builds and executes requests for operations under \scim\v2\enterprises\{enterprise}\Groups\{scim_group_id}

func NewV2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder 

func NewV2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder

NewV2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder instantiates a new V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder and sets the default values.

func NewV2EnterprisesItemGroupsWithScim_group_ItemRequestBuilderInternal 

func NewV2EnterprisesItemGroupsWithScim_group_ItemRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder

NewV2EnterprisesItemGroupsWithScim_group_ItemRequestBuilderInternal instantiates a new V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder and sets the default values.

func (*V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder) Delete 

func (m *V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder) Delete(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) error

Delete > [!NOTE]> The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.Deletes a SCIM group from an enterprise. returns a ScimError error when the service returns a 400 status code returns a BasicError error when the service returns a 404 status code returns a ScimError error when the service returns a 429 status code returns a ScimError error when the service returns a 500 status code API method documentation

func (*V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder) Get 

func (m *V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder) Get(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilderGetQueryParameters]) (ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.ScimEnterpriseGroupResponseable, error)

Get > [!NOTE]> The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.Gets information about a SCIM group. returns a ScimEnterpriseGroupResponseable when successful returns a ScimError error when the service returns a 400 status code returns a BasicError error when the service returns a 404 status code returns a ScimError error when the service returns a 429 status code returns a ScimError error when the service returns a 500 status code API method documentation

func (*V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder) Patch 

func (m *V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder) Patch(ctx context.Context, body ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.PatchSchemaable, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.ScimEnterpriseGroupResponseable, error)

Patch > [!NOTE]> The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.Update 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](https://tools.ietf.org/html/rfc7644#section-3.5.2). Update can also be used to add group memberships.Group memberships can be sent one at a time or in batches for faster performance. **Note**: The memberships are referenced through a local user `id`, and the user will need to be created before they are referenced here. returns a ScimEnterpriseGroupResponseable when successful returns a ScimError error when the service returns a 400 status code returns a BasicError error when the service returns a 404 status code returns a ScimError error when the service returns a 429 status code returns a ScimError error when the service returns a 500 status code API method documentation

func (*V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder) Put 

func (m *V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder) Put(ctx context.Context, body ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.Groupable, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.ScimEnterpriseGroupResponseable, error)

Put > [!NOTE]> The SCIM API endpoints for enterprise accounts are currently in *private* 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](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. returns a ScimEnterpriseGroupResponseable when successful returns a ScimError error when the service returns a 400 status code returns a BasicError error when the service returns a 404 status code returns a ScimError error when the service returns a 429 status code returns a ScimError error when the service returns a 500 status code API method documentation

func (*V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder) ToDeleteRequestInformation 

func (m *V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder) ToDeleteRequestInformation(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)

ToDeleteRequestInformation > [!NOTE]> The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.Deletes a SCIM group from an enterprise. returns a *RequestInformation when successful

func (*V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder) ToGetRequestInformation 

func (m *V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder) ToGetRequestInformation(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilderGetQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)

ToGetRequestInformation > [!NOTE]> The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.Gets information about a SCIM group. returns a *RequestInformation when successful

func (*V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder) ToPatchRequestInformation 

func (m *V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder) ToPatchRequestInformation(ctx context.Context, body ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.PatchSchemaable, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)

ToPatchRequestInformation > [!NOTE]> The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.Update 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](https://tools.ietf.org/html/rfc7644#section-3.5.2). Update can also be used to add group memberships.Group memberships can be sent one at a time or in batches for faster performance. **Note**: The memberships are referenced through a local user `id`, and the user will need to be created before they are referenced here. returns a *RequestInformation when successful

func (*V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder) ToPutRequestInformation 

func (m *V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder) ToPutRequestInformation(ctx context.Context, body ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.Groupable, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)

ToPutRequestInformation > [!NOTE]> The SCIM API endpoints for enterprise accounts are currently in *private* 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](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. returns a *RequestInformation when successful

func (*V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder) WithUrl 

func (m *V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder) WithUrl(rawUrl string) *V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder

WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilder when successful

type V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilderGetQueryParameters 

type V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilderGetQueryParameters struct {
	// Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time.
	ExcludedAttributes *string `uriparametername:"excludedAttributes"`
}

V2EnterprisesItemGroupsWithScim_group_ItemRequestBuilderGetQueryParameters > [!NOTE]> The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.Gets information about a SCIM group.

type V2EnterprisesItemUsersRequestBuilder 

type V2EnterprisesItemUsersRequestBuilder struct {
	i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}

V2EnterprisesItemUsersRequestBuilder builds and executes requests for operations under \scim\v2\enterprises\{enterprise}\Users

func NewV2EnterprisesItemUsersRequestBuilder 

func NewV2EnterprisesItemUsersRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *V2EnterprisesItemUsersRequestBuilder

NewV2EnterprisesItemUsersRequestBuilder instantiates a new V2EnterprisesItemUsersRequestBuilder and sets the default values.

func NewV2EnterprisesItemUsersRequestBuilderInternal 

func NewV2EnterprisesItemUsersRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *V2EnterprisesItemUsersRequestBuilder

NewV2EnterprisesItemUsersRequestBuilderInternal instantiates a new V2EnterprisesItemUsersRequestBuilder and sets the default values.

func (*V2EnterprisesItemUsersRequestBuilder) ByScim_user_id 

func (m *V2EnterprisesItemUsersRequestBuilder) ByScim_user_id(scim_user_id string) *V2EnterprisesItemUsersWithScim_user_ItemRequestBuilder

ByScim_user_id gets an item from the github.com/octokit/go-sdk-enterprise-server/pkg/github.scim.v2.enterprises.item.Users.item collection returns a *V2EnterprisesItemUsersWithScim_user_ItemRequestBuilder when successful

func (*V2EnterprisesItemUsersRequestBuilder) Get 

func (m *V2EnterprisesItemUsersRequestBuilder) Get(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[V2EnterprisesItemUsersRequestBuilderGetQueryParameters]) (ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.ScimEnterpriseUserListable, error)

Get > [!NOTE]> The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.Lists provisioned SCIM enterprise members.When a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the `delete` request. Users that were not permanently deleted will be visible in the returned results. returns a ScimEnterpriseUserListable when successful returns a ScimError error when the service returns a 400 status code returns a ScimError error when the service returns a 429 status code returns a ScimError error when the service returns a 500 status code API method documentation

func (*V2EnterprisesItemUsersRequestBuilder) Post 

func (m *V2EnterprisesItemUsersRequestBuilder) Post(ctx context.Context, body ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.Userable, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.ScimEnterpriseUserResponseable, error)

Post > [!NOTE]> The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.Creates an external identity for a new SCIM enterprise user.SCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response `NameID` to SCIM `userName`.When converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users. returns a ScimEnterpriseUserResponseable when successful returns a ScimError error when the service returns a 400 status code returns a ScimError error when the service returns a 429 status code returns a ScimError error when the service returns a 500 status code API method documentation

func (*V2EnterprisesItemUsersRequestBuilder) ToGetRequestInformation 

func (m *V2EnterprisesItemUsersRequestBuilder) ToGetRequestInformation(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[V2EnterprisesItemUsersRequestBuilderGetQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)

ToGetRequestInformation > [!NOTE]> The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.Lists provisioned SCIM enterprise members.When a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the `delete` request. Users that were not permanently deleted will be visible in the returned results. returns a *RequestInformation when successful

func (*V2EnterprisesItemUsersRequestBuilder) ToPostRequestInformation 

func (m *V2EnterprisesItemUsersRequestBuilder) ToPostRequestInformation(ctx context.Context, body ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.Userable, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)

ToPostRequestInformation > [!NOTE]> The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.Creates an external identity for a new SCIM enterprise user.SCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response `NameID` to SCIM `userName`.When converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users. returns a *RequestInformation when successful

func (*V2EnterprisesItemUsersRequestBuilder) WithUrl 

func (m *V2EnterprisesItemUsersRequestBuilder) WithUrl(rawUrl string) *V2EnterprisesItemUsersRequestBuilder

WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *V2EnterprisesItemUsersRequestBuilder when successful

type V2EnterprisesItemUsersRequestBuilderGetQueryParameters 

type V2EnterprisesItemUsersRequestBuilderGetQueryParameters struct {
	// Used for pagination: the number of results to return per page.
	Count *int32 `uriparametername:"count"`
	// If specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are `userName`, `externalId`, `id`, and `displayName`. For example, `?filter="externalId eq '9138790-10932-109120392-12321'"`.
	Filter *string `uriparametername:"filter"`
	// Used for pagination: the starting index of the first result to return when paginating through values.
	StartIndex *int32 `uriparametername:"startIndex"`
}

V2EnterprisesItemUsersRequestBuilderGetQueryParameters > [!NOTE]> The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.Lists provisioned SCIM enterprise members.When a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the `delete` request. Users that were not permanently deleted will be visible in the returned results.

type V2EnterprisesItemUsersWithScim_user_ItemRequestBuilder 

type V2EnterprisesItemUsersWithScim_user_ItemRequestBuilder struct {
	i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}

V2EnterprisesItemUsersWithScim_user_ItemRequestBuilder builds and executes requests for operations under \scim\v2\enterprises\{enterprise}\Users\{scim_user_id}

func NewV2EnterprisesItemUsersWithScim_user_ItemRequestBuilder 

func NewV2EnterprisesItemUsersWithScim_user_ItemRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *V2EnterprisesItemUsersWithScim_user_ItemRequestBuilder

NewV2EnterprisesItemUsersWithScim_user_ItemRequestBuilder instantiates a new V2EnterprisesItemUsersWithScim_user_ItemRequestBuilder and sets the default values.

func NewV2EnterprisesItemUsersWithScim_user_ItemRequestBuilderInternal 

func NewV2EnterprisesItemUsersWithScim_user_ItemRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *V2EnterprisesItemUsersWithScim_user_ItemRequestBuilder

NewV2EnterprisesItemUsersWithScim_user_ItemRequestBuilderInternal instantiates a new V2EnterprisesItemUsersWithScim_user_ItemRequestBuilder and sets the default values.

func (*V2EnterprisesItemUsersWithScim_user_ItemRequestBuilder) Delete 

func (m *V2EnterprisesItemUsersWithScim_user_ItemRequestBuilder) Delete(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) error

Delete > [!NOTE]> The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.Permanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action. returns a ScimError error when the service returns a 400 status code returns a BasicError error when the service returns a 404 status code returns a ScimError error when the service returns a 429 status code returns a ScimError error when the service returns a 500 status code API method documentation

func (*V2EnterprisesItemUsersWithScim_user_ItemRequestBuilder) Get 

func (m *V2EnterprisesItemUsersWithScim_user_ItemRequestBuilder) Get(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.ScimEnterpriseUserResponseable, error)

Get > [!NOTE]> The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.Gets information about a SCIM user. returns a ScimEnterpriseUserResponseable when successful returns a ScimError error when the service returns a 400 status code returns a BasicError error when the service returns a 404 status code returns a ScimError error when the service returns a 429 status code returns a ScimError error when the service returns a 500 status code API method documentation

func (*V2EnterprisesItemUsersWithScim_user_ItemRequestBuilder) Patch 

func (m *V2EnterprisesItemUsersWithScim_user_ItemRequestBuilder) Patch(ctx context.Context, body ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.PatchSchemaable, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.ScimEnterpriseUserResponseable, error)

Patch > [!NOTE]> The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.Update a provisioned user's individual attributes.To change a user'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](https://tools.ietf.org/html/rfc7644#section-3.5.2).> [!NOTE]> Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work.> [!WARNING]> Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.> ```> {> "Operations":[{> "op":"replace",> "value":{> "active":false> }> }]> }> ``` returns a ScimEnterpriseUserResponseable when successful returns a ScimError error when the service returns a 400 status code returns a BasicError error when the service returns a 404 status code returns a ScimError error when the service returns a 429 status code returns a ScimError error when the service returns a 500 status code API method documentation

func (*V2EnterprisesItemUsersWithScim_user_ItemRequestBuilder) Put 

func (m *V2EnterprisesItemUsersWithScim_user_ItemRequestBuilder) Put(ctx context.Context, body ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.Userable, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.ScimEnterpriseUserResponseable, error)

Put > [!NOTE]> The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.Replaces an existing provisioned user's information.You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead.> [!WARNING]> Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. returns a ScimEnterpriseUserResponseable when successful returns a ScimError error when the service returns a 400 status code returns a BasicError error when the service returns a 404 status code returns a ScimError error when the service returns a 429 status code returns a ScimError error when the service returns a 500 status code API method documentation

func (*V2EnterprisesItemUsersWithScim_user_ItemRequestBuilder) ToDeleteRequestInformation 

func (m *V2EnterprisesItemUsersWithScim_user_ItemRequestBuilder) ToDeleteRequestInformation(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)

ToDeleteRequestInformation > [!NOTE]> The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.Permanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action. returns a *RequestInformation when successful

func (*V2EnterprisesItemUsersWithScim_user_ItemRequestBuilder) ToGetRequestInformation 

func (m *V2EnterprisesItemUsersWithScim_user_ItemRequestBuilder) ToGetRequestInformation(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)

ToGetRequestInformation > [!NOTE]> The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.Gets information about a SCIM user. returns a *RequestInformation when successful

func (*V2EnterprisesItemUsersWithScim_user_ItemRequestBuilder) ToPatchRequestInformation 

func (m *V2EnterprisesItemUsersWithScim_user_ItemRequestBuilder) ToPatchRequestInformation(ctx context.Context, body ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.PatchSchemaable, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)

ToPatchRequestInformation > [!NOTE]> The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.Update a provisioned user's individual attributes.To change a user'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](https://tools.ietf.org/html/rfc7644#section-3.5.2).> [!NOTE]> Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work.> [!WARNING]> Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.> ```> {> "Operations":[{> "op":"replace",> "value":{> "active":false> }> }]> }> ``` returns a *RequestInformation when successful

func (*V2EnterprisesItemUsersWithScim_user_ItemRequestBuilder) ToPutRequestInformation 

func (m *V2EnterprisesItemUsersWithScim_user_ItemRequestBuilder) ToPutRequestInformation(ctx context.Context, body ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.Userable, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)

ToPutRequestInformation > [!NOTE]> The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.Replaces an existing provisioned user's information.You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead.> [!WARNING]> Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. returns a *RequestInformation when successful

func (*V2EnterprisesItemUsersWithScim_user_ItemRequestBuilder) WithUrl 

func (m *V2EnterprisesItemUsersWithScim_user_ItemRequestBuilder) WithUrl(rawUrl string) *V2EnterprisesItemUsersWithScim_user_ItemRequestBuilder

WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *V2EnterprisesItemUsersWithScim_user_ItemRequestBuilder when successful

type V2EnterprisesRequestBuilder 

type V2EnterprisesRequestBuilder struct {
	i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}

V2EnterprisesRequestBuilder builds and executes requests for operations under \scim\v2\enterprises

func NewV2EnterprisesRequestBuilder 

func NewV2EnterprisesRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *V2EnterprisesRequestBuilder

NewV2EnterprisesRequestBuilder instantiates a new V2EnterprisesRequestBuilder and sets the default values.

func NewV2EnterprisesRequestBuilderInternal 

func NewV2EnterprisesRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *V2EnterprisesRequestBuilder

NewV2EnterprisesRequestBuilderInternal instantiates a new V2EnterprisesRequestBuilder and sets the default values.

func (*V2EnterprisesRequestBuilder) ByEnterprise 

func (m *V2EnterprisesRequestBuilder) ByEnterprise(enterprise string) *V2EnterprisesWithEnterpriseItemRequestBuilder

ByEnterprise gets an item from the github.com/octokit/go-sdk-enterprise-server/pkg/github.scim.v2.enterprises.item collection returns a *V2EnterprisesWithEnterpriseItemRequestBuilder when successful

type V2EnterprisesWithEnterpriseItemRequestBuilder 

type V2EnterprisesWithEnterpriseItemRequestBuilder struct {
	i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}

V2EnterprisesWithEnterpriseItemRequestBuilder builds and executes requests for operations under \scim\v2\enterprises\{enterprise}

func NewV2EnterprisesWithEnterpriseItemRequestBuilder 

func NewV2EnterprisesWithEnterpriseItemRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *V2EnterprisesWithEnterpriseItemRequestBuilder

NewV2EnterprisesWithEnterpriseItemRequestBuilder instantiates a new V2EnterprisesWithEnterpriseItemRequestBuilder and sets the default values.

func NewV2EnterprisesWithEnterpriseItemRequestBuilderInternal 

func NewV2EnterprisesWithEnterpriseItemRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *V2EnterprisesWithEnterpriseItemRequestBuilder

NewV2EnterprisesWithEnterpriseItemRequestBuilderInternal instantiates a new V2EnterprisesWithEnterpriseItemRequestBuilder and sets the default values.

func (*V2EnterprisesWithEnterpriseItemRequestBuilder) Groups 

func (m *V2EnterprisesWithEnterpriseItemRequestBuilder) Groups() *V2EnterprisesItemGroupsRequestBuilder

Groups the Groups property returns a *V2EnterprisesItemGroupsRequestBuilder when successful

func (*V2EnterprisesWithEnterpriseItemRequestBuilder) Users 

func (m *V2EnterprisesWithEnterpriseItemRequestBuilder) Users() *V2EnterprisesItemUsersRequestBuilder

Users the Users property returns a *V2EnterprisesItemUsersRequestBuilder when successful

type V2RequestBuilder 

type V2RequestBuilder struct {
	i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}

V2RequestBuilder builds and executes requests for operations under \scim\v2

func NewV2RequestBuilder 

func NewV2RequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *V2RequestBuilder

NewV2RequestBuilder instantiates a new V2RequestBuilder and sets the default values.

func NewV2RequestBuilderInternal 

func NewV2RequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *V2RequestBuilder

NewV2RequestBuilderInternal instantiates a new V2RequestBuilder and sets the default values.

func (*V2RequestBuilder) Enterprises 

func (m *V2RequestBuilder) Enterprises() *V2EnterprisesRequestBuilder

Enterprises the enterprises property returns a *V2EnterprisesRequestBuilder when successful

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.