Organizations
extends CloudApiBase
in
implements
CloudApiInterface
Class Organizations
Table of Contents
| $client | ClientInterface | |
|---|---|---|
| getAll() | Show all organizations. | OrganizationsResponse |
| getApplications() | Show all applications in an organization. | ApplicationsResponse |
| getMembers() | Show all members of an organization. | MembersResponse |
| getMember() | Returns the user profile of this organization member. | MemberResponse |
| getAdmins() | Show all admins of an organization. | MembersResponse |
| getAdmin() | Returns the user profile of this organization administrator. | MemberResponse |
| getMemberInvitations() | Show all members invited to an organization. | InvitationsResponse |
| deleteMember() | Delete a member from an organization. | OperationResponse |
| leaveOrganization() | Leave an organization. | OperationResponse |
| changeOwner() | Change the owner of an organization. | OperationResponse |
| getTeams() | Show all teams in an organization. | TeamsResponse |
| inviteAdmin() | Invites a user to become admin of an organization. | OperationResponse |
| __construct() | Client constructor. | mixed |
Properties
$client
protected
ClientInterface
$client
Methods
getAll()
Show all organizations.
public
getAll(
)
: OrganizationsResponse
Return values
OrganizationsResponsegetApplications()
Show all applications in an organization.
public
getApplications(
$organizationUuid :
string
)
: ApplicationsResponse
Parameters
- $organizationUuid : string
Return values
ApplicationsResponsegetMembers()
Show all members of an organization.
public
getMembers(
$organizationUuid :
string
)
: MembersResponse
Parameters
- $organizationUuid : string
Return values
MembersResponsegetMember()
Returns the user profile of this organization member.
public
getMember(
$organizationUuid :
string
, $memberUuid :
string
)
: MemberResponse
Parameters
- $organizationUuid : string
- $memberUuid : string
Return values
MemberResponsegetAdmins()
Show all admins of an organization.
public
getAdmins(
$organizationUuid :
string
)
: MembersResponse
Parameters
- $organizationUuid : string
Return values
MembersResponsegetAdmin()
Returns the user profile of this organization administrator.
public
getAdmin(
$organizationUuid :
string
, $memberUuid :
string
)
: MemberResponse
Parameters
- $organizationUuid : string
- $memberUuid : string
Return values
MemberResponsegetMemberInvitations()
Show all members invited to an organization.
public
getMemberInvitations(
$organizationUuid :
string
)
: InvitationsResponse
Parameters
- $organizationUuid : string
Return values
InvitationsResponsedeleteMember()
Delete a member from an organization.
public
deleteMember(
$organizationUuid :
string
, $memberUuid :
string
)
: OperationResponse
Parameters
- $organizationUuid : string
- $memberUuid : string
Return values
OperationResponseleaveOrganization()
Leave an organization.
public
leaveOrganization(
$organizationUuid :
string
)
: OperationResponse
Parameters
- $organizationUuid : string
Return values
OperationResponsechangeOwner()
Change the owner of an organization.
public
changeOwner(
$organizationUuid :
string
, $newOwnerUuid :
string
)
: OperationResponse
Parameters
- $organizationUuid : string
- $newOwnerUuid : string
Return values
OperationResponsegetTeams()
Show all teams in an organization.
public
getTeams(
$organizationUuid :
string
)
: TeamsResponse
Parameters
- $organizationUuid : string
Return values
TeamsResponseinviteAdmin()
Invites a user to become admin of an organization.
public
inviteAdmin(
$organizationUuid :
string
, $email :
string
)
: OperationResponse
Parameters
- $organizationUuid : string
- $email : string
Return values
OperationResponse__construct()
Client constructor.
public
__construct(
$client :
ClientInterface
)
: mixed
Parameters
- $client : ClientInterface