External Relational ID
Self-service operations for a user addressed by external relation ID.
Endpoints
- POSTAdd credit to user
/selfService/credit/byUserExtRelationId/{extRelationId}Add hourly credit to the user. The response is the credit entry ID, which can be used to cancel it. - POSTAdd an hourly group profile to a user
/selfService/hourlyGroupProfile/byUserExtRelationId/{extRelationId}Assign an hourly group profile to the user. - POSTAdd a resource group profile to a user
/selfService/resourceGroupProfile/byUserExtRelationId/{extRelationId}Assign a resource group profile to the user. - POSTAdd a resource pack to a user
/selfService/resourcePack/byUserExtRelationId/{extRelationId}Create a resource pack for the user from a resource limit profile. The pack is enabled unless enabled is false. The response is the new pack ID. - GETRetrieve hourly statistics
/selfService/hourlyStats/byUserExtRelationId/{extRelationId}Hourly usage statistics for the user: credit, totals and per server usage for the current or requested periods. - PUTModify user access
/selfService/access/byUserExtRelationId/{extRelationId}Adjust the user's self service access. syncToProfiles: true re syncs the user's access to the group profiles assigned to them. - DELETERemove hourly group profile from a user
/selfService/hourlyGroupProfile/{profileId}/byUserExtRelationId/{extRelationId}Remove an hourly group profile from the user. - DELETERemove resource group profile from a user
/selfService/resourceGroupProfile/{profileId}/byUserExtRelationId/{extRelationId}Remove a resource group profile from the user. - GETGenerate a report
/selfService/report/byUserExtRelationId/{extRelationId}Usage and limits report for the user for one period, priced in the given or default currency. - PUTSet an hourly resource pack
/selfService/hourlyResourcePack/byUserExtRelationId/{extRelationId}Set the user's hourly resource pack. Omit packId or send null to clear it; an ID that is not an hourly limit profile is refused with 422. - GETRetrieve a user's usage
/selfService/usage/byUserExtRelationId/{extRelationId}Raw hourly usage for the user: per server and per addon hours for the requested periods, with billable totals.