Skip to content

Latest commit

 

History

History
188 lines (133 loc) · 6.51 KB

AuthGroupsApi.md

File metadata and controls

188 lines (133 loc) · 6.51 KB

isi_sdk_8_0.AuthGroupsApi

All URIs are relative to https://YOUR_CLUSTER_HOSTNAME_OR_NODE_IP:8080

Method HTTP request Description
create_group_member POST /platform/1/auth/groups/{Group}/members
delete_group_member DELETE /platform/1/auth/groups/{Group}/members/{GroupMemberId}
list_group_members GET /platform/1/auth/groups/{Group}/members

create_group_member

CreateResponse create_group_member(group_member, group, zone=zone, provider=provider)

Add a member to the group.

Example

from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = isi_sdk_8_0.AuthGroupsApi(isi_sdk_8_0.ApiClient(configuration))
group_member = isi_sdk_8_0.GroupMember() # GroupMember | 
group = 'group_example' # str | 
zone = 'zone_example' # str | Filter group members by zone. (optional)
provider = 'provider_example' # str | Filter group members by provider. (optional)

try:
    api_response = api_instance.create_group_member(group_member, group, zone=zone, provider=provider)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthGroupsApi->create_group_member: %s\n" % e)

Parameters

Name Type Description Notes
group_member GroupMember
group str
zone str Filter group members by zone. [optional]
provider str Filter group members by provider. [optional]

Return type

CreateResponse

Authorization

basicAuth

HTTP request headers

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

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

delete_group_member

delete_group_member(group_member_id, group, zone=zone, provider=provider)

Remove the member from the group.

Example

from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = isi_sdk_8_0.AuthGroupsApi(isi_sdk_8_0.ApiClient(configuration))
group_member_id = 'group_member_id_example' # str | Remove the member from the group.
group = 'group_example' # str | 
zone = 'zone_example' # str | Filter group members by zone. (optional)
provider = 'provider_example' # str | Filter group members by provider. (optional)

try:
    api_instance.delete_group_member(group_member_id, group, zone=zone, provider=provider)
except ApiException as e:
    print("Exception when calling AuthGroupsApi->delete_group_member: %s\n" % e)

Parameters

Name Type Description Notes
group_member_id str Remove the member from the group.
group str
zone str Filter group members by zone. [optional]
provider str Filter group members by provider. [optional]

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

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

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

list_group_members

GroupMembers list_group_members(group, resolve_names=resolve_names, resume=resume, limit=limit, zone=zone, provider=provider)

List all the members of the group.

Example

from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = isi_sdk_8_0.AuthGroupsApi(isi_sdk_8_0.ApiClient(configuration))
group = 'group_example' # str | 
resolve_names = true # bool | Resolve names of personas. (optional)
resume = 'resume_example' # str | Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options). (optional)
limit = 56 # int | Return no more than this many results at once (see resume). (optional)
zone = 'zone_example' # str | Filter group members by zone. (optional)
provider = 'provider_example' # str | Filter group members by provider. (optional)

try:
    api_response = api_instance.list_group_members(group, resolve_names=resolve_names, resume=resume, limit=limit, zone=zone, provider=provider)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthGroupsApi->list_group_members: %s\n" % e)

Parameters

Name Type Description Notes
group str
resolve_names bool Resolve names of personas. [optional]
resume str Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options). [optional]
limit int Return no more than this many results at once (see resume). [optional]
zone str Filter group members by zone. [optional]
provider str Filter group members by provider. [optional]

Return type

GroupMembers

Authorization

basicAuth

HTTP request headers

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

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