OpsGenie REST API v0.1.0 OpsGenieRESTAPI.Api.User
API calls for all endpoints tagged User
.
Link to this section Summary
Functions
Create User Creates a user with the given payload
Delete User Delete user with the given identifier
Get User Get user for the given identifier
List User Escalations List escalations of the user for the given identifier
List User Forwarding Rules List user forwarding rules for the given user identifier
List User Schedules List schedules of the user for the given identifier
List User Teams List user teams for the given user identifier
List users List users with given parameters
Update User (Partial) Update user with the given identifier
Link to this section Functions
create_user( Tesla.Env.client(), OpsGenieRESTAPI.Model.CreateUserPayload.t(), keyword() ) :: {:ok, OpsGenieRESTAPI.Model.SuccessResponse.t()} | {:error, Tesla.Env.t()}
Create User Creates a user with the given payload
Parameters
- connection (OpsGenieRESTAPI.Connection): Connection to server
- body (CreateUserPayload): Request payload of the user object
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %OpsGenieRESTAPI.Model.SuccessResponse{}} on success {:error, info} on failure
delete_user(Tesla.Env.client(), String.t(), keyword()) :: {:ok, OpsGenieRESTAPI.Model.SuccessResponse.t()} | {:error, Tesla.Env.t()}
Delete User Delete user with the given identifier
Parameters
- connection (OpsGenieRESTAPI.Connection): Connection to server
- identifier (String.t): Identifier of the user to be searched
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %OpsGenieRESTAPI.Model.SuccessResponse{}} on success {:error, info} on failure
get_user(Tesla.Env.client(), String.t(), keyword()) :: {:ok, OpsGenieRESTAPI.Model.GetUserResponse.t()} | {:error, Tesla.Env.t()}
Get User Get user for the given identifier
Parameters
- connection (OpsGenieRESTAPI.Connection): Connection to server
- identifier (String.t): Identifier of the user to be searched
opts (KeywordList): [optional] Optional parameters
- :expand ([String.t]): Comma separated list of strings to create a more detailed response. The only expandable field for user api is 'contact'
Returns
{:ok, %OpsGenieRESTAPI.Model.GetUserResponse{}} on success {:error, info} on failure
list_user_escalations(Tesla.Env.client(), String.t(), keyword()) :: {:ok, OpsGenieRESTAPI.Model.ListUserEscalationsResponse.t()} | {:error, Tesla.Env.t()}
List User Escalations List escalations of the user for the given identifier
Parameters
- connection (OpsGenieRESTAPI.Connection): Connection to server
- identifier (String.t): Identifier of the user to be searched
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %OpsGenieRESTAPI.Model.ListUserEscalationsResponse{}} on success {:error, info} on failure
list_user_forwarding_rules(Tesla.Env.client(), String.t(), keyword()) :: {:ok, OpsGenieRESTAPI.Model.ListUserForwardingRulesResponse.t()} | {:error, Tesla.Env.t()}
List User Forwarding Rules List user forwarding rules for the given user identifier
Parameters
- connection (OpsGenieRESTAPI.Connection): Connection to server
- identifier (String.t): Identifier of the user to be searched
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %OpsGenieRESTAPI.Model.ListUserForwardingRulesResponse{}} on success {:error, info} on failure
list_user_schedules(Tesla.Env.client(), String.t(), keyword()) :: {:ok, OpsGenieRESTAPI.Model.ListUserSchedulesResponse.t()} | {:error, Tesla.Env.t()}
List User Schedules List schedules of the user for the given identifier
Parameters
- connection (OpsGenieRESTAPI.Connection): Connection to server
- identifier (String.t): Identifier of the user to be searched
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %OpsGenieRESTAPI.Model.ListUserSchedulesResponse{}} on success {:error, info} on failure
list_user_teams(Tesla.Env.client(), String.t(), keyword()) :: {:ok, OpsGenieRESTAPI.Model.ListUserTeamsResponse.t()} | {:error, Tesla.Env.t()}
List User Teams List user teams for the given user identifier
Parameters
- connection (OpsGenieRESTAPI.Connection): Connection to server
- identifier (String.t): Identifier of the user to be searched
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %OpsGenieRESTAPI.Model.ListUserTeamsResponse{}} on success {:error, info} on failure
list_users(Tesla.Env.client(), keyword()) :: {:ok, OpsGenieRESTAPI.Model.ListUsersResponse.t()} | {:error, Tesla.Env.t()}
List users List users with given parameters
Parameters
- connection (OpsGenieRESTAPI.Connection): Connection to server
opts (KeywordList): [optional] Optional parameters
- :limit (integer()): Number of users to retrieve
- :offset (integer()): Number of users to skip from start
- :sort_field (String.t): Field to use in sorting. Should be one of 'username', 'fullName' and 'insertedAt'
- :order (String.t): Direction of sorting. Should be one of 'asc' or 'desc'
- :query (String.t): Field:value combinations with most of user fields to make more advanced searches. Possible fields are username, fullName, blocked, verified, role, locale, timeZone, userAddress and createdAt
Returns
{:ok, %OpsGenieRESTAPI.Model.ListUsersResponse{}} on success {:error, info} on failure
update_user(Tesla.Env.client(), String.t(), keyword()) :: {:ok, OpsGenieRESTAPI.Model.SuccessResponse.t()} | {:error, Tesla.Env.t()}
Update User (Partial) Update user with the given identifier
Parameters
- connection (OpsGenieRESTAPI.Connection): Connection to server
- identifier (String.t): Identifier of the user to be searched
opts (KeywordList): [optional] Optional parameters
- :body (UpdateUserPayload): Request payload of the user object
Returns
{:ok, %OpsGenieRESTAPI.Model.SuccessResponse{}} on success {:error, info} on failure