-
Notifications
You must be signed in to change notification settings - Fork 805
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Naduni Pamudika
committed
Feb 13, 2025
1 parent
7e92f6e
commit c93bbee
Showing
6 changed files
with
415 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
179 changes: 179 additions & 0 deletions
179
...src/gen/java/org/wso2/am/integration/clients/admin/api/dto/EnvironmentPermissionsDTO.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| /* | ||
| * WSO2 API Manager - Admin | ||
| * This document specifies a **RESTful API** for WSO2 **API Manager** - **Admin Portal**. Please see [full OpenAPI Specification](https://raw.githubusercontent.com/wso2/carbon-apimgt/v6.7.206/components/apimgt/org.wso2.carbon.apimgt.rest.api.admin.v1/src/main/resources/admin-api.yaml) of the API which is written using [OAS 3.0](http://swagger.io/) specification. # Authentication Our REST APIs are protected using OAuth2 and access control is achieved through scopes. Before you start invoking the the API you need to obtain an access token with the required scopes. This guide will walk you through the steps that you will need to follow to obtain an access token. First you need to obtain the consumer key/secret key pair by calling the dynamic client registration (DCR) endpoint. You can add your preferred grant types in the payload. A sample payload is shown below. ``` { \"callbackUrl\":\"www.google.lk\", \"clientName\":\"rest_api_admin\", \"owner\":\"admin\", \"grantType\":\"client_credentials password refresh_token\", \"saasApp\":true } ``` Create a file (payload.json) with the above sample payload, and use the cURL shown bellow to invoke the DCR endpoint. Authorization header of this should contain the base64 encoded admin username and password. **Format of the request** ``` curl -X POST -H \"Authorization: Basic Base64(admin_username:admin_password)\" -H \"Content-Type: application/json\" \\ -d @payload.json https://<host>:<servlet_port>/client-registration/v0.17/register ``` **Sample request** ``` curl -X POST -H \"Authorization: Basic YWRtaW46YWRtaW4=\" -H \"Content-Type: application/json\" \\ -d @payload.json https://localhost:9443/client-registration/v0.17/register ``` Following is a sample response after invoking the above curl. ``` { \"clientId\": \"fOCi4vNJ59PpHucC2CAYfYuADdMa\", \"clientName\": \"rest_api_admin\", \"callBackURL\": \"www.google.lk\", \"clientSecret\": \"a4FwHlq0iCIKVs2MPIIDnepZnYMa\", \"isSaasApplication\": true, \"appOwner\": \"admin\", \"jsonString\": \"{\\\"grant_types\\\":\\\"client_credentials password refresh_token\\\",\\\"redirect_uris\\\":\\\"www.google.lk\\\",\\\"client_name\\\":\\\"rest_api_admin\\\"}\", \"jsonAppAttribute\": \"{}\", \"tokenType\": null } ``` Next you must use the above client id and secret to obtain the access token. We will be using the password grant type for this, you can use any grant type you desire. You also need to add the proper **scope** when getting the access token. All possible scopes for Admin REST API can be viewed in **OAuth2 Security** section of this document and scope for each resource is given in **authorizations** section of resource documentation. Following is the format of the request if you are using the password grant type. ``` curl -k -d \"grant_type=password&username=<admin_username>&password=<admin_passowrd>&scope=<scopes seperated by space>\" \\ -H \"Authorization: Basic base64(cliet_id:client_secret)\" \\ https://<host>:<gateway_port>/token ``` **Sample request** ``` curl https://localhost:8243/token -k \\ -H \"Authorization: Basic Zk9DaTR2Tko1OVBwSHVjQzJDQVlmWXVBRGRNYTphNEZ3SGxxMGlDSUtWczJNUElJRG5lcFpuWU1h\" \\ -d \"grant_type=password&username=admin&password=admin&scope=apim:admin apim:tier_view\" ``` Shown below is a sample response to the above request. ``` { \"access_token\": \"e79bda48-3406-3178-acce-f6e4dbdcbb12\", \"refresh_token\": \"a757795d-e69f-38b8-bd85-9aded677a97c\", \"scope\": \"apim:admin apim:tier_view\", \"token_type\": \"Bearer\", \"expires_in\": 3600 } ``` Now you have a valid access token, which you can use to invoke an API. Navigate through the API descriptions to find the required API, obtain an access token as described above and invoke the API with the authentication header. If you use a different authentication mechanism, this process may change. # Try out in Postman If you want to try-out the embedded postman collection with \"Run in Postman\" option, please follow the guidelines listed below. * All of the OAuth2 secured endpoints have been configured with an Authorization Bearer header with a parameterized access token. Before invoking any REST API resource make sure you run the `Register DCR Application` and `Generate Access Token` requests to fetch an access token with all required scopes. * Make sure you have an API Manager instance up and running. * Update the `basepath` parameter to match the hostname and port of the APIM instance. [](https://app.getpostman.com/run-collection/f5ac2ca9fb22afef6ed6) | ||
| * | ||
| * The version of the OpenAPI document: v4 | ||
| * Contact: [email protected] | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
|
|
||
|
|
||
| package org.wso2.am.integration.clients.admin.api.dto; | ||
|
|
||
| import java.util.Objects; | ||
| import java.util.Arrays; | ||
| import com.google.gson.TypeAdapter; | ||
| import com.google.gson.annotations.JsonAdapter; | ||
| import com.google.gson.annotations.SerializedName; | ||
| import com.google.gson.stream.JsonReader; | ||
| import com.google.gson.stream.JsonWriter; | ||
| import io.swagger.annotations.ApiModel; | ||
| import io.swagger.annotations.ApiModelProperty; | ||
| import java.io.IOException; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import com.fasterxml.jackson.annotation.JsonCreator; | ||
| /** | ||
| * EnvironmentPermissionsDTO | ||
| */ | ||
|
|
||
| public class EnvironmentPermissionsDTO { | ||
| /** | ||
| * Gets or Sets permissionType | ||
| */ | ||
| @JsonAdapter(PermissionTypeEnum.Adapter.class) | ||
| public enum PermissionTypeEnum { | ||
| PUBLIC("PUBLIC"), | ||
|
|
||
| ALLOW("ALLOW"), | ||
|
|
||
| DENY("DENY"); | ||
|
|
||
| private String value; | ||
|
|
||
| PermissionTypeEnum(String value) { | ||
| this.value = value; | ||
| } | ||
|
|
||
| public String getValue() { | ||
| return value; | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return String.valueOf(value); | ||
| } | ||
|
|
||
| public static PermissionTypeEnum fromValue(String value) { | ||
| for (PermissionTypeEnum b : PermissionTypeEnum.values()) { | ||
| if (b.name().equals(value)) { | ||
| return b; | ||
| } | ||
| } | ||
| throw new IllegalArgumentException("Unexpected value '" + value + "'"); | ||
| } | ||
|
|
||
| public static class Adapter extends TypeAdapter<PermissionTypeEnum> { | ||
| @Override | ||
| public void write(final JsonWriter jsonWriter, final PermissionTypeEnum enumeration) throws IOException { | ||
| jsonWriter.value(enumeration.getValue()); | ||
| } | ||
|
|
||
| @Override | ||
| public PermissionTypeEnum read(final JsonReader jsonReader) throws IOException { | ||
| String value = jsonReader.nextString(); | ||
| return PermissionTypeEnum.fromValue(value); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public static final String SERIALIZED_NAME_PERMISSION_TYPE = "permissionType"; | ||
| @SerializedName(SERIALIZED_NAME_PERMISSION_TYPE) | ||
| private PermissionTypeEnum permissionType = PermissionTypeEnum.PUBLIC; | ||
|
|
||
| public static final String SERIALIZED_NAME_ROLES = "roles"; | ||
| @SerializedName(SERIALIZED_NAME_ROLES) | ||
| private List<String> roles = null; | ||
|
|
||
|
|
||
| public EnvironmentPermissionsDTO permissionType(PermissionTypeEnum permissionType) { | ||
|
|
||
| this.permissionType = permissionType; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Get permissionType | ||
| * @return permissionType | ||
| **/ | ||
| @javax.annotation.Nullable | ||
| @ApiModelProperty(example = "ALLOW", value = "") | ||
|
|
||
| public PermissionTypeEnum getPermissionType() { | ||
| return permissionType; | ||
| } | ||
|
|
||
|
|
||
| public void setPermissionType(PermissionTypeEnum permissionType) { | ||
| this.permissionType = permissionType; | ||
| } | ||
|
|
||
|
|
||
| public EnvironmentPermissionsDTO roles(List<String> roles) { | ||
|
|
||
| this.roles = roles; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Get roles | ||
| * @return roles | ||
| **/ | ||
| @javax.annotation.Nullable | ||
| @ApiModelProperty(example = "[\"Subscriber\",\"Internal/subscriber\"]", value = "") | ||
|
|
||
| public List<String> getRoles() { | ||
| return roles; | ||
| } | ||
|
|
||
|
|
||
| public void setRoles(List<String> roles) { | ||
| this.roles = roles; | ||
| } | ||
|
|
||
|
|
||
| @Override | ||
| public boolean equals(Object o) { | ||
| if (this == o) { | ||
| return true; | ||
| } | ||
| if (o == null || getClass() != o.getClass()) { | ||
| return false; | ||
| } | ||
| EnvironmentPermissionsDTO environmentPermissions = (EnvironmentPermissionsDTO) o; | ||
| return Objects.equals(this.permissionType, environmentPermissions.permissionType) && | ||
| Objects.equals(this.roles, environmentPermissions.roles); | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(permissionType, roles); | ||
| } | ||
|
|
||
|
|
||
| @Override | ||
| public String toString() { | ||
| StringBuilder sb = new StringBuilder(); | ||
| sb.append("class EnvironmentPermissionsDTO {\n"); | ||
| sb.append(" permissionType: ").append(toIndentedString(permissionType)).append("\n"); | ||
| sb.append(" roles: ").append(toIndentedString(roles)).append("\n"); | ||
| sb.append("}"); | ||
| return sb.toString(); | ||
| } | ||
|
|
||
| /** | ||
| * Convert the given object to string with each line indented by 4 spaces | ||
| * (except the first line). | ||
| */ | ||
| private String toIndentedString(Object o) { | ||
| if (o == null) { | ||
| return "null"; | ||
| } | ||
| return o.toString().replace("\n", "\n "); | ||
| } | ||
|
|
||
| } | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.