Class: PlatformAPI::OrganizationInvitation
- Inherits:
-
Object
- Object
- PlatformAPI::OrganizationInvitation
- Defined in:
- lib/platform-api/client.rb
Overview
An organization invitation represents an invite to an organization.
Instance Method Summary collapse
-
#accept(organization_invitation_token) ⇒ Object
Accept Organization Invitation.
-
#create(organization_name_or_organization_id, body = {}) ⇒ Object
Create Organization Invitation.
-
#get(organization_invitation_token) ⇒ Object
Get an invitation by its token.
-
#initialize(client) ⇒ OrganizationInvitation
constructor
A new instance of OrganizationInvitation.
-
#list(organization_name) ⇒ Object
Get a list of an organization's Identity Providers.
-
#revoke(organization_name_or_organization_id, organization_invitation_id) ⇒ Object
Revoke an organization invitation.
Constructor Details
#initialize(client) ⇒ OrganizationInvitation
Returns a new instance of OrganizationInvitation.
1819 1820 1821 |
# File 'lib/platform-api/client.rb', line 1819 def initialize(client) @client = client end |
Instance Method Details
#accept(organization_invitation_token) ⇒ Object
Accept Organization Invitation
1856 1857 1858 |
# File 'lib/platform-api/client.rb', line 1856 def accept(organization_invitation_token) @client.organization_invitation.accept(organization_invitation_token) end |
#create(organization_name_or_organization_id, body = {}) ⇒ Object
Create Organization Invitation
1834 1835 1836 |
# File 'lib/platform-api/client.rb', line 1834 def create(organization_name_or_organization_id, body = {}) @client.organization_invitation.create(organization_name_or_organization_id, body) end |
#get(organization_invitation_token) ⇒ Object
Get an invitation by its token
1849 1850 1851 |
# File 'lib/platform-api/client.rb', line 1849 def get(organization_invitation_token) @client.organization_invitation.get(organization_invitation_token) end |
#list(organization_name) ⇒ Object
Get a list of an organization's Identity Providers
1826 1827 1828 |
# File 'lib/platform-api/client.rb', line 1826 def list(organization_name) @client.organization_invitation.list(organization_name) end |
#revoke(organization_name_or_organization_id, organization_invitation_id) ⇒ Object
Revoke an organization invitation.
1842 1843 1844 |
# File 'lib/platform-api/client.rb', line 1842 def revoke(organization_name_or_organization_id, organization_invitation_id) @client.organization_invitation.revoke(organization_name_or_organization_id, organization_invitation_id) end |