\RoleMembershipsAPI

All URIs are relative to http://localhost

Method	HTTP request	Description
GetRoleMembershipsApplicationOrOrganization	Get /api/v2/roleMemberships/{ownerType}/{internalOwnerId}
GetRoleMembershipsGlobalOrRepositoryContainer	Get /api/v2/roleMemberships/{ownerType}
GrantRoleMembershipApplicationOrOrganization	Put /api/v2/roleMemberships/{ownerType}/{internalOwnerId}/role/{roleId}/{memberType}/{memberName}
GrantRoleMembershipGlobalOrRepositoryContainer	Put /api/v2/roleMemberships/{ownerType}/role/{roleId}/{memberType}/{memberName}
RevokeRoleMembershipApplicationOrOrganization	Delete /api/v2/roleMemberships/{ownerType}/{internalOwnerId}/role/{roleId}/{memberType}/{memberName}
RevokeRoleMembershipGlobalOrRepositoryContainer	Delete /api/v2/roleMemberships/{ownerType}/role/{roleId}/{memberType}/{memberName}

GetRoleMembershipsApplicationOrOrganization

ApiRoleMemberMappingListDTO GetRoleMembershipsApplicationOrOrganization(ctx, ownerType, internalOwnerId).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	sonatypeiq "github.com/sonatype-nexus-community/nexus-iq-api-client-go"
)

