Merge branch 'master' into feat/doc-links

Author: mat-lord

examples/groups/create_group.py

@@ -0,0 +1,17 @@
+import os
+
+from staxapp.config import Config
+from staxapp.openapi import StaxClient
+
+Config.access_key = os.getenv("STAX_ACCESS_KEY")
+Config.secret_key = os.getenv("STAX_SECRET_KEY")
+
+# The name of the group you're creating
+group_name = <Group Name>
+
+# Create a Stax groups
+teams = StaxClient("teams")
+response = teams.CreateGroup(
+	Name=group_name
+)
+print(response)

examples/groups/delete_group.py

@@ -0,0 +1,17 @@
+import os
+
+from staxapp.config import Config
+from staxapp.openapi import StaxClient
+
+Config.access_key = os.getenv("STAX_ACCESS_KEY")
+Config.secret_key = os.getenv("STAX_SECRET_KEY")
+
+# Id of the group to delete
+group_id = <Group Id>
+
+# Create a Stax groups
+teams = StaxClient("teams")
+response = teams.DeleteGroup(
+	group_id=group_id
+)
+print(response)

examples/groups/update_group.py

@@ -0,0 +1,21 @@
+import os
+
+from staxapp.config import Config
+from staxapp.openapi import StaxClient
+
+Config.access_key = os.getenv("STAX_ACCESS_KEY")
+Config.secret_key = os.getenv("STAX_SECRET_KEY")
+
+# Id of the group to update
+group_id = <Group Id>
+
+# Name to rename the group
+group_name = <Group Name>
+
+# Create a Stax groups
+teams = StaxClient("teams")
+response = teams.UpdateGroup(
+	group_id=group_id,
+	Name=group_name
+)
+print(response)

examples/groups/update_group_members.py

@@ -0,0 +1,22 @@
+import os
+
+from staxapp.config import Config
+from staxapp.openapi import StaxClient
+
+Config.access_key = os.getenv("STAX_ACCESS_KEY")
+Config.secret_key = os.getenv("STAX_SECRET_KEY")
+
+# An array of user memberships dicts to enableor an empty array
+# 	Properties: GroupId(string), UserId(string)
+user_membership_to_add = <An array of User Membership?>
+
+# An array of user memberships dicts to disable or an empty arry
+user_membership_to_remove = <An array of User Membership?>
+
+# Create a Stax groups
+teams = StaxClient("teams")
+response = teams.UpdateGroupMembers(
+	AddMembers = user_membership_to_add,
+	RemoveMembers = user_membership_to_remove
+)
+print(response)

examples/policy/create_policy.py

@@ -0,0 +1,22 @@
+import os
+
+from staxapp.config import Config
+from staxapp.openapi import StaxClient
+
+Config.access_key = os.getenv("STAX_ACCESS_KEY")
+Config.secret_key = os.getenv("STAX_SECRET_KEY")
+
+policy_name = <Policy Name>
+
+policy_description = <Policy Description>
+
+policy = <Policy Json>
+
+# Create a policy
+organisations = StaxClient("organisations")
+response = organisations.CreatePolicy(
+		Name=policy_name,
+		Description=policy_description,
+		Policy=policy
+)
+print(response)

examples/policy/delete_policy.py

@@ -0,0 +1,16 @@
+import os
+
+from staxapp.config import Config
+from staxapp.openapi import StaxClient
+
+Config.access_key = os.getenv("STAX_ACCESS_KEY")
+Config.secret_key = os.getenv("STAX_SECRET_KEY")
+
+policy_id = <Policy Id>
+
+# Delete a policy
+organisations = StaxClient("organisations")
+response = organisations.DeletePolicy(
+	policy_id = policy_id,
+)
+print(response)

examples/policy/update_policy.py

@@ -0,0 +1,23 @@
+import os
+
+from staxapp.config import Config
+from staxapp.openapi import StaxClient
+
+Config.access_key = os.getenv("STAX_ACCESS_KEY")
+Config.secret_key = os.getenv("STAX_SECRET_KEY")
+
+# The policy to be updated
+policy_id = <Policy Id>
+
+policy_description = <Policy Description>
+
+policy = <Policy Json>
+
+# Update a policy
+organisations = StaxClient("organisations")
+response = organisations.UpdatePolicy(
+	policy_id = policy_id,
+	Description=policy_description,
+	Policy=policy,
+)
+print(response)

examples/users/create_user.py

@@ -0,0 +1,25 @@
+import os
+
+from staxapp.config import Config
+from staxapp.openapi import StaxClient
+
+Config.access_key = os.getenv("STAX_ACCESS_KEY")
+Config.secret_key = os.getenv("STAX_SECRET_KEY")
+
+# The user's first name
+first_name = <User's first Name>
+
+# The user's second name
+last_name = <User's last Name>
+
+# The email for the user
+user_email = <User's Email>
+
+# Create a Stax User
+teams = StaxClient("teams")
+response = teams.CreateUser(
+	FirstName = first_name,
+	LastName = last_name,
+	Email = user_email
+)
+print(response)

examples/users/reset_password.py

@@ -0,0 +1,16 @@
+import os
+
+from staxapp.config import Config
+from staxapp.openapi import StaxClient
+
+Config.access_key = os.getenv("STAX_ACCESS_KEY")
+Config.secret_key = os.getenv("STAX_SECRET_KEY")
+
+# The user id that needs a reset
+user_id = <User Id>
+
+teams = StaxClient("teams")
+response = teams.UpdateUserPassword(
+	user_id=user_id
+)
+print(response)

examples/users/update_user.py

@@ -0,0 +1,24 @@
+import os
+
+from staxapp.config import Config
+from staxapp.openapi import StaxClient
+
+Config.access_key = os.getenv("STAX_ACCESS_KEY")
+Config.secret_key = os.getenv("STAX_SECRET_KEY")
+
+# The user id to resend invite
+user_id = <User Id>
+
+# Not required just show how properties are changed
+user_role = <New Role>
+user_status = <New Status>
+
+
+# Update a Stax User
+teams = StaxClient("teams")
+response = teams.UpdateUser(
+	user_id = user_id,
+	Role = user_role,
+	Status = user_status
+)
+print(response)