purity_fb_1dot12.ObjectStoreUsersApi

All URIs are relative to https://purity_fb_server/api

Method	HTTP request	Description
add_object_store_users_object_store_access_policies	POST /1.12/object-store-users/object-store-access-policies
create_object_store_users	POST /1.12/object-store-users
delete_object_store_users	DELETE /1.12/object-store-users
list_object_store_users	GET /1.12/object-store-users
list_object_store_users_object_store_access_policies	GET /1.12/object-store-users/object-store-access-policies
remove_object_store_users_object_store_access_policies	DELETE /1.12/object-store-users/object-store-access-policies

add_object_store_users_object_store_access_policies

ObjectStoreUserObjectStoreAccessPolicyResponse add_object_store_users_object_store_access_policies(policy_ids=policy_ids, policy_names=policy_names, member_ids=member_ids, member_names=member_names)

Add a policy to an object store user.

Example

from purity_fb import PurityFb, rest

fb = PurityFb("10.255.9.28", version=__version__) # assume the array IP is 10.255.9.28
fb.disable_verify_ssl()
try:
    res = fb.login(API_TOKEN) # login to the array with your API_TOKEN
except rest.ApiException as e:
    print("Exception when logging in to the array: %s\n" % e)
if res:
    try:
        # add a policy to a user
        res = fb.object_store_users.add_object_store_users_object_store_access_policies(
            member_names=["acc1/myobjuser"], policy_names=["pure:policy/bucket-list"])
        print(res)
    except rest.ApiException as e:
        print("Exception when adding a policy to a user: %s\n" % e)

Parameters

Name	Type	Description	Notes
policy_ids	list[str]	A comma-separated list of policy IDs. This cannot be provided together with the policy names query parameters.	[optional]
policy_names	list[str]	A comma-separated list of policy names. This cannot be provided together with the policy ids query parameters.	[optional]
member_ids	list[str]	A comma-separated list of member ids. This cannot be provided together with the member names query parameters.	[optional]
member_names	list[str]	A comma-separated list of member names. This cannot be provided together with the member ids query parameters.	[optional]

Return type

ObjectStoreUserObjectStoreAccessPolicyResponse

Authorization

AuthTokenHeader

HTTP request headers

Content-Type: application/json
Accept: application/json

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

create_object_store_users

ObjectStoreUserResponse create_object_store_users(names, full_access=full_access)

Create a new object store user.

Example

from purity_fb import PurityFb, rest

fb = PurityFb("10.255.9.28", version=__version__) # assume the array IP is 10.255.9.28
fb.disable_verify_ssl()
try:
    res = fb.login(API_TOKEN) # login to the array with your API_TOKEN
except rest.ApiException as e:
    print("Exception when logging in to the array: %s\n" % e)
if res:
    try:
        # post the object store user object myobjuser on the array without full access
        res = fb.object_store_users.create_object_store_users(
            names=["acc1/myobjuser"], full_access=False)
        print(res)
    except rest.ApiException as e:
        print("Exception when creating object store user: %s\n" % e)

Parameters

Name	Type	Description	Notes
names	list[str]	A comma-separated list of resource names to import. To create a user, the user must be specified in the format <account-name>/<user-name>.
full_access	bool	specifies whether object store user will be created with full permissions	[optional]

Return type

ObjectStoreUserResponse

Authorization

AuthTokenHeader

HTTP request headers

Content-Type: application/json
Accept: application/json

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

delete_object_store_users

delete_object_store_users(ids=ids, names=names)

Delete an object store user.

Example

from purity_fb import PurityFb, rest

fb = PurityFb("10.255.9.28", version=__version__) # assume the array IP is 10.255.9.28
fb.disable_verify_ssl()
try:
    res = fb.login(API_TOKEN) # login to the array with your API_TOKEN
except rest.ApiException as e:
    print("Exception when logging in to the array: %s\n" % e)
if res:
    try:
        # delete a object store user with name myobjuser
        fb.object_store_users.delete_object_store_users(names=["acc1/myobjuser"])
    except rest.ApiException as e:
        print("Exception when deleting object store user: %s\n" % e)

Parameters

Name	Type	Description	Notes
ids	list[str]	A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters.	[optional]
names	list[str]	A comma-separated list of resource names. This cannot be provided together with the ids query parameters.	[optional]

Return type

void (empty response body)

Authorization

AuthTokenHeader

HTTP request headers

Content-Type: application/json
Accept: application/json

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

list_object_store_users

ObjectStoreUserResponse list_object_store_users(filter=filter, ids=ids, limit=limit, names=names, sort=sort, start=start, token=token)

List object store users.

Example

from purity_fb import PurityFb, rest

fb = PurityFb("10.255.9.28") # assume the array IP is 10.255.9.28
fb.disable_verify_ssl()
try:
    res = fb.login(API_TOKEN) # login to the array with your API_TOKEN
except rest.ApiException as e:
    print("Exception when logging in to the array: %s\n" % e)
if res:
    try:
        # list all object store users
        res = fb.object_store_users.list_object_store_users()
        # list and sort by created in descendant order
        res = fb.object_store_users.list_object_store_users(limit=5, sort="created-")
        # list with page size 5
        res = fb.object_store_users.list_object_store_users(limit=5)
        # list all remaining object store users
        res = fb.object_store_users.list_object_store_users(token=res.pagination_info.continuation_token)
        # list with filter
        res = fb.object_store_users.list_object_store_users(filter='name=\'acc1/myobjuser*\'')
    except rest.ApiException as e:
        print("Exception when listing object store users: %s\n" % e)

