diff --git a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ANDRule.java b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ANDRule.java index fb840a609c..5d1c0c3075 100644 --- a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ANDRule.java +++ b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ANDRule.java @@ -28,14 +28,14 @@ import javax.validation.constraints.*; /** - * Expressions combined with AND condition. + * A sub-rule that combines expressions with AND condition. **/ import io.swagger.annotations.*; import java.util.Objects; import javax.validation.Valid; import javax.xml.bind.annotation.*; -@ApiModel(description = "Expressions combined with AND condition.") +@ApiModel(description = "A sub-rule that combines expressions with AND condition.") public class ANDRule { @@ -76,6 +76,7 @@ public static ConditionEnum fromValue(String value) { /** + * The logical condition for combining the expressions. For ANDRule, the value must always be \"AND\". **/ public ANDRule condition(ConditionEnum condition) { @@ -83,7 +84,7 @@ public ANDRule condition(ConditionEnum condition) { return this; } - @ApiModelProperty(required = true, value = "") + @ApiModelProperty(required = true, value = "The logical condition for combining the expressions. For ANDRule, the value must always be \"AND\".") @JsonProperty("condition") @Valid @NotNull(message = "Property condition cannot be null.") @@ -96,6 +97,7 @@ public void setCondition(ConditionEnum condition) { } /** + * A list of expressions that are combined using the AND condition. All expressions must evaluate to true for the ANDRule to pass. **/ public ANDRule expressions(List expressions) { @@ -103,11 +105,11 @@ public ANDRule expressions(List expressions) { return this; } - @ApiModelProperty(required = true, value = "") + @ApiModelProperty(required = true, value = "A list of expressions that are combined using the AND condition. All expressions must evaluate to true for the ANDRule to pass.") @JsonProperty("expressions") @Valid @NotNull(message = "Property expressions cannot be null.") - @Size(min=1) + @Size(min=1) public List getExpressions() { return expressions; } diff --git a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ANDRuleResponse.java b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ANDRuleResponse.java index ae04c941e8..df1f3bd10a 100644 --- a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ANDRuleResponse.java +++ b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ANDRuleResponse.java @@ -28,14 +28,14 @@ import javax.validation.constraints.*; /** - * Expressions combined with AND condition. + * Represents a rule configuration that combines multiple expressions with an AND condition. All expressions in the ANDRule must evaluate to true for the rule to be satisfied. **/ import io.swagger.annotations.*; import java.util.Objects; import javax.validation.Valid; import javax.xml.bind.annotation.*; -@ApiModel(description = "Expressions combined with AND condition.") +@ApiModel(description = "Represents a rule configuration that combines multiple expressions with an AND condition. All expressions in the ANDRule must evaluate to true for the rule to be satisfied.") public class ANDRuleResponse { @@ -76,6 +76,7 @@ public static ConditionEnum fromValue(String value) { /** + * The logical condition for combining the expressions. For ANDRule, the value must always be \"AND\". **/ public ANDRuleResponse condition(ConditionEnum condition) { @@ -83,7 +84,7 @@ public ANDRuleResponse condition(ConditionEnum condition) { return this; } - @ApiModelProperty(value = "") + @ApiModelProperty(value = "The logical condition for combining the expressions. For ANDRule, the value must always be \"AND\".") @JsonProperty("condition") @Valid public ConditionEnum getCondition() { @@ -94,6 +95,7 @@ public void setCondition(ConditionEnum condition) { } /** + * A list of expressions that are combined using the AND condition. All expressions must evaluate to true for the ANDRule to pass. **/ public ANDRuleResponse expressions(List expressions) { @@ -101,7 +103,7 @@ public ANDRuleResponse expressions(List expressions) { return this; } - @ApiModelProperty(value = "") + @ApiModelProperty(value = "A list of expressions that are combined using the AND condition. All expressions must evaluate to true for the ANDRule to pass.") @JsonProperty("expressions") @Valid @Size(min=1) public List getExpressions() { diff --git a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ActionBasicResponse.java b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ActionBasicResponse.java index 283466df93..ab03e23fbc 100644 --- a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ActionBasicResponse.java +++ b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ActionBasicResponse.java @@ -78,6 +78,7 @@ public static StatusEnum fromValue(String value) { /** + * Unique identifier of the action. **/ public ActionBasicResponse id(String id) { @@ -85,7 +86,7 @@ public ActionBasicResponse id(String id) { return this; } - @ApiModelProperty(example = "24f64d17-9824-4e28-8413-de45728d8e84", value = "") + @ApiModelProperty(example = "24f64d17-9824-4e28-8413-de45728d8e84", value = "Unique identifier of the action.") @JsonProperty("id") @Valid public String getId() { @@ -114,6 +115,7 @@ public void setType(ActionType type) { } /** + * Name of the action. **/ public ActionBasicResponse name(String name) { @@ -121,7 +123,7 @@ public ActionBasicResponse name(String name) { return this; } - @ApiModelProperty(example = "Access Token Pre Issue", value = "") + @ApiModelProperty(example = "Access Token Pre Issue", value = "Name of the action.") @JsonProperty("name") @Valid @Size(min=1,max=255) public String getName() { @@ -132,6 +134,7 @@ public void setName(String name) { } /** + * Description of the action. **/ public ActionBasicResponse description(String description) { @@ -139,7 +142,7 @@ public ActionBasicResponse description(String description) { return this; } - @ApiModelProperty(example = "This is the configuration of pre-action for issuing access token.", value = "") + @ApiModelProperty(example = "This action invokes before issuing an access token.", value = "Description of the action.") @JsonProperty("description") @Valid @Size(max=255) public String getDescription() { @@ -150,6 +153,7 @@ public void setDescription(String description) { } /** + * Status of the action. **/ public ActionBasicResponse status(StatusEnum status) { @@ -157,7 +161,7 @@ public ActionBasicResponse status(StatusEnum status) { return this; } - @ApiModelProperty(value = "") + @ApiModelProperty(value = "Status of the action.") @JsonProperty("status") @Valid public StatusEnum getStatus() { diff --git a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ActionModel.java b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ActionModel.java index 9205b927d0..1161d43879 100644 --- a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ActionModel.java +++ b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ActionModel.java @@ -40,6 +40,7 @@ public class ActionModel { private ORRule rule; /** + * Name of the action. **/ public ActionModel name(String name) { @@ -47,7 +48,7 @@ public ActionModel name(String name) { return this; } - @ApiModelProperty(example = "Access Token Pre Issue", required = true, value = "") + @ApiModelProperty(example = "Pre Issue Access Token Action", required = true, value = "Name of the action.") @JsonProperty("name") @Valid @NotNull(message = "Property name cannot be null.") @@ -60,6 +61,7 @@ public void setName(String name) { } /** + * Description of the action. **/ public ActionModel description(String description) { @@ -67,7 +69,7 @@ public ActionModel description(String description) { return this; } - @ApiModelProperty(example = "This is the configuration of pre-action for issuing access token.", value = "") + @ApiModelProperty(example = "This action invokes before issuing an access token.", value = "Description of the action.") @JsonProperty("description") @Valid @Size(max=255) public String getDescription() { diff --git a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ActionResponse.java b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ActionResponse.java index 3cf84ba92e..556093abea 100644 --- a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ActionResponse.java +++ b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ActionResponse.java @@ -77,6 +77,7 @@ public static StatusEnum fromValue(String value) { private ORRuleResponse rule; /** + * Unique identifier of the action. **/ public ActionResponse id(String id) { @@ -84,7 +85,7 @@ public ActionResponse id(String id) { return this; } - @ApiModelProperty(example = "24f64d17-9824-4e28-8413-de45728d8e84", value = "") + @ApiModelProperty(example = "24f64d17-9824-4e28-8413-de45728d8e84", value = "Unique identifier of the action.") @JsonProperty("id") @Valid public String getId() { @@ -113,6 +114,7 @@ public void setType(ActionType type) { } /** + * Name of the action. **/ public ActionResponse name(String name) { @@ -120,7 +122,7 @@ public ActionResponse name(String name) { return this; } - @ApiModelProperty(example = "Access Token Pre Issue", value = "") + @ApiModelProperty(example = "Access Token Pre Issue", value = "Name of the action.") @JsonProperty("name") @Valid @Size(min=1,max=255) public String getName() { @@ -131,6 +133,7 @@ public void setName(String name) { } /** + * Description of the action. **/ public ActionResponse description(String description) { @@ -138,7 +141,7 @@ public ActionResponse description(String description) { return this; } - @ApiModelProperty(example = "This is the configuration of pre-action for issuing access token.", value = "") + @ApiModelProperty(example = "This action invokes before issuing an access token.", value = "Description of the action.") @JsonProperty("description") @Valid @Size(max=255) public String getDescription() { @@ -149,6 +152,7 @@ public void setDescription(String description) { } /** + * Status of the action. **/ public ActionResponse status(StatusEnum status) { @@ -156,7 +160,7 @@ public ActionResponse status(StatusEnum status) { return this; } - @ApiModelProperty(value = "") + @ApiModelProperty(example = "ACTIVE", value = "Status of the action.") @JsonProperty("status") @Valid public StatusEnum getStatus() { diff --git a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ActionTypesResponseItem.java b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ActionTypesResponseItem.java index 7c09805fe7..164bb3237e 100644 --- a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ActionTypesResponseItem.java +++ b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ActionTypesResponseItem.java @@ -58,6 +58,7 @@ public void setType(ActionType type) { } /** + * Display name of the action type. **/ public ActionTypesResponseItem displayName(String displayName) { @@ -65,7 +66,7 @@ public ActionTypesResponseItem displayName(String displayName) { return this; } - @ApiModelProperty(example = "Pre Issue Access Token.", value = "") + @ApiModelProperty(example = "Pre Issue Access Token.", value = "Display name of the action type.") @JsonProperty("displayName") @Valid public String getDisplayName() { @@ -76,6 +77,7 @@ public void setDisplayName(String displayName) { } /** + * Description of the action type. **/ public ActionTypesResponseItem description(String description) { @@ -83,7 +85,7 @@ public ActionTypesResponseItem description(String description) { return this; } - @ApiModelProperty(example = "Extension point configuration for Pre Issue Access Token.", value = "") + @ApiModelProperty(example = "Extension point configuration for Pre Issue Access Token.", value = "Description of the action type.") @JsonProperty("description") @Valid public String getDescription() { @@ -94,6 +96,7 @@ public void setDescription(String description) { } /** + * Number of actions configured under the action type. **/ public ActionTypesResponseItem count(Integer count) { @@ -101,7 +104,7 @@ public ActionTypesResponseItem count(Integer count) { return this; } - @ApiModelProperty(example = "2", value = "") + @ApiModelProperty(example = "1", value = "Number of actions configured under the action type.") @JsonProperty("count") @Valid public Integer getCount() { @@ -112,6 +115,7 @@ public void setCount(Integer count) { } /** + * API endpoint referring to the location of the given action type. **/ public ActionTypesResponseItem self(String self) { @@ -119,7 +123,7 @@ public ActionTypesResponseItem self(String self) { return this; } - @ApiModelProperty(example = "/t/wso2.com/api/server/v1/actions/preIssueAccessToken", value = "") + @ApiModelProperty(example = "/t/wso2.com/api/server/v1/actions/preIssueAccessToken", value = "API endpoint referring to the location of the given action type.") @JsonProperty("self") @Valid public String getSelf() { diff --git a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ActionUpdateModel.java b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ActionUpdateModel.java index 37d4c7b9e0..439ad4d73e 100644 --- a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ActionUpdateModel.java +++ b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ActionUpdateModel.java @@ -40,6 +40,7 @@ public class ActionUpdateModel { private ORRule rule; /** + * Updating name of the action. **/ public ActionUpdateModel name(String name) { @@ -47,7 +48,7 @@ public ActionUpdateModel name(String name) { return this; } - @ApiModelProperty(example = "Access Token Pre Issue", value = "") + @ApiModelProperty(example = "Pre Issue Access Token Action", value = "Updating name of the action.") @JsonProperty("name") @Valid @Size(min=1,max=255) public String getName() { @@ -58,6 +59,7 @@ public void setName(String name) { } /** + * Updating description of the action. **/ public ActionUpdateModel description(String description) { @@ -65,7 +67,7 @@ public ActionUpdateModel description(String description) { return this; } - @ApiModelProperty(example = "This is the configuration of pre-action for issuing access token.", value = "") + @ApiModelProperty(example = "This action invokes before issuing an access token.", value = "Updating description of the action.") @JsonProperty("description") @Valid @Size(max=255) public String getDescription() { diff --git a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ActionsApi.java b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ActionsApi.java index e35b2af9f9..84d0e7cecd 100644 --- a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ActionsApi.java +++ b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ActionsApi.java @@ -52,21 +52,22 @@ public class ActionsApi { @Path("/{actionType}/{actionId}/activate") @Produces({ "application/json" }) - @ApiOperation(value = "Activates the action by given Id. ", notes = "This API provides the capability to activate an action by action Id.
Scope required:
* internal_action_mgt_update ", response = ActionBasicResponse.class, authorizations = { + @ApiOperation(value = "Activate Action", notes = "This API activates an action using the action's type and unique ID. Scope (Permission) required: ``internal_action_mgt_update`` ", response = ActionBasicResponse.class, authorizations = { @Authorization(value = "BasicAuth"), @Authorization(value = "OAuth2", scopes = { }) }, tags={ "Actions", }) @ApiResponses(value = { - @ApiResponse(code = 200, message = "OK", response = ActionBasicResponse.class), + @ApiResponse(code = 200, message = "Action Activated", response = ActionBasicResponse.class), @ApiResponse(code = 400, message = "Bad Request", response = Error.class), @ApiResponse(code = 401, message = "Unauthorized", response = Void.class), @ApiResponse(code = 403, message = "Forbidden", response = Void.class), @ApiResponse(code = 404, message = "Not Found", response = Error.class), - @ApiResponse(code = 500, message = "Server Error", response = Error.class) + @ApiResponse(code = 500, message = "Server Error", response = Error.class), + @ApiResponse(code = 501, message = "Not Implemented", response = Error.class) }) - public Response activateAction(@ApiParam(value = "Name of the Action Type.",required=true, allowableValues="preIssueAccessToken, preUpdatePassword, preUpdateProfile, preRegistration") @PathParam("actionType") String actionType, @ApiParam(value = "Id of the Action.",required=true) @PathParam("actionId") String actionId) { + public Response activateAction(@ApiParam(value = "Name of the Action Type.",required=true, allowableValues="preIssueAccessToken, preUpdatePassword, preUpdateProfile, preRegistration") @PathParam("actionType") String actionType, @ApiParam(value = "Unique identifier of the action.",required=true) @PathParam("actionId") String actionId) { return delegate.activateAction(actionType, actionId ); } @@ -76,22 +77,21 @@ public Response activateAction(@ApiParam(value = "Name of the Action Type.",requ @Path("/{actionType}") @Consumes({ "application/json" }) @Produces({ "application/json" }) - @ApiOperation(value = "Add action ", notes = "This API provides the capability to store the action information that is provided by users.
Scope required:
* internal_action_mgt_create ", response = ActionResponse.class, authorizations = { + @ApiOperation(value = "Add Action", notes = "This API creates an action and returns the action details along with the action's unique ID. Scope (Permission) required: ``internal_action_mgt_create`` ", response = ActionResponse.class, authorizations = { @Authorization(value = "BasicAuth"), @Authorization(value = "OAuth2", scopes = { }) }, tags={ "Actions", }) @ApiResponses(value = { - @ApiResponse(code = 201, message = "Successful response.", response = ActionResponse.class), + @ApiResponse(code = 201, message = "Action Created", response = ActionResponse.class), @ApiResponse(code = 400, message = "Bad Request", response = Error.class), @ApiResponse(code = 401, message = "Unauthorized", response = Void.class), @ApiResponse(code = 403, message = "Forbidden", response = Void.class), - @ApiResponse(code = 409, message = "Conflict", response = Error.class), @ApiResponse(code = 500, message = "Server Error", response = Error.class), @ApiResponse(code = 501, message = "Not Implemented", response = Error.class) }) - public Response createAction(@ApiParam(value = "Name of the Action Type.",required=true, allowableValues="preIssueAccessToken, preUpdatePassword, preUpdateProfile, preRegistration") @PathParam("actionType") String actionType, @ApiParam(value = "This represents the action to be created." ,required=true) @Valid ActionModel actionModel) { + public Response createAction(@ApiParam(value = "Name of the Action Type.",required=true, allowableValues="preIssueAccessToken, preUpdatePassword, preUpdateProfile, preRegistration") @PathParam("actionType") String actionType, @ApiParam(value = "This represents the information of the action to be created." ,required=true) @Valid ActionModel actionModel) { return delegate.createAction(actionType, actionModel ); } @@ -101,21 +101,22 @@ public Response createAction(@ApiParam(value = "Name of the Action Type.",requir @Path("/{actionType}/{actionId}/deactivate") @Produces({ "application/json" }) - @ApiOperation(value = "Deactivates the action by given Id. ", notes = "This API provides the capability to deactivate an action by action Id.
Scope required:
* internal_action_mgt_update ", response = ActionBasicResponse.class, authorizations = { + @ApiOperation(value = "Deactivate Action", notes = "This API deactivates an action using the action's type and unique ID. Scope (Permission) required: ``internal_action_mgt_update`` ", response = ActionBasicResponse.class, authorizations = { @Authorization(value = "BasicAuth"), @Authorization(value = "OAuth2", scopes = { }) }, tags={ "Actions", }) @ApiResponses(value = { - @ApiResponse(code = 200, message = "OK", response = ActionBasicResponse.class), + @ApiResponse(code = 200, message = "Action Deactivated", response = ActionBasicResponse.class), @ApiResponse(code = 400, message = "Bad Request", response = Error.class), @ApiResponse(code = 401, message = "Unauthorized", response = Void.class), @ApiResponse(code = 403, message = "Forbidden", response = Void.class), @ApiResponse(code = 404, message = "Not Found", response = Error.class), - @ApiResponse(code = 500, message = "Server Error", response = Error.class) + @ApiResponse(code = 500, message = "Server Error", response = Error.class), + @ApiResponse(code = 501, message = "Not Implemented", response = Error.class) }) - public Response deactivateAction(@ApiParam(value = "Name of the Action Type.",required=true, allowableValues="preIssueAccessToken, preUpdatePassword, preUpdateProfile, preRegistration") @PathParam("actionType") String actionType, @ApiParam(value = "Id of the Action.",required=true) @PathParam("actionId") String actionId) { + public Response deactivateAction(@ApiParam(value = "Name of the Action Type.",required=true, allowableValues="preIssueAccessToken, preUpdatePassword, preUpdateProfile, preRegistration") @PathParam("actionType") String actionType, @ApiParam(value = "Unique identifier of the action.",required=true) @PathParam("actionId") String actionId) { return delegate.deactivateAction(actionType, actionId ); } @@ -125,20 +126,21 @@ public Response deactivateAction(@ApiParam(value = "Name of the Action Type.",re @Path("/{actionType}/{actionId}") @Produces({ "application/json" }) - @ApiOperation(value = "Delete action by action type and action id. ", notes = "This API provides the capability to delete an action by action type.
Scope required:
* internal_action_mgt_delete ", response = Void.class, authorizations = { + @ApiOperation(value = "Delete Action", notes = "This API deletes an action using the action's type and unique ID. Scope (Permission) required: ``internal_action_mgt_delete`` ", response = Void.class, authorizations = { @Authorization(value = "BasicAuth"), @Authorization(value = "OAuth2", scopes = { }) }, tags={ "Actions", }) @ApiResponses(value = { - @ApiResponse(code = 204, message = "Successfully Deleted", response = Void.class), + @ApiResponse(code = 204, message = "Action Deleted", response = Void.class), @ApiResponse(code = 400, message = "Bad Request", response = Error.class), @ApiResponse(code = 401, message = "Unauthorized", response = Void.class), @ApiResponse(code = 403, message = "Forbidden", response = Void.class), - @ApiResponse(code = 500, message = "Server Error", response = Error.class) + @ApiResponse(code = 500, message = "Server Error", response = Error.class), + @ApiResponse(code = 501, message = "Not Implemented", response = Error.class) }) - public Response deleteAction(@ApiParam(value = "Name of the Action Type.",required=true, allowableValues="preIssueAccessToken, preUpdatePassword, preUpdateProfile, preRegistration") @PathParam("actionType") String actionType, @ApiParam(value = "Id of the Action.",required=true) @PathParam("actionId") String actionId) { + public Response deleteAction(@ApiParam(value = "Name of the Action Type.",required=true, allowableValues="preIssueAccessToken, preUpdatePassword, preUpdateProfile, preRegistration") @PathParam("actionType") String actionType, @ApiParam(value = "Unique identifier of the action.",required=true) @PathParam("actionId") String actionId) { return delegate.deleteAction(actionType, actionId ); } @@ -148,7 +150,7 @@ public Response deleteAction(@ApiParam(value = "Name of the Action Type.",requir @Path("/{actionType}/{actionId}") @Produces({ "application/json" }) - @ApiOperation(value = "Retrieve Action information by given Id. ", notes = "This API provides the capability to retrieve the action by action Id.
Scope required:
* internal_action_mgt_view ", response = ActionResponse.class, authorizations = { + @ApiOperation(value = "Retrieve Action by ID", notes = "This API provides the capability to retrieve the action by action Id. Scope (Permission) required: ``internal_action_mgt_view`` ", response = ActionResponse.class, authorizations = { @Authorization(value = "BasicAuth"), @Authorization(value = "OAuth2", scopes = { @@ -163,7 +165,7 @@ public Response deleteAction(@ApiParam(value = "Name of the Action Type.",requir @ApiResponse(code = 500, message = "Server Error", response = Error.class), @ApiResponse(code = 501, message = "Not Implemented", response = Error.class) }) - public Response getActionByActionId(@ApiParam(value = "Name of the Action Type.",required=true, allowableValues="preIssueAccessToken, preUpdatePassword, preUpdateProfile, preRegistration") @PathParam("actionType") String actionType, @ApiParam(value = "Id of the Action.",required=true) @PathParam("actionId") String actionId) { + public Response getActionByActionId(@ApiParam(value = "Name of the Action Type.",required=true, allowableValues="preIssueAccessToken, preUpdatePassword, preUpdateProfile, preRegistration") @PathParam("actionType") String actionType, @ApiParam(value = "Unique identifier of the action.",required=true) @PathParam("actionId") String actionId) { return delegate.getActionByActionId(actionType, actionId ); } @@ -173,20 +175,17 @@ public Response getActionByActionId(@ApiParam(value = "Name of the Action Type." @Path("/types") @Produces({ "application/json" }) - @ApiOperation(value = "Detailed summary of the Action Types ", notes = "This API provides the capability to retrieve the detailed summary of the action types.
Scope required:
* internal_action_mgt_view ", response = ActionTypesResponseItem.class, responseContainer = "List", authorizations = { + @ApiOperation(value = "List Action Types", notes = "This API returns the detailed summary of the action types. Scope (Permission) required: ``internal_action_mgt_view`` ", response = ActionTypesResponseItem.class, responseContainer = "List", authorizations = { @Authorization(value = "BasicAuth"), @Authorization(value = "OAuth2", scopes = { }) - }, tags={ "Actions", }) + }, tags={ "Action Types", }) @ApiResponses(value = { @ApiResponse(code = 200, message = "OK", response = ActionTypesResponseItem.class, responseContainer = "List"), - @ApiResponse(code = 400, message = "Bad Request", response = Error.class), @ApiResponse(code = 401, message = "Unauthorized", response = Void.class), @ApiResponse(code = 403, message = "Forbidden", response = Void.class), - @ApiResponse(code = 404, message = "Not Found", response = Error.class), - @ApiResponse(code = 500, message = "Server Error", response = Error.class), - @ApiResponse(code = 501, message = "Not Implemented", response = Error.class) + @ApiResponse(code = 500, message = "Server Error", response = Error.class) }) public Response getActionTypes() { @@ -198,7 +197,7 @@ public Response getActionTypes() { @Path("/{actionType}") @Produces({ "application/json" }) - @ApiOperation(value = "List action ", notes = "This API provides the capability to retrieve the action by action type.
Scope required:
* internal_action_mgt_view ", response = ActionBasicResponse.class, responseContainer = "List", authorizations = { + @ApiOperation(value = "List Actions", notes = "This API returns actions according to the action type. Scope (Permission) required: ``internal_action_mgt_view`` ", response = ActionBasicResponse.class, responseContainer = "List", authorizations = { @Authorization(value = "BasicAuth"), @Authorization(value = "OAuth2", scopes = { @@ -223,23 +222,24 @@ public Response getActionsByActionType(@ApiParam(value = "Name of the Action Typ @Path("/{actionType}/{actionId}") @Consumes({ "application/json" }) @Produces({ "application/json" }) - @ApiOperation(value = "Update Action information by given Id. ", notes = "This API provides the capability to update Action information by given Id.
Scope required:
* internal_action_mgt_update ", response = ActionResponse.class, authorizations = { + @ApiOperation(value = "Update Action", notes = "This API updates an action and return the updated action. Scope (Permission) required: ``internal_action_mgt_update`` ", response = ActionResponse.class, authorizations = { @Authorization(value = "BasicAuth"), @Authorization(value = "OAuth2", scopes = { }) }, tags={ "Actions" }) @ApiResponses(value = { - @ApiResponse(code = 200, message = "OK", response = ActionResponse.class), + @ApiResponse(code = 200, message = "Action Updated", response = ActionResponse.class), @ApiResponse(code = 400, message = "Bad Request", response = Error.class), @ApiResponse(code = 401, message = "Unauthorized", response = Void.class), @ApiResponse(code = 403, message = "Forbidden", response = Void.class), @ApiResponse(code = 404, message = "Not Found", response = Error.class), - @ApiResponse(code = 500, message = "Server Error", response = Error.class) + @ApiResponse(code = 500, message = "Server Error", response = Error.class), + @ApiResponse(code = 501, message = "Not Implemented", response = Error.class) }) - public Response updateAction(@ApiParam(value = "Name of the Action Type.",required=true, allowableValues="preIssueAccessToken, preUpdatePassword, preUpdateProfile, preRegistration") @PathParam("actionType") String actionType, @ApiParam(value = "Id of the Action.",required=true) @PathParam("actionId") String actionId, @ApiParam(value = "This represents the action information to be updated." ,required=true) @Valid ActionUpdateModel actionUpdateModel) { + public Response updateAction(@ApiParam(value = "Name of the Action Type.",required=true, allowableValues="preIssueAccessToken, preUpdatePassword, preUpdateProfile, preRegistration") @PathParam("actionType") String actionType, @ApiParam(value = "Unique identifier of the action.",required=true) @PathParam("actionId") String actionId, @ApiParam(value = "This represents the action to be updated." ,required=true) @Valid ActionUpdateModel body) { - return delegate.updateAction(actionType, actionId, actionUpdateModel ); + return delegate.updateAction(actionType, actionId, body ); } } diff --git a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/AuthenticationType.java b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/AuthenticationType.java index c2e6338cb8..ba3a6f0c1b 100644 --- a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/AuthenticationType.java +++ b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/AuthenticationType.java @@ -27,12 +27,15 @@ import java.util.Map; import javax.validation.constraints.*; +/** + * The type of authentication required by the action's endpoint. The following options are supported: - NONE: No authentication is required. <br> ``{ \"type\": \"NONE\" }`` - BASIC: Basic authentication with a username and password.<br> ``{ \"type\": \"BASIC\", \"properties\": { \"username\": \"auth_username\", \"password\": \"auth_password\" } }`` - API_KEY: API key-based authentication, where the key is provided in an HTTP header.<br> ``{ \"type\": \"API_KEY\", \"properties\": { \"header\": \"X-API-Key\", \"value\": \"12345-abcde-67890\" } }`` - BEARER: Bearer token-based authentication.<br/> ``{ \"type\": \"BEARER\", \"properties\": { \"accessToken\": \"0d6fed02-eac0-332b-8998-213a543139a0\" } }`` + **/ import io.swagger.annotations.*; import java.util.Objects; import javax.validation.Valid; import javax.xml.bind.annotation.*; - +@ApiModel(description = "The type of authentication required by the action's endpoint. The following options are supported: - NONE: No authentication is required.
``{ \"type\": \"NONE\" }`` - BASIC: Basic authentication with a username and password.
``{ \"type\": \"BASIC\", \"properties\": { \"username\": \"auth_username\", \"password\": \"auth_password\" } }`` - API_KEY: API key-based authentication, where the key is provided in an HTTP header.
``{ \"type\": \"API_KEY\", \"properties\": { \"header\": \"X-API-Key\", \"value\": \"12345-abcde-67890\" } }`` - BEARER: Bearer token-based authentication.
``{ \"type\": \"BEARER\", \"properties\": { \"accessToken\": \"0d6fed02-eac0-332b-8998-213a543139a0\" } }`` ") public class AuthenticationType { @@ -69,7 +72,7 @@ public static TypeEnum fromValue(String value) { } private TypeEnum type; - private Map properties = new HashMap(); + private Map properties = null; /** @@ -93,6 +96,7 @@ public void setType(TypeEnum type) { } /** + * Authentication properties specific to the selected type. **/ public AuthenticationType properties(Map properties) { @@ -100,11 +104,9 @@ public AuthenticationType properties(Map properties) { return this; } - @ApiModelProperty(example = "{\"username\":\"auth_username\",\"password\":\"auth_password\"}", required = true, value = "") + @ApiModelProperty(value = "Authentication properties specific to the selected type.") @JsonProperty("properties") @Valid - @NotNull(message = "Property properties cannot be null.") - public Map getProperties() { return properties; } @@ -114,6 +116,9 @@ public void setProperties(Map properties) { public AuthenticationType putPropertiesItem(String key, Object propertiesItem) { + if (this.properties == null) { + this.properties = new HashMap(); + } this.properties.put(key, propertiesItem); return this; } diff --git a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/AuthenticationTypeResponse.java b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/AuthenticationTypeResponse.java index 91056333bc..ea1875792f 100644 --- a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/AuthenticationTypeResponse.java +++ b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/AuthenticationTypeResponse.java @@ -24,12 +24,15 @@ import io.swagger.annotations.ApiModelProperty; import javax.validation.constraints.*; +/** + * Authentication configurations of the action. + **/ import io.swagger.annotations.*; import java.util.Objects; import javax.validation.Valid; import javax.xml.bind.annotation.*; - +@ApiModel(description = "Authentication configurations of the action.") public class AuthenticationTypeResponse { @@ -68,6 +71,7 @@ public static TypeEnum fromValue(String value) { private TypeEnum type; /** + * Type of the authentication. **/ public AuthenticationTypeResponse type(TypeEnum type) { @@ -75,7 +79,7 @@ public AuthenticationTypeResponse type(TypeEnum type) { return this; } - @ApiModelProperty(example = "BASIC", required = true, value = "") + @ApiModelProperty(example = "BASIC", required = true, value = "Type of the authentication.") @JsonProperty("type") @Valid @NotNull(message = "Property type cannot be null.") diff --git a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/Endpoint.java b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/Endpoint.java index 4f51963f0b..5146990b64 100644 --- a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/Endpoint.java +++ b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/Endpoint.java @@ -25,18 +25,22 @@ import org.wso2.carbon.identity.api.server.action.management.v1.AuthenticationType; import javax.validation.constraints.*; +/** + * Endpoint configurations of the action. + **/ import io.swagger.annotations.*; import java.util.Objects; import javax.validation.Valid; import javax.xml.bind.annotation.*; - +@ApiModel(description = "Endpoint configurations of the action.") public class Endpoint { private String uri; private AuthenticationType authentication; /** + * HTTPS URI of the endpoint. **/ public Endpoint uri(String uri) { @@ -44,11 +48,11 @@ public Endpoint uri(String uri) { return this; } - @ApiModelProperty(example = "https://abc.com/token", required = true, value = "") + @ApiModelProperty(example = "https://myextension.com/token", required = true, value = "HTTPS URI of the endpoint.") @JsonProperty("uri") @Valid @NotNull(message = "Property uri cannot be null.") - @Pattern(regexp="^https?://.+") + @Pattern(regexp="^https?://.+") public String getUri() { return uri; } diff --git a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/EndpointResponse.java b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/EndpointResponse.java index 359f05762f..f6a17bb06b 100644 --- a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/EndpointResponse.java +++ b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/EndpointResponse.java @@ -25,18 +25,22 @@ import org.wso2.carbon.identity.api.server.action.management.v1.AuthenticationTypeResponse; import javax.validation.constraints.*; +/** + * Endpoint configurations of the action. + **/ import io.swagger.annotations.*; import java.util.Objects; import javax.validation.Valid; import javax.xml.bind.annotation.*; - +@ApiModel(description = "Endpoint configurations of the action.") public class EndpointResponse { private String uri; private AuthenticationTypeResponse authentication; /** + * HTTPS URI of the endpoint. **/ public EndpointResponse uri(String uri) { @@ -44,11 +48,11 @@ public EndpointResponse uri(String uri) { return this; } - @ApiModelProperty(example = "https://abc.com/token", required = true, value = "") + @ApiModelProperty(example = "https://myextension.com/token", required = true, value = "HTTPS URI of the endpoint.") @JsonProperty("uri") @Valid @NotNull(message = "Property uri cannot be null.") - @Pattern(regexp="^https?://.+") + @Pattern(regexp="^https?://.+") public String getUri() { return uri; } diff --git a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/EndpointUpdateModel.java b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/EndpointUpdateModel.java index 59d7572931..231b690b9c 100644 --- a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/EndpointUpdateModel.java +++ b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/EndpointUpdateModel.java @@ -25,18 +25,22 @@ import org.wso2.carbon.identity.api.server.action.management.v1.AuthenticationType; import javax.validation.constraints.*; +/** + * Updating endpoint configurations of the action. + **/ import io.swagger.annotations.*; import java.util.Objects; import javax.validation.Valid; import javax.xml.bind.annotation.*; - +@ApiModel(description = "Updating endpoint configurations of the action.") public class EndpointUpdateModel { private String uri; private AuthenticationType authentication; /** + * Updating HTTPS URI of the endpoint. **/ public EndpointUpdateModel uri(String uri) { @@ -44,7 +48,7 @@ public EndpointUpdateModel uri(String uri) { return this; } - @ApiModelProperty(example = "https://abc.com/token", value = "") + @ApiModelProperty(example = "https://myextension.com/token", value = "Updating HTTPS URI of the endpoint.") @JsonProperty("uri") @Valid @Pattern(regexp="^https?://.+") public String getUri() { diff --git a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/Expression.java b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/Expression.java index 37ed6a1882..db93b4e14c 100644 --- a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/Expression.java +++ b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/Expression.java @@ -25,14 +25,14 @@ import javax.validation.constraints.*; /** - * Expressions in the rule. + * Represents a single logical condition or comparison within a rule. An expression defines a field, an operator, and a value that is evaluated. **/ import io.swagger.annotations.*; import java.util.Objects; import javax.validation.Valid; import javax.xml.bind.annotation.*; -@ApiModel(description = "Expressions in the rule.") +@ApiModel(description = "Represents a single logical condition or comparison within a rule. An expression defines a field, an operator, and a value that is evaluated.") public class Expression { private String field; @@ -40,6 +40,7 @@ public class Expression { private String value; /** + * The field or attribute of the entity being evaluated (e.g.,application, role). **/ public Expression field(String field) { @@ -47,7 +48,7 @@ public Expression field(String field) { return this; } - @ApiModelProperty(example = "application", required = true, value = "") + @ApiModelProperty(example = "application", required = true, value = "The field or attribute of the entity being evaluated (e.g.,application, role).") @JsonProperty("field") @Valid @NotNull(message = "Property field cannot be null.") @@ -60,6 +61,7 @@ public void setField(String field) { } /** + * The comparison operator used to evaluate the field and value. Common operators include \"equals\", \"contains\", \"startsWith\", etc. **/ public Expression operator(String operator) { @@ -67,7 +69,7 @@ public Expression operator(String operator) { return this; } - @ApiModelProperty(example = "equals", required = true, value = "") + @ApiModelProperty(example = "equals", required = true, value = "The comparison operator used to evaluate the field and value. Common operators include \"equals\", \"contains\", \"startsWith\", etc.") @JsonProperty("operator") @Valid @NotNull(message = "Property operator cannot be null.") @@ -80,6 +82,7 @@ public void setOperator(String operator) { } /** + * The value that the field is compared against based on the operator. **/ public Expression value(String value) { @@ -87,7 +90,7 @@ public Expression value(String value) { return this; } - @ApiModelProperty(example = "myapp", required = true, value = "") + @ApiModelProperty(example = "myapp", required = true, value = "The value that the field is compared against based on the operator.") @JsonProperty("value") @Valid @NotNull(message = "Property value cannot be null.") diff --git a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ORRule.java b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ORRule.java index 42afa6827c..6ec36aaf22 100644 --- a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ORRule.java +++ b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ORRule.java @@ -28,14 +28,14 @@ import javax.validation.constraints.*; /** - * Rule configuration for the action. Combined with OR condition. + * Represents a rule configuration that combines multiple sub-rules with an OR condition. If any of the sub-rules evaluate to true, the ORRule is considered satisfied. **/ import io.swagger.annotations.*; import java.util.Objects; import javax.validation.Valid; import javax.xml.bind.annotation.*; -@ApiModel(description = "Rule configuration for the action. Combined with OR condition.") +@ApiModel(description = "Represents a rule configuration that combines multiple sub-rules with an OR condition. If any of the sub-rules evaluate to true, the ORRule is considered satisfied.") public class ORRule { @@ -76,6 +76,7 @@ public static ConditionEnum fromValue(String value) { /** + * The logical condition for combining the sub-rules. For ORRule, the value must always be \"OR\". **/ public ORRule condition(ConditionEnum condition) { @@ -83,7 +84,7 @@ public ORRule condition(ConditionEnum condition) { return this; } - @ApiModelProperty(value = "") + @ApiModelProperty(value = "The logical condition for combining the sub-rules. For ORRule, the value must always be \"OR\".") @JsonProperty("condition") @Valid public ConditionEnum getCondition() { diff --git a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ORRuleResponse.java b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ORRuleResponse.java index 9f7ee026de..c79cb66c6e 100644 --- a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ORRuleResponse.java +++ b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/gen/java/org/wso2/carbon/identity/api/server/action/management/v1/ORRuleResponse.java @@ -94,6 +94,7 @@ public void setCondition(ConditionEnum condition) { } /** + * A list of sub-rules that are combined using the OR condition. Each sub-rule is an ANDRule. **/ public ORRuleResponse rules(List rules) { @@ -101,7 +102,7 @@ public ORRuleResponse rules(List rules) { return this; } - @ApiModelProperty(value = "") + @ApiModelProperty(value = "A list of sub-rules that are combined using the OR condition. Each sub-rule is an ANDRule.") @JsonProperty("rules") @Valid @Size(min=1) public List getRules() { diff --git a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/main/resources/Actions.yaml b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/main/resources/Actions.yaml index 337a40f0c3..4110b4bfbf 100644 --- a/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/main/resources/Actions.yaml +++ b/components/org.wso2.carbon.identity.api.server.action.management/org.wso2.carbon.identity.api.server.action.management.v1/src/main/resources/Actions.yaml @@ -1,34 +1,33 @@ openapi: 3.0.0 info: - description: > - This document specifies an **Action Management RESTful API** for **WSO2 - Identity Server**. version: v1 title: WSO2 Identity Server - Action Management Rest API - termsOfService: 'http://swagger.io/terms/' - contact: - name: WSO2 - url: 'http://wso2.com/products/identity-server/' - email: architecture@wso2.org - license: - name: Apache 2.0 - url: 'http://www.apache.org/licenses/LICENSE-2.0.html' + description: > + The Action Management REST API provides a comprehensive interface to manage actions + within the WSO2 Identity Server. Actions enable the extension of product functionality + across various workflows, such as access token issuance, password updates, and profile updates. + This API helps developers and administrators to define and manage actions to meet specific + business needs. +servers: + - url: 'https://{server-url}/t/{tenant-domain}/api/server/v1' + variables: + server-url: + default: "localhost:9443" + tenant-domain: + default: carbon.super security: - - OAuth2: [] - BasicAuth: [] + - OAuth2: [] paths: /actions/types: get: tags: - - Actions + - Action Types + summary: List Action Types + description: "This API returns the detailed summary of the action types.\n\n + Scope (Permission) required: ``internal_action_mgt_view``\n\n" operationId: getActionTypes - summary: | - Detailed summary of the Action Types - description: | - This API provides the capability to retrieve the detailed summary of the action types.
- Scope required:
- * internal_action_mgt_view responses: '200': description: OK @@ -36,47 +35,30 @@ paths: application/json: schema: $ref: '#/components/schemas/ActionTypesResponse' - '400': - description: Bad Request - content: - application/json: - schema: - $ref: '#/components/schemas/Error' '401': description: Unauthorized '403': description: Forbidden - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/Error' '500': description: Server Error content: application/json: schema: $ref: '#/components/schemas/Error' - '501': - description: Not Implemented - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + x-codeSamples: + - lang: Curl + source: | + curl --location 'https://localhost:9443/api/server/v1/actions/types' \ + -H 'Authorization: Basic YWRtaW46YWRtaW4=' /actions/{actionType}: post: tags: - Actions - summary: | - Add action + summary: Add Action + description: "This API creates an action and returns the action details along with the action's unique ID.\n\n + Scope (Permission) required: ``internal_action_mgt_create``\n\n" operationId: createAction - description: > - This API provides the capability to store the action information - that is provided by users.
- Scope required:
- * internal_action_mgt_create parameters: - name: actionType in: path @@ -93,11 +75,11 @@ paths: application/json: schema: $ref: '#/components/schemas/ActionModel' - description: This represents the action to be created. + description: This represents the information of the action to be created. required: true responses: '201': - description: Successful response. + description: Action Created content: application/json: schema: @@ -112,12 +94,6 @@ paths: description: Unauthorized '403': description: Forbidden - '409': - description: Conflict - content: - application/json: - schema: - $ref: '#/components/schemas/Error' '500': description: Server Error content: @@ -130,17 +106,35 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' + x-codeSamples: + - lang: Curl + source: | + curl --location 'https://localhost:9443/api/server/v1/actions/{actionType}' \ + -H 'Authorization: Basic YWRtaW46YWRtaW4=' \ + -H 'Content-Type: application/json' \ + -d '{ + "name": "Access Token Pre Issue", + "description": "This is the configuration of pre-action for issuing access token.", + "endpoint": { + "uri": "https://myextension.com/token", + "authentication": { + "properties": { + "username": "auth_username", + "password": "auth_password" + }, + "type": "BASIC" + } + } + }' + x-codegen-request-body-name: body get: tags: - Actions + summary: List Actions + description: "This API returns actions according to the action type. \n\n + Scope (Permission) required: ``internal_action_mgt_view``\n\n" operationId: getActionsByActionType - summary: | - List action - description: | - This API provides the capability to retrieve the action by action type.
- Scope required:
- * internal_action_mgt_view parameters: - name: actionType in: path @@ -187,18 +181,20 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' + x-codeSamples: + - lang: Curl + source: | + curl --location 'https://localhost:9443/api/server/v1/actions/{actionType}' \ + -H 'Authorization: Basic YWRtaW46YWRtaW4=' /actions/{actionType}/{actionId}: get: tags: - Actions operationId: getActionByActionId - summary: | - Retrieve Action information by given Id. - description: | - This API provides the capability to retrieve the action by action Id.
- Scope required:
- * internal_action_mgt_view + summary: Retrieve Action by ID + description: "This API provides the capability to retrieve the action by action Id. \n\n + Scope (Permission) required: ``internal_action_mgt_view``\n\n" parameters: - name: actionType in: path @@ -212,7 +208,7 @@ paths: - preRegistration - name: actionId in: path - description: Id of the Action. + description: Unique identifier of the action. required: true schema: type: string @@ -251,16 +247,18 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' + x-codeSamples: + - lang: Curl + source: | + curl --location 'https://localhost:9443/api/server/v1/actions/{actionType}/{actionId}' \ + -H 'Authorization: Basic YWRtaW46YWRtaW4=' patch: tags: - Actions - summary: | - Update Action information by given Id. + summary: Update Action + description: "This API updates an action and return the updated action. \n\n + Scope (Permission) required: ``internal_action_mgt_update``\n\n" operationId: updateAction - description: | - This API provides the capability to update Action information by given Id.
- Scope required:
- * internal_action_mgt_update parameters: - name: actionType in: path @@ -274,7 +272,7 @@ paths: - preRegistration - name: actionId in: path - description: Id of the Action. + description: Unique identifier of the action. required: true schema: type: string @@ -283,11 +281,11 @@ paths: application/json: schema: $ref: '#/components/schemas/ActionUpdateModel' - description: This represents the action information to be updated. + description: This represents the action to be updated. required: true responses: '200': - description: OK + description: Action Updated content: application/json: schema: @@ -314,17 +312,42 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' + '501': + description: Not Implemented + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + x-codeSamples: + - lang: Curl + source: | + curl --location --request PATCH 'https://localhost:9443/api/server/v1/actions/{actionType}/{actionId}' \ + -H 'Content-Type: application/json' \ + -H 'Accept: application/json' \ + -H 'Authorization: Basic YWRtaW46YWRtaW4=' \ + -d '{ + "name": "Access Token Pre Issue action", + "description": "This is the configuration of pre-action for issuing access token from myextensions.com.", + "endpoint": { + "uri": "http://myextensions.com/access-token", + "authentication": { + "type": "API_KEY", + "properties": { + "header": "sample_header", + "value": "sample_value" + } + } + } + }' + x-codegen-request-body-name: body delete: tags: - Actions - summary: | - Delete action by action type and action id. + summary: Delete Action + description: "This API deletes an action using the action's type and unique ID. \n\n + Scope (Permission) required: ``internal_action_mgt_delete``\n\n" operationId: deleteAction - description: | - This API provides the capability to delete an action by action type.
- Scope required:
- * internal_action_mgt_delete parameters: - name: actionType in: path @@ -338,13 +361,13 @@ paths: - preRegistration - name: actionId in: path - description: Id of the Action. + description: Unique identifier of the action. required: true schema: type: string responses: '204': - description: Successfully Deleted + description: Action Deleted '400': description: Bad Request content: @@ -361,18 +384,26 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' + '501': + description: Not Implemented + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + x-codeSamples: + - lang: Curl + source: | + curl --location --request DELETE 'https://localhost:9443/api/server/v1/actions/{actionType}/{actionId}' \ + -H 'Authorization: Basic YWRtaW46YWRtaW4=' /actions/{actionType}/{actionId}/activate: post: tags: - Actions - summary: | - Activates the action by given Id. + summary: Activate Action + description: "This API activates an action using the action's type and unique ID. \n\n + Scope (Permission) required: ``internal_action_mgt_update``\n\n" operationId: activateAction - description: | - This API provides the capability to activate an action by action Id.
- Scope required:
- * internal_action_mgt_update parameters: - name: actionType in: path @@ -386,13 +417,13 @@ paths: - preRegistration - name: actionId in: path - description: Id of the Action. + description: Unique identifier of the action. required: true schema: type: string responses: '200': - description: OK + description: Action Activated content: application/json: schema: @@ -419,18 +450,26 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' + '501': + description: Not Implemented + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + x-codeSamples: + - lang: Curl + source: | + curl --location --request POST 'https://localhost:9443/api/server/v1/actions/{actionType}/{actionId}/activate' \ + -H 'Authorization: Basic YWRtaW46YWRtaW4=' /actions/{actionType}/{actionId}/deactivate: post: tags: - Actions - summary: | - Deactivates the action by given Id. + summary: Deactivate Action + description: "This API deactivates an action using the action's type and unique ID. \n\n + Scope (Permission) required: ``internal_action_mgt_update``\n\n" operationId: deactivateAction - description: | - This API provides the capability to deactivate an action by action Id.
- Scope required:
- * internal_action_mgt_update parameters: - name: actionType in: path @@ -444,13 +483,13 @@ paths: - preRegistration - name: actionId in: path - description: Id of the Action. + description: Unique identifier of the action. required: true schema: type: string responses: '200': - description: OK + description: Action Deactivated content: application/json: schema: @@ -477,6 +516,17 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' + '501': + description: Not Implemented + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + x-codeSamples: + - lang: Curl + source: | + curl --location --request POST 'https://localhost:9443/api/server/v1/actions/{actionType}/{actionId}/deactivate' \ + -H 'Authorization: Basic YWRtaW46YWRtaW4=' components: securitySchemes: @@ -488,12 +538,17 @@ components: flows: authorizationCode: authorizationUrl: 'https://localhost:9443/oauth2/authorize' - tokenUrl: 'http://localhost:9763/oauth2/token' - scopes: {} + tokenUrl: 'http://localhost:9443/oauth2/token' + scopes: + read: internal_action_mgt_view + write: internal_action_mgt_create + update: internal_action_mgt_update + delete: internal_action_mgt_delete schemas: ActionType: type: string + description: Action types supported. As of now only 'PRE_ISSUE_ACCESS_TOKEN' is implemented. enum: - PRE_ISSUE_ACCESS_TOKEN - PRE_UPDATE_PASSWORD @@ -507,13 +562,15 @@ components: properties: name: type: string - example: Access Token Pre Issue minLength: 1 maxLength: 255 + description: Name of the action. + example: Pre Issue Access Token Action description: type: string - example: This is the configuration of pre-action for issuing access token. maxLength: 255 + description: Description of the action. + example: This action invokes before issuing an access token. endpoint: $ref: '#/components/schemas/Endpoint' rule: @@ -521,27 +578,31 @@ components: Endpoint: type: object + description: Endpoint configurations of the action. required: - uri - authentication properties: uri: type: string - example: https://abc.com/token + description: HTTPS URI of the endpoint. pattern: '^https?://.+' + example: https://myextension.com/token authentication: $ref: '#/components/schemas/AuthenticationType' EndpointResponse: type: object + description: Endpoint configurations of the action. required: - uri - authentication properties: uri: type: string - example: https://abc.com/token + description: HTTPS URI of the endpoint. pattern: '^https?://.+' + example: https://myextension.com/token authentication: $ref: '#/components/schemas/AuthenticationTypeResponse' @@ -551,22 +612,27 @@ components: id: type: string example: '24f64d17-9824-4e28-8413-de45728d8e84' + description: Unique identifier of the action. type: $ref: '#/components/schemas/ActionType' name: type: string - example: Access Token Pre Issue minLength: 1 maxLength: 255 + description: Name of the action. + example: Access Token Pre Issue description: type: string - example: This is the configuration of pre-action for issuing access token. maxLength: 255 + description: Description of the action. + example: This action invokes before issuing an access token. status: type: string enum: - ACTIVE - INACTIVE + description: Status of the action. + example: ACTIVE endpoint: $ref: '#/components/schemas/EndpointResponse' rule: @@ -578,22 +644,26 @@ components: id: type: string example: '24f64d17-9824-4e28-8413-de45728d8e84' + description: Unique identifier of the action. type: $ref: '#/components/schemas/ActionType' name: type: string - example: Access Token Pre Issue minLength: 1 maxLength: 255 + description: Name of the action. + example: Access Token Pre Issue description: type: string - example: This is the configuration of pre-action for issuing access token. maxLength: 255 + description: Description of the action. + example: This action invokes before issuing an access token. status: type: string enum: - ACTIVE - INACTIVE + description: Status of the action. links: type: array items: @@ -635,22 +705,58 @@ components: $ref: '#/components/schemas/ActionType' displayName: type: string + description: "Display name of the action type." example: "Pre Issue Access Token." description: type: string + description: "Description of the action type." example: "Extension point configuration for Pre Issue Access Token." count: type: integer - example: 2 + description: "Number of actions configured under the action type." + example: 1 self: type: string + description: "API endpoint referring to the location of the given action type." example: "/t/wso2.com/api/server/v1/actions/preIssueAccessToken" AuthenticationType: type: object + description: > + The type of authentication required by the action's endpoint. The following options are supported: + + - NONE: No authentication is required.
+ ``{ + "type": "NONE" + }`` + + - BASIC: Basic authentication with a username and password.
+ ``{ + "type": "BASIC", + "properties": { + "username": "auth_username", + "password": "auth_password" + } + }`` + + - API_KEY: API key-based authentication, where the key is provided in an HTTP header.
+ ``{ + "type": "API_KEY", + "properties": { + "header": "X-API-Key", + "value": "12345-abcde-67890" + } + }`` + + - BEARER: Bearer token-based authentication.
+ ``{ + "type": "BEARER", + "properties": { + "accessToken": "0d6fed02-eac0-332b-8998-213a543139a0" + } + }`` required: - type - - properties properties: type: type: string @@ -662,13 +768,17 @@ components: example: BASIC properties: type: object + description: Authentication properties specific to the selected type. additionalProperties: true - example: - username: "auth_username" - password: "auth_password" + example: + type: BASIC + properties: + username: "auth_username" + password: "auth_password" AuthenticationTypeResponse: type: object + description: Authentication configurations of the action. required: - type properties: @@ -679,6 +789,7 @@ components: - BEARER - API_KEY - BASIC + description: Type of the authentication. example: BASIC ActionUpdateModel: @@ -686,13 +797,15 @@ components: properties: name: type: string - example: Access Token Pre Issue minLength: 1 maxLength: 255 + description: Updating name of the action. + example: Pre Issue Access Token Action description: type: string - example: This is the configuration of pre-action for issuing access token. maxLength: 255 + description: Updating description of the action. + example: This action invokes before issuing an access token. endpoint: $ref: '#/components/schemas/EndpointUpdateModel' rule: @@ -700,20 +813,26 @@ components: EndpointUpdateModel: type: object + description: Updating endpoint configurations of the action. properties: uri: type: string - example: https://abc.com/token pattern: '^https?://.+' + description: Updating HTTPS URI of the endpoint. + example: https://myextension.com/token + authentication: $ref: '#/components/schemas/AuthenticationType' ORRule: type: object - description: Rule configuration for the action. Combined with OR condition. + description: Represents a rule configuration that combines multiple sub-rules with an OR condition. + If any of the sub-rules evaluate to true, the ORRule is considered satisfied. properties: condition: type: string + description: The logical condition for combining the sub-rules. For ORRule, the value + must always be "OR". enum: ["OR"] rules: type: array @@ -732,11 +851,12 @@ components: type: array items: $ref: '#/components/schemas/ANDRuleResponse' + description: A list of sub-rules that are combined using the OR condition. Each sub-rule is an ANDRule. minItems: 1 ANDRule: type: object - description: Expressions combined with AND condition. + description: A sub-rule that combines expressions with AND condition. required: - condition - expressions @@ -744,28 +864,32 @@ components: condition: type: string enum: ["AND"] + description: The logical condition for combining the expressions. For ANDRule, the value must always be "AND". expressions: type: array items: $ref: '#/components/schemas/Expression' minItems: 1 + description: A list of expressions that are combined using the AND condition. All expressions must evaluate to true for the ANDRule to pass. ANDRuleResponse: type: object - description: Expressions combined with AND condition. + description: Represents a rule configuration that combines multiple expressions with an AND condition. All expressions in the ANDRule must evaluate to true for the rule to be satisfied. properties: condition: type: string enum: ["AND"] + description: The logical condition for combining the expressions. For ANDRule, the value must always be "AND". expressions: type: array items: $ref: '#/components/schemas/ExpressionResponse' minItems: 1 + description: A list of expressions that are combined using the AND condition. All expressions must evaluate to true for the ANDRule to pass. Expression: type: object - description: Expressions in the rule. + description: Represents a single logical condition or comparison within a rule. An expression defines a field, an operator, and a value that is evaluated. required: - field - operator @@ -773,12 +897,15 @@ components: properties: field: type: string + description: The field or attribute of the entity being evaluated (e.g.,application, role). example: application operator: type: string + description: The comparison operator used to evaluate the field and value. Common operators include "equals", "contains", "startsWith", etc. example: equals value: type: string + description: The value that the field is compared against based on the operator. example: myapp ExpressionResponse: @@ -810,11 +937,3 @@ components: traceId: type: string example: e0fbcfeb-3617-43c4-8dd0-7b7d38e13047 - -servers: - - url: 'https://{server-url}/t/{tenant-domain}/api/server/v1' - variables: - tenant-domain: - default: "carbon.super" - server-url: - default: "localhost:9443"