PermissionApi

All URIs are relative to http://localhost

Method	HTTP request	Description
permissionsCheck	POST /v1/tenants/{tenant_id}/permissions/check	check api
permissionsExpand	POST /v1/tenants/{tenant_id}/permissions/expand	expand api
permissionsLookupEntity	POST /v1/tenants/{tenant_id}/permissions/lookup-entity	lookup entity
permissionsLookupEntityStream	POST /v1/tenants/{tenant_id}/permissions/lookup-entity-stream	lookup entity stream
permissionsLookupSubject	POST /v1/tenants/{tenant_id}/permissions/lookup-subject	lookup-subject
permissionsSubjectPermission	POST /v1/tenants/{tenant_id}/permissions/subject-permission	subject permission

permissionsCheck

PermissionCheckResponse permissionsCheck(tenantId, body)

check api

Example

// Import classes:
import org.permify.ApiClient;
import org.permify.ApiException;
import org.permify.Configuration;
import org.permify.models.*;
import org.permify.api.PermissionApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");

        PermissionApi apiInstance = new PermissionApi(defaultClient);
        String tenantId = "tenantId_example"; // String | Identifier of the tenant, if you are not using multi-tenancy (have only one tenant) use pre-inserted tenant <code>t1</code> for this field. Required, and must match the pattern \\“[a-zA-Z0-9-,]+\\“, max 64 bytes.
        PermissionsCheckRequest body = new PermissionsCheckRequest(); // PermissionsCheckRequest | 
        try {
            PermissionCheckResponse result = apiInstance.permissionsCheck(tenantId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermissionApi#permissionsCheck");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
tenantId	String	Identifier of the tenant, if you are not using multi-tenancy (have only one tenant) use pre-inserted tenant <code>t1</code> for this field. Required, and must match the pattern \“[a-zA-Z0-9-,]+\“, max 64 bytes.
body	PermissionsCheckRequest

Return type

PermissionCheckResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

permissionsExpand

PermissionExpandResponse permissionsExpand(tenantId, body)

expand api

Example

// Import classes:
import org.permify.ApiClient;
import org.permify.ApiException;
import org.permify.Configuration;
import org.permify.models.*;
import org.permify.api.PermissionApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");

        PermissionApi apiInstance = new PermissionApi(defaultClient);
        String tenantId = "tenantId_example"; // String | Identifier of the tenant, if you are not using multi-tenancy (have only one tenant) use pre-inserted tenant <code>t1</code> for this field. Required, and must match the pattern \\“[a-zA-Z0-9-,]+\\“, max 64 bytes.
        PermissionsExpandRequest body = new PermissionsExpandRequest(); // PermissionsExpandRequest | 
        try {
            PermissionExpandResponse result = apiInstance.permissionsExpand(tenantId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermissionApi#permissionsExpand");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
tenantId	String	Identifier of the tenant, if you are not using multi-tenancy (have only one tenant) use pre-inserted tenant <code>t1</code> for this field. Required, and must match the pattern \“[a-zA-Z0-9-,]+\“, max 64 bytes.
body	PermissionsExpandRequest

Return type

PermissionExpandResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

permissionsLookupEntity

PermissionLookupEntityResponse permissionsLookupEntity(tenantId, body)

lookup entity

Example

// Import classes:
import org.permify.ApiClient;
import org.permify.ApiException;
import org.permify.Configuration;
import org.permify.models.*;
import org.permify.api.PermissionApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");

        PermissionApi apiInstance = new PermissionApi(defaultClient);
        String tenantId = "tenantId_example"; // String | Identifier of the tenant, if you are not using multi-tenancy (have only one tenant) use pre-inserted tenant <code>t1</code> for this field. Required, and must match the pattern \\“[a-zA-Z0-9-,]+\\“, max 64 bytes.
        PermissionsLookupEntityRequest body = new PermissionsLookupEntityRequest(); // PermissionsLookupEntityRequest | 
        try {
            PermissionLookupEntityResponse result = apiInstance.permissionsLookupEntity(tenantId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermissionApi#permissionsLookupEntity");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
tenantId	String	Identifier of the tenant, if you are not using multi-tenancy (have only one tenant) use pre-inserted tenant <code>t1</code> for this field. Required, and must match the pattern \“[a-zA-Z0-9-,]+\“, max 64 bytes.
body	PermissionsLookupEntityRequest

Return type

PermissionLookupEntityResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

permissionsLookupEntityStream

StreamResultOfPermissionLookupEntityStreamResponse permissionsLookupEntityStream(tenantId, body)

lookup entity stream

Example

// Import classes:
import org.permify.ApiClient;
import org.permify.ApiException;
import org.permify.Configuration;
import org.permify.models.*;
import org.permify.api.PermissionApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");

        PermissionApi apiInstance = new PermissionApi(defaultClient);
        String tenantId = "tenantId_example"; // String | Identifier of the tenant, if you are not using multi-tenancy (have only one tenant) use pre-inserted tenant <code>t1</code> for this field. Required, and must match the pattern \\“[a-zA-Z0-9-,]+\\“, max 64 bytes.
        PermissionsLookupEntityRequest body = new PermissionsLookupEntityRequest(); // PermissionsLookupEntityRequest | 
        try {
            StreamResultOfPermissionLookupEntityStreamResponse result = apiInstance.permissionsLookupEntityStream(tenantId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermissionApi#permissionsLookupEntityStream");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
tenantId	String	Identifier of the tenant, if you are not using multi-tenancy (have only one tenant) use pre-inserted tenant <code>t1</code> for this field. Required, and must match the pattern \“[a-zA-Z0-9-,]+\“, max 64 bytes.
body	PermissionsLookupEntityRequest

Return type

StreamResultOfPermissionLookupEntityStreamResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.(streaming responses)	-
0	An unexpected error response.	-

permissionsLookupSubject

PermissionLookupSubjectResponse permissionsLookupSubject(tenantId, body)

lookup-subject

Example

// Import classes:
import org.permify.ApiClient;
import org.permify.ApiException;
import org.permify.Configuration;
import org.permify.models.*;
import org.permify.api.PermissionApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");

        PermissionApi apiInstance = new PermissionApi(defaultClient);
        String tenantId = "tenantId_example"; // String | Identifier of the tenant, if you are not using multi-tenancy (have only one tenant) use pre-inserted tenant <code>t1</code> for this field. Required, and must match the pattern \\“[a-zA-Z0-9-,]+\\“, max 64 bytes.
        PermissionsLookupSubjectRequest body = new PermissionsLookupSubjectRequest(); // PermissionsLookupSubjectRequest | 
        try {
            PermissionLookupSubjectResponse result = apiInstance.permissionsLookupSubject(tenantId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermissionApi#permissionsLookupSubject");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
tenantId	String	Identifier of the tenant, if you are not using multi-tenancy (have only one tenant) use pre-inserted tenant <code>t1</code> for this field. Required, and must match the pattern \“[a-zA-Z0-9-,]+\“, max 64 bytes.
body	PermissionsLookupSubjectRequest

Return type

PermissionLookupSubjectResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

permissionsSubjectPermission

PermissionSubjectPermissionResponse permissionsSubjectPermission(tenantId, body)

subject permission

Example

// Import classes:
import org.permify.ApiClient;
import org.permify.ApiException;
import org.permify.Configuration;
import org.permify.models.*;
import org.permify.api.PermissionApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");

        PermissionApi apiInstance = new PermissionApi(defaultClient);
        String tenantId = "tenantId_example"; // String | Identifier of the tenant, if you are not using multi-tenancy (have only one tenant) use pre-inserted tenant <code>t1</code> for this field. Required, and must match the pattern \\“[a-zA-Z0-9-,]+\\“, max 64 bytes.
        PermissionsSubjectPermissionRequest body = new PermissionsSubjectPermissionRequest(); // PermissionsSubjectPermissionRequest | 
        try {
            PermissionSubjectPermissionResponse result = apiInstance.permissionsSubjectPermission(tenantId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermissionApi#permissionsSubjectPermission");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
tenantId	String	Identifier of the tenant, if you are not using multi-tenancy (have only one tenant) use pre-inserted tenant <code>t1</code> for this field. Required, and must match the pattern \“[a-zA-Z0-9-,]+\“, max 64 bytes.
body	PermissionsSubjectPermissionRequest

Return type

PermissionSubjectPermissionResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

Files

PermissionApi.md

Latest commit

History

PermissionApi.md

File metadata and controls

PermissionApi

permissionsCheck

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

permissionsExpand

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

permissionsLookupEntity

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

permissionsLookupEntityStream

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

permissionsLookupSubject

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

permissionsSubjectPermission

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details