ex_heroku_client v0.4.0 Heroku.OrganizationInvitation

Summary

Functions

Calls POST /organizations/invitations/#{organization_invitation_token}/accept

Calls GET /organizations/#{organization_name}/invitations

Calls GET /organizations/invitations/#{organization_invitation_token}

Calls DELETE /organizations/#{organization_identity}/invitations/#{organization_invitation_identity}

Calls PUT /organizations/#{organization_identity}/invitations

Functions

accept_organization_invitation(organization_invitation_token)

Calls POST /organizations/invitations/#{organization_invitation_token}/accept

get_a_list_of_an_organizations_identity_providers(organization_name)

Calls GET /organizations/#{organization_name}/invitations

get_an_invitation_by_its_token(organization_invitation_token)

Calls GET /organizations/invitations/#{organization_invitation_token}

self(organization_identity, organization_invitation_identity)

Calls DELETE /organizations/#{organization_identity}/invitations/#{organization_invitation_identity}

update(organization_identity, params)

Calls PUT /organizations/#{organization_identity}/invitations

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "email": {
      "description": "unique email address of account",
      "example": "username@example.com",
      "format": "email",
      "readOnly": false,
      "type": [
        "string"
      ]
    },
    "role": {
      "description": "role in the organization",
      "enum": [
        "admin",
        "collaborator",
        "member",
        "owner",
        null
      ],
      "example": "admin",
      "readOnly": true,
      "type": [
        "null",
        "string"
      ]
    }
  },
  "required": [
    "email",
    "role"
  ],
  "type": [
    "object"
  ]
}