OpsGenie REST API v0.1.0 OpsGenieRESTAPI.Api.CustomUserRole

API calls for all endpoints tagged CustomUserRole.

Link to this section Summary

Functions

Create Custom User Role Creates a new custom user role

Delete Custom User Role Deletes a custom user role using role 'id' or 'name'

Get Custom User Role Returns custom user role with given 'id' or 'name'

List Custom User Roles Returns list of custom user roles

Update Custom User Role Updates the custom user role using role 'id' or 'name'

Link to this section Functions

Link to this function create_custom_user_role(connection, body, opts \\ [])

Create Custom User Role Creates a new custom user role

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • body (CreateCustomUserRolePayload): Request payload of created custom user role
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %OpsGenieRESTAPI.Model.SuccessResponse{}} on success {:error, info} on failure

Link to this function delete_custom_user_role(connection, identifier, opts \\ [])
delete_custom_user_role(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, OpsGenieRESTAPI.Model.SuccessResponse.t()} | {:error, Tesla.Env.t()}

Delete Custom User Role Deletes a custom user role using role 'id' or 'name'

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of custom user role which could be user role 'id' or 'name'
  • opts (KeywordList): [optional] Optional parameters

    • :identifier_type (String.t): Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'

Returns

{:ok, %OpsGenieRESTAPI.Model.SuccessResponse{}} on success {:error, info} on failure

Link to this function get_custom_user_role(connection, identifier, opts \\ [])
get_custom_user_role(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, OpsGenieRESTAPI.Model.GetCustomUserRoleResponse.t()}
  | {:error, Tesla.Env.t()}

Get Custom User Role Returns custom user role with given 'id' or 'name'

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of custom user role which could be user role 'id' or 'name'
  • opts (KeywordList): [optional] Optional parameters

    • :identifier_type (String.t): Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'

Returns

{:ok, %OpsGenieRESTAPI.Model.GetCustomUserRoleResponse{}} on success {:error, info} on failure

Link to this function list_custom_user_roles(connection, opts \\ [])
list_custom_user_roles(Tesla.Env.client(), keyword()) ::
  {:ok, OpsGenieRESTAPI.Model.ListCustomUserRolesResponse.t()}
  | {:error, Tesla.Env.t()}

List Custom User Roles Returns list of custom user roles

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %OpsGenieRESTAPI.Model.ListCustomUserRolesResponse{}} on success {:error, info} on failure

Link to this function update_custom_user_role(connection, identifier, opts \\ [])
update_custom_user_role(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, OpsGenieRESTAPI.Model.SuccessResponse.t()} | {:error, Tesla.Env.t()}

Update Custom User Role Updates the custom user role using role 'id' or 'name'

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of custom user role which could be user role 'id' or 'name'
  • opts (KeywordList): [optional] Optional parameters

    • :identifier_type (String.t): Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'
    • :body (UpdateCustomUserRolePayload): Request payload of update custom user role

Returns

{:ok, %OpsGenieRESTAPI.Model.SuccessResponse{}} on success {:error, info} on failure