Parameters

Name	Type	Description	Notes
filter	str	The filter to be used for query.	[optional]
ids	list[str]	A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters.	[optional]
limit	int	limit, should be >= 0	[optional]
names	list[str]	A comma-separated list of resource names. This cannot be provided together with the ids query parameters.	[optional]
sort	str	Sort the response by the specified fields (in descending order if '-' is appended to the field name).	[optional]
start	int	The offset of the first resource to return from a collection.	[optional]
token	str	An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result.	[optional]

Return type

ObjectStoreUserResponse

Authorization

AuthTokenHeader

HTTP request headers

Content-Type: application/json
Accept: application/json

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

list_object_store_users_object_store_access_policies

ObjectStoreUserObjectStoreAccessPolicyResponse list_object_store_users_object_store_access_policies(filter=filter, limit=limit, policy_ids=policy_ids, policy_names=policy_names, member_ids=member_ids, member_names=member_names, sort=sort, start=start, token=token)

List object store access policies for object store users.

Example

from purity_fb import PurityFb, rest

fb = PurityFb("10.255.9.28", version=__version__) # assume the array IP is 10.255.9.28
fb.disable_verify_ssl()
try:
    res = fb.login(API_TOKEN) # login to the array with your API_TOKEN
except rest.ApiException as e:
    print("Exception when logging in to the array: %s\n" % e)
if res:
    try:
        # list access policies for object store users
        res = fb.object_store_users.list_object_store_users_object_store_access_policies()
        print(res)

        # list access policies for specific user
        res = fb.object_store_users.list_object_store_users_object_store_access_policies(
            member_names=["acc1/myobjuser"])
        print(res)
    except rest.ApiException as e:
        print("Exception when listing policies for object store users: %s\n" % e)

Parameters

Name	Type	Description	Notes
filter	str	The filter to be used for query.	[optional]
limit	int	limit, should be >= 0	[optional]
policy_ids	list[str]	A comma-separated list of policy IDs. This cannot be provided together with the policy names query parameters.	[optional]
policy_names	list[str]	A comma-separated list of policy names. This cannot be provided together with the policy ids query parameters.	[optional]
member_ids	list[str]	A comma-separated list of member ids. This cannot be provided together with the member names query parameters.	[optional]
member_names	list[str]	A comma-separated list of member names. This cannot be provided together with the member ids query parameters.	[optional]
sort	str	Sort the response by the specified fields (in descending order if '-' is appended to the field name).	[optional]
start	int	The offset of the first resource to return from a collection.	[optional]
token	str	An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result.	[optional]

Return type

ObjectStoreUserObjectStoreAccessPolicyResponse

Authorization

AuthTokenHeader

HTTP request headers

Content-Type: application/json
Accept: application/json

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

remove_object_store_users_object_store_access_policies

remove_object_store_users_object_store_access_policies(policy_ids=policy_ids, policy_names=policy_names, member_ids=member_ids, member_names=member_names)

Remove a policy from an object store user.

Example

from purity_fb import PurityFb, rest

fb = PurityFb("10.255.9.28", version=__version__) # assume the array IP is 10.255.9.28
fb.disable_verify_ssl()
try:
    res = fb.login(API_TOKEN) # login to the array with your API_TOKEN
except rest.ApiException as e:
    print("Exception when logging in to the array: %s\n" % e)
if res:
    try:
        # remove a policy from a user
        res = fb.object_store_users.remove_object_store_users_object_store_access_policies(
            member_names=["acc1/myobjuser"], policy_names=["pure:policy/bucket-list"])
        print(res)
    except rest.ApiException as e:
        print("Exception when removing policy from user: %s\n" % e)

Parameters

Name	Type	Description	Notes
policy_ids	list[str]	A comma-separated list of policy IDs. This cannot be provided together with the policy names query parameters.	[optional]
policy_names	list[str]	A comma-separated list of policy names. This cannot be provided together with the policy ids query parameters.	[optional]
member_ids	list[str]	A comma-separated list of member ids. This cannot be provided together with the member names query parameters.	[optional]
member_names	list[str]	A comma-separated list of member names. This cannot be provided together with the member ids query parameters.	[optional]

Return type

void (empty response body)

Authorization

AuthTokenHeader

HTTP request headers

Content-Type: application/json
Accept: application/json

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

Files

ObjectStoreUsersApi.md

Latest commit

History

ObjectStoreUsersApi.md

File metadata and controls

purity_fb_1dot12.ObjectStoreUsersApi

add_object_store_users_object_store_access_policies

Example

Parameters

Return type

Authorization

HTTP request headers

create_object_store_users

Example

Parameters

Return type

Authorization

HTTP request headers

delete_object_store_users

Example

Parameters

Return type

Authorization

HTTP request headers

list_object_store_users

Example

Parameters

Return type

Authorization

HTTP request headers

list_object_store_users_object_store_access_policies

Example

Parameters

Return type

Authorization

HTTP request headers

remove_object_store_users_object_store_access_policies

Example

Parameters

Return type

Authorization

HTTP request headers