Aura.Orgs (Aura v0.9.3)

View Source

Service module for interacting with Hex Organizations

๐Ÿ“– Resources

Summary

Functions

Adds a user to an org with a given role

Grabs an organization, given an org_name

Grabs an org member, given their org_name and username

Grabs a list of members to an organization, given an org_name

Lists all the organizations the requester can see

Streams audit logs, scoped to an organization

Functions

add_org_member(org_name, username, role, opts \\ [])

Adds a user to an org with a given role

๐Ÿท๏ธ Params

โคต๏ธ Returns

โœ… On Success

  {:ok, %HexOrgMember{...}}

โŒ On Failure

  {:error, (some error)}

๐Ÿ‘ฉโ€๐Ÿ’ป API Details

MethodPathControllerAction
POST/orgs/:org_name/membersOrganizationUserController:create

change_member_role(org_name, username, new_role, opts \\ [])

Changes a user's role to new_role

๐Ÿท๏ธ Params

โคต๏ธ Returns

โœ… On Success

  {:ok, %HexOrgMember{...}}

โŒ On Failure

  {:error, (some error)}

๐Ÿ‘ฉโ€๐Ÿ’ป API Details

MethodPathControllerAction
POST/orgs/:org_name/members/:usernameOrganizationUserController:update

get_org(org_name, opts \\ [])

Grabs an organization, given an org_name

๐Ÿท๏ธ Params

โคต๏ธ Returns

โœ… On Success

  {:ok, %HexOrg{...}}

โŒ On Failure

  {:error, (some error)}

๐Ÿ‘ฉโ€๐Ÿ’ป API Details

MethodPathControllerAction
GET/orgs/:org_nameOrganizationController:show

get_org_member(org_name, username, opts \\ [])

Grabs an org member, given their org_name and username

๐Ÿท๏ธ Params

โคต๏ธ Returns

โœ… On Success

  {:ok, %HexOrgMember{...}}

โŒ On Failure

  {:error, (some error)}

๐Ÿ‘ฉโ€๐Ÿ’ป API Details

MethodPathControllerAction
GET/orgs/:org_name/members/:usernameOrganizationUserController:show

get_org_members(org_name, opts \\ [])

Grabs a list of members to an organization, given an org_name

๐Ÿท๏ธ Params

โคต๏ธ Returns

โœ… On Success

  {:ok, [%HexOrgMember{...}]}

โŒ On Failure

  {:error, (some error)}

๐Ÿ‘ฉโ€๐Ÿ’ป API Details

MethodPathControllerAction
GET/orgs/:org_name/membersOrganizationUserController:index

list_orgs(opts \\ [])

Lists all the organizations the requester can see

๐Ÿท๏ธ Params

  • opts :: option parameters used to modify requests

โคต๏ธ Returns

โœ… On Success

  {:ok, [%HexOrg{...}]}

โŒ On Failure

  {:error, (some error)}

๐Ÿ‘ฉโ€๐Ÿ’ป API Details

MethodPathControllerAction
GET/orgsOrganizationController:index

remove_org_member(org_name, username, opts \\ [])

Removes a user to an org

๐Ÿท๏ธ Params

โคต๏ธ Returns

โœ… On Success

  :ok

โŒ On Failure

  {:error, (some error)}

๐Ÿ‘ฉโ€๐Ÿ’ป API Details

MethodPathControllerAction
DELETE/orgs/:org_name/members/:usernameOrganizationUserController:delete

stream_audit_logs(org_name, opts \\ [])

Streams audit logs, scoped to an organization

๐Ÿท๏ธ Params

  • opts.page :: start from this page number

โคต๏ธ Returns

โœ… On Success

  Stream.resource/3

๐Ÿ‘ฉโ€๐Ÿ’ป API Details

MethodPathControllerAction
GET/orgs/:org_name/audit-logsOrganizationController:audit_logs