func main() {
	ownerType := "ownerType_example" // string | Enter the ownerType for which you want to retrieve users and their role Ids.
	internalOwnerId := "internalOwnerId_example" // string | Enter the corresponding id for the ownerType specified above.

	configuration := sonatypeiq.NewConfiguration()
	apiClient := sonatypeiq.NewAPIClient(configuration)
	resp, r, err := apiClient.RoleMembershipsAPI.GetRoleMembershipsApplicationOrOrganization(context.Background(), ownerType, internalOwnerId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RoleMembershipsAPI.GetRoleMembershipsApplicationOrOrganization``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetRoleMembershipsApplicationOrOrganization`: ApiRoleMemberMappingListDTO
	fmt.Fprintf(os.Stdout, "Response from `RoleMembershipsAPI.GetRoleMembershipsApplicationOrOrganization`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ownerType	string	Enter the ownerType for which you want to retrieve users and their role Ids.
internalOwnerId	string	Enter the corresponding id for the ownerType specified above.

Other Parameters

Other parameters are passed through a pointer to a apiGetRoleMembershipsApplicationOrOrganizationRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ApiRoleMemberMappingListDTO

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRoleMembershipsGlobalOrRepositoryContainer

ApiRoleMemberMappingListDTO GetRoleMembershipsGlobalOrRepositoryContainer(ctx, ownerType).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	sonatypeiq "github.com/sonatype-nexus-community/nexus-iq-api-client-go"
)

func main() {
	ownerType := "ownerType_example" // string | Enter the value for ownerType. Using `global` will return the users and groups who have been assigned the administrator role.

	configuration := sonatypeiq.NewConfiguration()
	apiClient := sonatypeiq.NewAPIClient(configuration)
	resp, r, err := apiClient.RoleMembershipsAPI.GetRoleMembershipsGlobalOrRepositoryContainer(context.Background(), ownerType).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RoleMembershipsAPI.GetRoleMembershipsGlobalOrRepositoryContainer``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetRoleMembershipsGlobalOrRepositoryContainer`: ApiRoleMemberMappingListDTO
	fmt.Fprintf(os.Stdout, "Response from `RoleMembershipsAPI.GetRoleMembershipsGlobalOrRepositoryContainer`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ownerType	string	Enter the value for ownerType. Using `global` will return the users and groups who have been assigned the administrator role.

Other Parameters

Other parameters are passed through a pointer to a apiGetRoleMembershipsGlobalOrRepositoryContainerRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ApiRoleMemberMappingListDTO

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GrantRoleMembershipApplicationOrOrganization

GrantRoleMembershipApplicationOrOrganization(ctx, ownerType, internalOwnerId, roleId, memberType, memberName).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	sonatypeiq "github.com/sonatype-nexus-community/nexus-iq-api-client-go"
)

func main() {
	ownerType := "ownerType_example" // string | Enter the value for the ownerType for which you want to grant the role.
	internalOwnerId := "internalOwnerId_example" // string | Enter the value for the internalId associated with the ownerType specified above.
	roleId := "roleId_example" // string | Enter the roleId for the role to be granted.  Use the Roles REST API for roleIds and descriptions.
	memberType := "memberType_example" // string | Enter the value for memberType, to specify a user or a user group.
	memberName := "memberName_example" // string | Enter the value for memberName. This can be a username or group name depending upon the value of memberType above.

	configuration := sonatypeiq.NewConfiguration()
	apiClient := sonatypeiq.NewAPIClient(configuration)
	r, err := apiClient.RoleMembershipsAPI.GrantRoleMembershipApplicationOrOrganization(context.Background(), ownerType, internalOwnerId, roleId, memberType, memberName).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RoleMembershipsAPI.GrantRoleMembershipApplicationOrOrganization``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ownerType	string	Enter the value for the ownerType for which you want to grant the role.
internalOwnerId	string	Enter the value for the internalId associated with the ownerType specified above.
roleId	string	Enter the roleId for the role to be granted. Use the Roles REST API for roleIds and descriptions.
memberType	string	Enter the value for memberType, to specify a user or a user group.
memberName	string	Enter the value for memberName. This can be a username or group name depending upon the value of memberType above.

Other Parameters

Other parameters are passed through a pointer to a apiGrantRoleMembershipApplicationOrOrganizationRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GrantRoleMembershipGlobalOrRepositoryContainer

GrantRoleMembershipGlobalOrRepositoryContainer(ctx, ownerType, roleId, memberType, memberName).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	sonatypeiq "github.com/sonatype-nexus-community/nexus-iq-api-client-go"
)

func main() {
	ownerType := "ownerType_example" // string | Enter the value for the ownerType for which you want to grant the role.
	roleId := "roleId_example" // string | Enter the roleId for the role to be granted.  Use the Roles REST API for roleIds and descriptions.
	memberType := "memberType_example" // string | Enter the value for memberType, to specify a user or a user group.
	memberName := "memberName_example" // string | Enter the value for memberName. This can be a username or group name depending upon the value of memberType above.

	configuration := sonatypeiq.NewConfiguration()
	apiClient := sonatypeiq.NewAPIClient(configuration)
	r, err := apiClient.RoleMembershipsAPI.GrantRoleMembershipGlobalOrRepositoryContainer(context.Background(), ownerType, roleId, memberType, memberName).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RoleMembershipsAPI.GrantRoleMembershipGlobalOrRepositoryContainer``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ownerType	string	Enter the value for the ownerType for which you want to grant the role.
roleId	string	Enter the roleId for the role to be granted. Use the Roles REST API for roleIds and descriptions.
memberType	string	Enter the value for memberType, to specify a user or a user group.
memberName	string	Enter the value for memberName. This can be a username or group name depending upon the value of memberType above.

Other Parameters

Other parameters are passed through a pointer to a apiGrantRoleMembershipGlobalOrRepositoryContainerRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RevokeRoleMembershipApplicationOrOrganization

RevokeRoleMembershipApplicationOrOrganization(ctx, ownerType, internalOwnerId, roleId, memberType, memberName).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	sonatypeiq "github.com/sonatype-nexus-community/nexus-iq-api-client-go"
)

func main() {
	ownerType := "ownerType_example" // string | Enter the value for the ownerType for which you want to revoke the role. Using `global` will revoke the administrator role.
	internalOwnerId := "internalOwnerId_example" // string | Enter the internalId associated with the ownerType specified above.
	roleId := "roleId_example" // string | Enter the roleId for the role to be revoked.
	memberType := "memberType_example" // string | Enter the value for memberType, to specify a user or a user group.
	memberName := "memberName_example" // string | Enter the value for memberName. This can be a username or group name depending upon the value of memberType above.

	configuration := sonatypeiq.NewConfiguration()
	apiClient := sonatypeiq.NewAPIClient(configuration)
	r, err := apiClient.RoleMembershipsAPI.RevokeRoleMembershipApplicationOrOrganization(context.Background(), ownerType, internalOwnerId, roleId, memberType, memberName).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RoleMembershipsAPI.RevokeRoleMembershipApplicationOrOrganization``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ownerType	string	Enter the value for the ownerType for which you want to revoke the role. Using `global` will revoke the administrator role.
internalOwnerId	string	Enter the internalId associated with the ownerType specified above.
roleId	string	Enter the roleId for the role to be revoked.
memberType	string	Enter the value for memberType, to specify a user or a user group.
memberName	string	Enter the value for memberName. This can be a username or group name depending upon the value of memberType above.

Other Parameters

Other parameters are passed through a pointer to a apiRevokeRoleMembershipApplicationOrOrganizationRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RevokeRoleMembershipGlobalOrRepositoryContainer

RevokeRoleMembershipGlobalOrRepositoryContainer(ctx, ownerType, roleId, memberType, memberName).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	sonatypeiq "github.com/sonatype-nexus-community/nexus-iq-api-client-go"
)

func main() {
	ownerType := "ownerType_example" // string | Enter the value for ownerType. Using `global` will revoke the administrator role.
	roleId := "roleId_example" // string | Enter the roleId for the role to be revoked.
	memberType := "memberType_example" // string | Enter the value for memberType, to specify a user or a user group.
	memberName := "memberName_example" // string | Enter the value for memberName. This can be a username or group name depending upon the value of memberType above.

	configuration := sonatypeiq.NewConfiguration()
	apiClient := sonatypeiq.NewAPIClient(configuration)
	r, err := apiClient.RoleMembershipsAPI.RevokeRoleMembershipGlobalOrRepositoryContainer(context.Background(), ownerType, roleId, memberType, memberName).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RoleMembershipsAPI.RevokeRoleMembershipGlobalOrRepositoryContainer``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ownerType	string	Enter the value for ownerType. Using `global` will revoke the administrator role.
roleId	string	Enter the roleId for the role to be revoked.
memberType	string	Enter the value for memberType, to specify a user or a user group.
memberName	string	Enter the value for memberName. This can be a username or group name depending upon the value of memberType above.

Other Parameters

Other parameters are passed through a pointer to a apiRevokeRoleMembershipGlobalOrRepositoryContainerRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

RoleMembershipsAPI.md

Latest commit

History

RoleMembershipsAPI.md

File metadata and controls

\RoleMembershipsAPI

GetRoleMembershipsApplicationOrOrganization

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetRoleMembershipsGlobalOrRepositoryContainer

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GrantRoleMembershipApplicationOrOrganization

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GrantRoleMembershipGlobalOrRepositoryContainer

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

RevokeRoleMembershipApplicationOrOrganization

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

RevokeRoleMembershipGlobalOrRepositoryContainer

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers