Role-Based Access Control

pip3 install descope

go get github.com/descope/go-sdk

// Include the following in your `pom.xml` (for Maven)
<dependency>
    <artifactId>java-sdk</artifactId>
    <groupId>com.descope</groupId>
    <version>sdk-version</version> // Check https://github.com/descope/descope-java/releases for the latest versions
</dependency>

gem install descope

from descope import (
    REFRESH_SESSION_TOKEN_NAME,
    SESSION_TOKEN_NAME,
    AuthException,
    DeliveryMethod,
    DescopeClient,
    AssociatedTenant,
    RoleMapping,
    AttributeMapping
)

management_key = "xxxx"

try:
    # You can configure the baseURL by setting the env variable Ex: export DESCOPE_BASE_URI="https://auth.company.com  - this is useful when you utilize CNAME within your Descope project."
    descope_client = DescopeClient(project_id='__ProjectID__', management_key=management_key)
except Exception as error:
    # handle the error
    print ("failed to initialize. Error:")
    print (error)

import "github.com/descope/go-sdk/descope"
import "github.com/descope/go-sdk/descope/client"
import "fmt"

// Utilizing the context package allows for the transmission of context capabilities like cancellation
//      signals during the function call. In cases where context is absent, the context.Background()
//      function serves as a viable alternative.
//      Utilizing context within the Descope GO SDK is supported within versions 1.6.0 and higher.
import (
	"context"
)

managementKey = "xxxx"

// DescopeBaseURL // within the client.Config, you can also configure the baseUrl ex: https://auth.company.com  - this is useful when you utilize CNAME within your Descope project.
descopeClient, err := client.NewWithConfig(&client.Config{ProjectID:"__ProjectID__", managementKey:managementKey})
if err != nil {
    // handle the error
    log.Println("failed to initialize: " + err.Error())
}

import com.descope.client;

// Initialized after setting the DESCOPE_PROJECT_ID env var (and optionally DESCOPE_MANAGEMENT_KEY)
var descopeClient = new DescopeClient();

// ** Or directly **
var descopeClient = new DescopeClient(Config.builder()
        .projectId("__ProjectID__")
        .managementKey("management-key")
        .build());

require 'descope'


descope_client = Descope::Client.new(
  {
    project_id: '__ProjectID__',
    management_key: 'management_key'
  }
)

try:
  resp = descope_client.mgmt.permission.load_all()
  print("Successfully loaded permissions.")
  print(json.dumps(resp, indent=4))
except AuthException as error:
  print ("Unable to load permissions.")
  print ("Status Code: " + str(error.status_code))
  print ("Error: " + str(error.error_message))

// Args:
//    ctx: context.Context - Application context for the transmission of context capabilities like
//        cancellation signals during the function call. In cases where context is absent, the context.Background()
//        function serves as a viable alternative.
//        Utilizing context within the Descope GO SDK is supported within versions 1.6.0 and higher.
ctx := context.Background()

res, err := descopeClient.Management.Permission().LoadAll(ctx)
if  (err != nil){
  fmt.Println("Unable to load permissions.", err)
} else {
  fmt.Println("Successfully loaded permissions.")
  for _, permission := range res {
    fmt.Println(permission)
  }
}

// You can optionally set a description for a permission.
PermissionService ps = descopeClient.getManagementServices().getPermissionService();

// Load all permissions
try {
    PermissionResponse resp = ps.loadAll();
    for (Permission p : resp.getPermissions()) {
        // Do something
    }
} catch (DescopeException de) {
    // Handle the error
}

# Args:
#   name (str): permission name.
name = "Test Permission"
#   description (str): Optional description to briefly explain what this permission allows.
description = "My description"

try:
  descope_client.mgmt.permission.create(name=name,description=description)
  print("Successfully created permission")
except AuthException as error:
  print ("Unable to create permission.")
  print ("Status Code: " + str(error.status_code))
  print ("Error: " + str(error.error_message))

// Args:
//    ctx: context.Context - Application context for the transmission of context capabilities like
//        cancellation signals during the function call. In cases where context is absent, the context.Background()
//        function serves as a viable alternative.
//        Utilizing context within the Descope GO SDK is supported within versions 1.6.0 and higher.
ctx := context.Background()
// 		name (str): permission name.
name := "Test Permission"
// 		description (str): Optional description to briefly explain what this permission allows.
description := "My description"

err := descopeClient.Management.Permission().Create(ctx, name, description)
if  (err != nil){
  fmt.Println("Unable to create permission.", err)
} else {
  fmt.Println("Successfully created permission")
}

// You can optionally set a description for a permission.
PermissionService ps = descopeClient.getManagementServices().getPermissionService();

String name = "My Permission";
String description = "Optional description to briefly explain what this permission allows.";

try {
    ps.create(name, description);
} catch (DescopeException de) {
    // Handle the error
}

# Args:
#   name (str): permission name.
name = "Test Permission"
#   new_name (str): permission updated name.
new_name = "Updated Test Permission"
#   description (str): Optional description to briefly explain what this permission allows.
description = "My updated description"

try:
  descope_client.mgmt.permission.update(name=name, new_name=new_name, description=description)
  print("Successfully updated permission")
except AuthException as error:
  print ("Unable to update permission.")
  print ("Status Code: " + str(error.status_code))
  print ("Error: " + str(error.error_message))

// Args:
//    ctx: context.Context - Application context for the transmission of context capabilities like
//        cancellation signals during the function call. In cases where context is absent, the context.Background()
//        function serves as a viable alternative.
//        Utilizing context within the Descope GO SDK is supported within versions 1.6.0 and higher.
ctx := context.Background()
// 		name (str): permission name.
name := "Test Permission"
// 		newName (str): permission updated name.
newName := "Updated Test Permission"
// 		description (str): Optional description to briefly explain what this permission allows.
description := "My updated description"

err := descopeClient.Management.Permission().Update(ctx, name, newName, description)
if  (err != nil){
  fmt.Println("Unable to update permission.", err)
} else {
  fmt.Println("Successfully updated permission")
}

// You can optionally set a description for a permission.
PermissionService ps = descopeClient.getManagementServices().getPermissionService();

// Update will override all fields as is. Use carefully.
String newName = "My Updated Permission";
description = "A revised description";

try {
    ps.update(name, newName, description);
} catch (DescopeException de) {
    // Handle the error
}

# Args:
#   name (str): The name of the permission to be deleted.
name = "Updated Test Permission"

# Permission deletion cannot be undone. Use carefully.
try:
  descope_client.mgmt.permission.delete(name=name)
  print("Successfully deleted permission")
except AuthException as error:
  print ("Unable to delete permission.")
  print ("Status Code: " + str(error.status_code))
  print ("Error: " + str(error.error_message))

// Args:
//    ctx: context.Context - Application context for the transmission of context capabilities like
//        cancellation signals during the function call. In cases where context is absent, the context.Background()
//        function serves as a viable alternative.
//        Utilizing context within the Descope GO SDK is supported within versions 1.6.0 and higher.
ctx := context.Background()
// 		name (str): The name of the permission to be deleted.
name := "Updated Test Permission"

// Permission deletion cannot be undone. Use carefully.
err := descopeClient.Management.Permission().Delete(ctx, name)
if  (err != nil){
  fmt.Println("Unable to delete permission.", err)
} else {
  fmt.Println("Successfully deleted permission")
}

// You can optionally set a description for a permission.
PermissionService ps = descopeClient.getManagementServices().getPermissionService();

// Permission deletion cannot be undone. Use carefully.
try {
    ps.delete(newName);
} catch (DescopeException de) {
    // Handle the error
}

try:
  resp = roles_resp = descope_client.mgmt.role.load_all()
  print("Successfully loaded roles.")
  print(json.dumps(resp, indent=4))
except AuthException as error:
  print ("Unable to load roles.")
  print ("Status Code: " + str(error.status_code))
  print ("Error: " + str(error.error_message))

// Args:
//    ctx: context.Context - Application context for the transmission of context capabilities like
//        cancellation signals during the function call. In cases where context is absent, the context.Background()
//        function serves as a viable alternative.
//        Utilizing context within the Descope GO SDK is supported within versions 1.6.0 and higher.
ctx := context.Background()

res, err := descopeClient.Management.Role().LoadAll(ctx)
if  (err != nil){
  fmt.Println("Unable to load roles.", err)
} else {
  fmt.Println("Successfully loaded roles.")
  for _, role := range res {
    fmt.Println(role)
  }
}

// You can optionally set a description and associated permission for a roles.
RolesService rs = descopeClient.getManagementServices().getRolesService();

// Load all roles
try {
    RoleResponse resp = rs.loadAll();
    for (Role r : resp.getRoles()) {
        // Do something
    }
} catch (DescopeException de) {
    // Handle the error
}

# Args:
#   name (str): role name.
name = "My Test Role"
#   description (str): Optional description to briefly explain what this role allows.
description = "My Role Description"
#   permission_names (List[str]): Optional list of names of permissions this role grants.
permission_names = ["TestPermission"]
#   tenant_id (str): Optional Tenant ID to assign new role to specific tenant
tenant_id = "Tenant ID"

try:
  descope_client.mgmt.role.create(name=name, description=description, permission_names=permission_names, tenant_id=tenant_id)
  print("Successfully created role.")
except AuthException as error:
  print ("Unable to create role.")
  print ("Status Code: " + str(error.status_code))
  print ("Error: " + str(error.error_message))

// Args:
//    ctx: context.Context - Application context for the transmission of context capabilities like
//        cancellation signals during the function call. In cases where context is absent, the context.Background()
//        function serves as a viable alternative.
//        Utilizing context within the Descope GO SDK is supported within versions 1.6.0 and higher.
ctx := context.Background()
//    name (str): role name.
name := "My Test Role"
// description (str): Optional description to briefly explain what this role allows.
description := "My Role Description"
// permissionNames (List[str]): Optional list of names of permissions this role grants.
permissionNames := []string{"TestPermission"}
//    tenantId (str): Optional Tenant ID to assign new role to specific tenant
tenantID := "Tenant ID"

err := descopeClient.Management.Role().Create(ctx, name, description, permissionNames, tenantID)
if  (err != nil){
  fmt.Println("Unable to create role.", err)
} else {
  fmt.Println("Successfully created role.")
}

// You can optionally set a description and associated permission for a roles.
RolesService rs = descopeClient.getManagementServices().getRolesService();

String name = "My Role";
String description = "Optional description to briefly explain what this role allows.";
List<String> permissionNames = Arrays.asList("My Updated Permission");
// Pending release of Optional Tenant ID

try {
    rs.create(name, description, permissionNames);
} catch (DescopeException de) {
    // Handle the error
}

# Args:
#   name (str): role name.
name = "My Test Role"
#   new_name (str): role updated name.
new_name = "My Updated Test Role"
#   description (str): Optional description to briefly explain what this role allows.
description = "My Updated Role Description"
#   permission_names (List[str]): Optional list of names of permissions this role grants.
permission_names = ["TestPermission", "TestPermission2"]
#   tenant_id (str): Optional Tenant ID to assign new role to specific tenant
tenant_id = "Tenant ID"

# Update will override all fields as is. Use carefully.
try:
  descope_client.mgmt.role.update(name=name, new_name=new_name, description=description, permission_names=permission_names, tenant_id=tenant_id)
  print("Successfully updated role.")
except AuthException as error:
  print ("Unable to update role.")
  print ("Status Code: " + str(error.status_code))
  print ("Error: " + str(error.error_message))

// Args:
//    ctx: context.Context - Application context for the transmission of context capabilities like
//        cancellation signals during the function call. In cases where context is absent, the context.Background()
//        function serves as a viable alternative.
//        Utilizing context within the Descope GO SDK is supported within versions 1.6.0 and higher.
ctx := context.Background()
//    name (str): role name.
name := "My Test Role"
//    newName (str): role updated name.
newName := "My Updated Test Role"
//    description (str): Optional description to briefly explain what this role allows.
description := "My Updated Role Description"
//    permissionNames (List[str]): Optional list of names of permissions this role grants.
permissionNames := []string{"TestPermission", "TestPermission2"}
//    tenantId (str): Optional Tenant ID to assign new role to specific tenant
tenantID := "Tenant ID"

// Update will override all fields as is. Use carefully.
err := descopeClient.Management.Role().Update(ctx, name, newName, description, permissionNames, tenantID)
if  (err != nil){
  fmt.Println("Unable to update role.", err)
} else {
  fmt.Println("Successfully updated role.")
}

// Update will override all fields as is. Use carefully.
String newName = "My Updated Role";
description = "A revised description";
permissionNames.add("Another Permission");
// Pending release of Optional Tenant ID

try {
    rs.update(name, newName, description, permissionNames);
} catch (DescopeException de) {
    // Handle the error
}

# Args:
#   name (str): The name of the role to be deleted.
name = "My Updated Test Role"
#   tenant_id (str): Optional Tenant ID to assign new role to specific tenant
tenant_id = "Tenant ID"

try:
  descope_client.mgmt.role.delete(name=name, tenant_id=tenant_id)
  print("Successfully deleted role.")
except AuthException as error:
  print ("Unable to delete role.")
  print ("Status Code: " + str(error.status_code))
  print ("Error: " + str(error.error_message))

// Args:
//    ctx: context.Context - Application context for the transmission of context capabilities like
//        cancellation signals during the function call. In cases where context is absent, the context.Background()
//        function serves as a viable alternative.
//        Utilizing context within the Descope GO SDK is supported within versions 1.6.0 and higher.
ctx := context.Background()
//    name (str): The name of the role to be deleted.
name := "My Updated Test Role"
//    tenantId (str): Optional Tenant ID to assign new role to specific tenant
tenantID := "Tenant ID"

err := descopeClient.Management.Role().Delete(ctx, name, tenantID)
if  (err != nil){
  fmt.Println("Unable to delete role.", err)
} else {
  fmt.Println("Successfully deleted role.")
}

// You can optionally set a description and associated permission for a roles.
RolesService rs = descopeClient.getManagementServices().getRolesService();
// Pending release of Optional Tenant ID

// Role deletion cannot be undone. Use carefully.
try {
    rs.delete(newName);
} catch (DescopeException de) {
    // Handle the error
}