Skip to content

Latest commit

 

History

History
125 lines (89 loc) · 4.96 KB

AdminsApi.md

File metadata and controls

125 lines (89 loc) · 4.96 KB
Raw

purity_fb_1dot12.AdminsApi

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

Method HTTP request Description
list_admins GET /1.12/admins
update_admins PATCH /1.12/admins

list_admins

AdminResponse list_admins(filter=filter, ids=ids, limit=limit, names=names, sort=sort, start=start, token=token, expose=expose)

List all administrative accounts.

Example

from purity_fb import PurityFb, Admin, rest

fb = PurityFb('10.255.8.20') # assume the array IP is 10.255.8.20
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 admin accounts (given sufficient permissions)
        res = fb.admins.list_admins()
        # list a subset of admin accounts by name
        res = fb.admins.list_admins(names=['pureuser'])
        # list a subset of admin accounts by id
        res = fb.admins.list_admins(ids=['100abf42-0000-4000-8023-000det400090'])
    except rest.ApiException as e:
        print("Exception when listing admins: %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]
expose bool Display the unmasked API token. This is only valid when listing your own token. [optional] [default to false]

Return type

AdminResponse

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]

update_admins

AdminResponse update_admins(admin, ids=ids, names=names)

Update administrative account attributes.

Example

from purity_fb import PurityFb, Admin, rest

fb = PurityFb('10.255.8.20') # assume the array IP is 10.255.8.20
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:
        # change password
        myAdmin = Admin(old_password='thisWASanOLDpasSwOrD', password='FAKEnewpaSsword')
        res = fb.admins.update_admins(names=['pureuser'], admin=myAdmin)

        # Set a public key for login via SSH
        myAdmin = Admin(public_key='ssh-rsa EXAMPLEzaC1yc2EAAAADAQABAAABAQDN1fshdvABLD/f2mkAUqkcUMKPsS+Os3omYFwe3G2Adxc'
                                   'enBY+kLmbPXjiC9t4UDob3RiYu6HkDC2xvu8yLhlQTtsjCac2BkePJa/OTxttwY5G6OyYqWjmSmX9D6GZ13'
                                   'CRr/rSxjXYo/2GE/0xyv27/Z+ikxjs6rzXXOhdxJ6hY1jD1D8+fHVxhr8+n6Zbod8and0rlgmarfRoRYlLh'
                                   'GoRSCxNyOi6bG5ugrlIEXi8JZr8CpztGp/8WTa82XCSClFJPteC/5vLvwPGxwOraZ/BJngBPbmeeloN5lBl'
                                   'W0KAndRqwNZcDBt8JnGioPd0Kv+SNufwR4nHCv8NgEXAMPLE')
        res = fb.admins.update_admins(names=['pureuser'], admin=myAdmin)

    except rest.ApiException as e:
        print("Exception when changing password or public key: %s\n" % e)

Parameters

Name Type Description Notes
admin Admin
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

AdminResponse

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]