ex_heroku_client v0.3.0 Heroku.OrganizationMember

Summary

Functions

Calls PUT /organizations/#{organization_identity}/members

Calls DELETE /organizations/#{organization_identity}/members/#{organization_member_identity}

Calls GET /organizations/#{organization_identity}/members

Calls GET /organizations/#{organization_identity}/members/#{organization_member_identity}/apps

Functions

create(organization_identity, params)

Calls PUT /organizations/#{organization_identity}/members

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "email": {
      "description": "email address of the organization member",
      "example": "someone@example.org",
      "readOnly": true,
      "type": [
        "string"
      ]
    },
    "federated": {
      "description": "whether the user is federated and belongs to an Identity Provider",
      "example": false,
      "readOnly": true,
      "type": [
        "boolean"
      ]
    },
    "role": {
      "description": "role in the organization",
      "enum": [
        "admin",
        "collaborator",
        "member",
        "owner",
        null
      ],
      "example": "admin",
      "readOnly": true,
      "type": [
        "null",
        "string"
      ]
    }
  },
  "required": [
    "email",
    "role"
  ],
  "type": [
    "object"
  ]
}
destroy(organization_identity, organization_member_identity)

Calls DELETE /organizations/#{organization_identity}/members/#{organization_member_identity}

list_members_of_the_organization(organization_identity)

Calls GET /organizations/#{organization_identity}/members

list_the_apps_of_a_member(organization_identity, organization_member_identity)

Calls GET /organizations/#{organization_identity}/members/#{organization_member_identity}/apps