Hexoku.API.Organizations.Members

An organization member is an individual with access to an organization

Attributes

email
email address of the organization member
role
role in the organization ["admin", "member", "collaborator"]
created_at
when item was created
updated_at
when item was last modified

For more info read the Heroku API Reference

Source

Summary

grant(client, org, email, role \\ "member")

Create a new organization member, or update their role

list(client, org)

List members of the organization

remove(client, org, email)

Remove a member from the organization

Functions

grant(client, org, email, role \\ "member")

Specs:

  • grant(Hexoku.Client.t, binary, binary, binary) :: Map.t

Create a new organization member, or update their role.

Examples

client |> Hexoku.API.Organizations.Members.grant("myorg", "email@example.com", "member")
Source
list(client, org)

Specs:

  • list(Hexoku.Client.t, binary) :: [Map.t]

List members of the organization.

Examples

client |> Hexoku.API.Organizations.Members.list("myorg")
Source
remove(client, org, email)

Specs:

  • remove(Hexoku.Client.t, binary, binary) :: Map.t

Remove a member from the organization.

Examples

client |> Hexoku.API.Organizations.Members.remove("myorg", "email@example.com")
Source