Rights and Roles
grants-list
Requires:
|
domain |
Full qualified domain name |
Accepts:
| showkey | Show invitation access key |
Get a list of active and pending grants.
Returns lines in the following format (space-separated):
invitation <nr> <scope> <key> domain <domain-name> <role> - - - <invitee-email> <nick-name> grant <nr> <scope> domain <domain-name> <role> <inviter-username> <invitee-username> <invitee-userid> <invitee-email> <nick-name>
Where:
| <nr> | record number |
| <scope> | Grant/Invite id (used to uniquely identify records for revocation) |
| <key> | Invitation access key, present only when "showkey" is non-zero; it has meaning only for pending invitations, and always is "-" for grants |
| <domain-name> | domain name (identical to domain in request) |
| <role> | one of @admin/@billing/@tech/@creator |
| <inviter-username> | your username (owner of the domain) |
| <invitee-username> | username of invited user |
| <invitee-userid> |
[leave empty] user-ID of invited user |
| <nick-name> | name or comment you want to assign to this role |
grants-invite
Request parameters:
| name | value |
mandatory |
|---|---|---|
| domain | Full qualified domain name |
yes |
| email |
Email of user to be invited to accept a role for 'domain' |
yes |
| role |
Role offered (@admin/@billing/@tech/@creator) |
yes |
|
client-uid |
receiving Joker.com user id as shown on Joker.com - also conforms to reseller-id |
no |
| nick-name |
Name or comment for this role/grant for later identification (defaults to email) |
no |
With this request you can assign 'Roles' (permissions) of domains to other Joker.com users. The special role "creator" is an equivalent to an internal transfer of that domain to another Joker.com user. In this case, the domain is assigned to the receiving account's portfolio, including all rights and permissions on this domain.
There are two variants to use this functionality: If the client-uid (Joker.com user account id) is given, and the client-uid matches the associated user's email address in our system, the role is applied immediately - there will be no request for confirmation on the receiver's side. In case the client-uid is not given, but only the email address, the transaction has to be acknowledged by the receiving user. For this, he will get an email ('invitation'), containing a link and a key. Either the link has to be clicked, or the key has to be applied using Joker.com (=> Transfer). This can also be used for users which do not yet have a Joker.com account.
Returns status only (ok or not). Email is sent if request was succesfull.
grants-revoke
Requires:
| domain | full qualified domain name |
|
role |
Role to be revoked from domain (@admin/@billing/@tech/@creator) |
| scope |
identifier from 'grants-list' request |
|
type |
type of the record to revoke - "grant" or "invitation" |
Deletes an issued grant (permission) of a domain, or a pending invitation for a grant.
Returns status only (ok or not). Email is sent if request was succesfull.