Application Service > ROLE > API v3 Guide

To check the permissions to use the ROLE service, call RESTful API or use Client SDK. Call RESTful APIs or use client SDKs.

Authentication and Authorization

AppKey and SecretKey are required to use the ROLE API. The Appkey is included in the request URL to identify and specify a particular resource when making API calls. A SecretKey is a private key used to control access to the API. For more information on checking and using Appkeys and SecretKeys, please refer to Appkey. Alternatively, a Project-integrated Appkey can be used in place of Appkey. For more information on creating and using Project Integrated Appkeys, please refer to Project Integrated Appkey.

RESTful API Guide

Common Response Body

Returns the HTTP response code 200 for all API requests. For detailed response results, see Headers in the Response Body.

{
  "cache": {
    "cacheFlushTime": "",
    "size": 0,
    "sizeTree": 1,
    "ttl": 5,
    "sizeByPath": 6
  },
  "header": {
    "isSuccessful": true,
    "resultCode": 5,
    "resultMessage": "resultMessage"
  }
}
Key Type Description
header Object [Response Header]
header.isSuccessful boolean Successful or not
header.resultCode int Response code. Returns 0 on success or an error code on failure.
header.resultMessage String Response message. Returns "SUCCESS" on success, error message on failure
cache Object Cache
cache.cacheFlushTime String Cache clearing time
cache.size int Authentication cache size based on resource identity
cache.sizeByPath int Resource Path-based authentication cache size
cache.sizeTree int Resource Hierarchy Lookup Cache Size
cache.ttl int Cache data retention time (in seconds)

User

Method HTTP request Description
POST /role/v3.0/appkeys/{appKey}/users Create a user
DELETE /role/v3.0/appkeys/{appKey}/users/{userId} Delete a user
DELETE /role/v3.0/appkeys/{appKey}/users Delete users
POST /role/v3.0/appkeys/{appKey}/users/id Get a list of all user IDs
GET /role/v3.0/appkeys/{appKey}/users/{userId} Get user information
GET /role/v3.0/appkeys/{appKey}/users/{userId}/histories View a list of changes to roles assigned to a user
POST /role/v3.0/appkeys/{appKey}/users/search Get a list of users
PUT /role/v3.0/appkeys/{appKey}/users/{userId} Edit users
PUT /role/v3.0/appkeys/{appKey}/users/{userId}/scopes/{scopeId} Edit user scopes

Create a user

POST "/role/v3.0/appkeys/{appKey}/users"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Request Body CreateUserRequest CreateUserRequest Yes
CreateUserRequest
Name Type Required Description
users List Yes User list
CreateUserRequest.UserProtocol
Name Type Required Description
description String No User description
roleRelations List No User-related Role
userId String Yes User ID
UserRoleRelationProtocol
Name Type Required Description
conditions List No Role Condition Attributes
roleApplyPolicyCode String No ALLOW, DENY
roleId String Yes Role ID
scopeId String Yes Scope ID
ConditionProtocol
Name Type Required Description
attributeId String Yes Condition attribute ID
attributeOperatorTypeCode String Yes ALL_CONTAINS, ANY_CONTAINS, NOT_CONTAINS, ANY_MATCH, NONE_MATCH, BETWEEN, BEYOND, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO, ALLOW, NOT_ALLOW, TRUE, FALSE
attributeValues List<String> No Condition attribute value

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Deleting a user

DELETE "/role/v3.0/appkeys/{appKey}/users/{userId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Path userId String Yes User ID

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Delete users

DELETE "/role/v3.0/appkeys/{appKey}/users"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes Secret key
Path appKey String Yes Appkey
Request Body userIds List<String> Yes User IDs

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Get a list of all user IDs

POST "/role/v3.0/appkeys/{appKey}/users/id"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Query page Integer No The page number you want to search (default 1)
Query itemsPerPage Integer No Number of searches per page for which you want results (default 10)
Query sort List<String> No Sort order (default id.userId,ASC)
Request Body SearchUser.Request SearchUser.Request Yes
SearchUser.Request
Name Type Required Description
descriptionLike String No User description (partial match)
needRoleRelations Boolean No Whether to include role relations in responses (default: true)
needRoleTags Boolean No Whether to include role tags when including role relations in responses (default: false)
needRoleCount Boolean No Whether to include the number of roles users have in responses (default: false)
roleIdPreLike String No Role ID (forward match)
roleIds List<String> No Role ID list (exact match)
scopeIdPreLike String No Scope ID (forward match)
scopeIds List<String> No List of scope IDs (exact match)
searchRoleOptionCode String No DIRECT_ROLE, INDIRECT_ROLE
userIdPreLike String No User ID (forward matching)
userIds List<String> No List of user IDs (exact match)

Response Body

{
  "totalItems" : 0,
  "userIds" : [ "userIds", "userIds" ],
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
SearchAllUser.Response
Name Type Required Description
totalItems Long Yes Total number
userIds List<String> Yes User list

Get user information

GET "/role/v3.0/appkeys/{appKey}/users/{userId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Path userId String Yes User ID
Query searchRoleOptionCode String No How to search the list of accessible roles
Query roleIds List<String> No Relationship role ID
Query scopeIds List<String> No Relationship scope ID

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  },
  "user" : {
    "roleRelations" : [ {
      "scopeId" : "scopeId",
      "exposureOrder" : 6,
      "roleTags" : [ {
        "roleTagId" : "roleTagId"
      }, {
        "roleTagId" : "roleTagId"
      } ],
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "conditions" : [ {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      }, {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      } ],
      "regYmdt" : "2000-01-23T04:56:07.000+00:00",
      "roleGroup" : "roleGroup"
    }, {
      "scopeId" : "scopeId",
      "exposureOrder" : 6,
      "roleTags" : [ {
        "roleTagId" : "roleTagId"
      }, {
        "roleTagId" : "roleTagId"
      } ],
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "conditions" : [ {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      }, {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      } ],
      "regYmdt" : "2000-01-23T04:56:07.000+00:00",
      "roleGroup" : "roleGroup"
    } ],
    "description" : "description",
    "regYmdt" : "2000-01-23T04:56:07.000+00:00",
    "userId" : "userId"
  }
}
GetUser.Response
Name Type Required Description
user UserBundleProtocol Yes User
UserBundleProtocol
Name Type Required Description
description String No Description
regYmdt Date No User Creation Date
roleRelations List No List of roles assigned to the user
userId String Yes User ID
UserBundleProtocol.UserRoleRelationBundleProtocol
Name Type Required Description
conditions List No Role Condition Attributes
description String No Role descriptions
exposureOrder Integer Yes Exposure order
regYmdt Date No At enrollment
roleApplyPolicyCode String Yes ALLOW, DENY
roleGroup String No Role group
roleId String Yes Role ID
roleName String No Role name
roleTags List No Role tag list
scopeId String Yes Scope ID
ConditionBundleProtocol
Name Type Required Description
attribute AttributeProtocol Yes Condition attribute
attributeId String Yes Condition attribute ID
attributeOperatorTypeCode String Yes ALL_CONTAINS, ANY_CONTAINS, NOT_CONTAINS, ANY_MATCH, NONE_MATCH, BETWEEN, BEYOND, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO, ALLOW, NOT_ALLOW, TRUE, FALSE
attributeValues List<String> No Condition attribute value
AttributeProtocol
Name Type Required Description
attributeCreationTypeCode String Yes COMMON_ATTRIBUTE, ROLE_ATTRIBUTE
attributeDataTypeCode String Yes STRING, NUMERIC, DAY_OF_WEEK, DATETIME, TIME, IPADDRESS, BOOLEAN
attributeId String Yes Condition attribute ID
attributeName String No Condition attribute name
description String No Condition attribute description
UserBundleProtocol.RoleTagProtocol
Name Type Required Description
roleTagId String No Role Tag ID

View a list of changes to roles assigned to a user

GET "/role/v3.0/appkeys/{appKey}/users/{userId}/histories"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Path userId String Yes User ID
Query roleId String No Role ID
Query scopeId String No Scope ID
Query fromDateTime Date No When the change starts
Query toDateTime Date No When the change ends
Query historyType List<String> No Change type
Query page Integer No The page number you want to search (default 1)
Query itemsPerPage Integer No Number of searches per page for which you want results (default 10)
Query sort List<String> No Sort order (default seq,DESC)

Response Body

{
  "totalItems" : 0,
  "userHistory" : [ {
    "executionTime" : "2000-01-23T04:56:07.000+00:00",
    "scopeId" : "scopeId",
    "userHistorySeq" : 6,
    "roleId" : "roleId",
    "operatorUuid" : "operatorUuid",
    "conditions" : [ {
      "attributeId" : "instance.name",
      "attributeValues" : [ "attributeValues", "attributeValues" ],
      "attribute" : {
        "attributeId" : "attributeId",
        "description" : "description",
        "attributeName" : "attributeName"
      }
    }, {
      "attributeId" : "instance.name",
      "attributeValues" : [ "attributeValues", "attributeValues" ],
      "attribute" : {
        "attributeId" : "attributeId",
        "description" : "description",
        "attributeName" : "attributeName"
      }
    } ],
    "userId" : "userId"
  }, {
    "executionTime" : "2000-01-23T04:56:07.000+00:00",
    "scopeId" : "scopeId",
    "userHistorySeq" : 6,
    "roleId" : "roleId",
    "operatorUuid" : "operatorUuid",
    "conditions" : [ {
      "attributeId" : "instance.name",
      "attributeValues" : [ "attributeValues", "attributeValues" ],
      "attribute" : {
        "attributeId" : "attributeId",
        "description" : "description",
        "attributeName" : "attributeName"
      }
    }, {
      "attributeId" : "instance.name",
      "attributeValues" : [ "attributeValues", "attributeValues" ],
      "attribute" : {
        "attributeId" : "attributeId",
        "description" : "description",
        "attributeName" : "attributeName"
      }
    } ],
    "userId" : "userId"
  } ],
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
GetUserHistory.Response
Name Type Required Description
totalItems Long Yes Total number
userHistory List Yes User change history list
UserHistoryProtocol
Name Type Required Description
command String Yes USER_ADD, USER_REMOVE, ADD, REMOVE
conditions List No Role Condition Attributes
executionTime Date Yes Date of change
operatorUuid String No Worker UUID
roleApplyPolicyCode String No ALLOW, DENY
roleId String No Role ID
scopeId String No Scope ID
userHistorySeq Long Yes User change history serial number
userId String Yes User ID
ConditionBundleProtocol
Name Type Required Description
attribute AttributeProtocol Yes Condition attribute
attributeId String Yes Condition attribute ID
attributeOperatorTypeCode String Yes ALL_CONTAINS, ANY_CONTAINS, NOT_CONTAINS, ANY_MATCH, NONE_MATCH, BETWEEN, BEYOND, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO, ALLOW, NOT_ALLOW, TRUE, FALSE
attributeValues List<String> No Condition attribute value
AttributeProtocol
Name Type Required Description
attributeCreationTypeCode String Yes COMMON_ATTRIBUTE, ROLE_ATTRIBUTE
attributeDataTypeCode String Yes STRING, NUMERIC, DAY_OF_WEEK, DATETIME, TIME, IPADDRESS, BOOLEAN
attributeId String Yes Condition attribute ID
attributeName String No Condition attribute name
description String No Condition attribute description

Get a list of users

POST "/role/v3.0/appkeys/{appKey}/users/search"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Query page Integer No The page number you want to search (default 1)
Query itemsPerPage Integer No Number of searches per page for which you want results (default 10)
Query sort List<String> No Sort order (default id.userId,ASC)
Request Body SearchUser.Request SearchUser.Request Yes
SearchUser.Request
Name Type Required Description
descriptionLike String No User description (partial match)
needRoleRelations Boolean No Whether to include role relations in responses (default: true)
needRoleTags Boolean No Whether to include role tags when including role relations in responses (default: false)
needRoleCount Boolean No Whether to include the number of roles users have in responses (default: false)
roleIdPreLike String No Role ID (forward match)
roleIds List<String> No Role ID list (exact match)
scopeIdPreLike String No Scope ID (forward match)
scopeIds List<String> No List of scope IDs (exact match)
searchRoleOptionCode String No DIRECT_ROLE, INDIRECT_ROLE
userIdPreLike String No User ID (forward matching)
userIds List<String> No List of user IDs (exact match)

Response Body

{
  "totalItems" : 0,
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  },
  "users" : [ {
    "roleRelations" : [ {
      "scopeId" : "scopeId",
      "exposureOrder" : 6,
      "roleTags" : [ {
        "roleTagId" : "roleTagId"
      }, {
        "roleTagId" : "roleTagId"
      } ],
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "conditions" : [ {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      }, {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      } ],
      "regYmdt" : "2000-01-23T04:56:07.000+00:00",
      "roleGroup" : "roleGroup"
    }, {
      "scopeId" : "scopeId",
      "exposureOrder" : 6,
      "roleTags" : [ {
        "roleTagId" : "roleTagId"
      }, {
        "roleTagId" : "roleTagId"
      } ],
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "conditions" : [ {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      }, {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      } ],
      "regYmdt" : "2000-01-23T04:56:07.000+00:00",
      "roleGroup" : "roleGroup"
    } ],
    "description" : "description",
    "regYmdt" : "2000-01-23T04:56:07.000+00:00",
    "userId" : "userId",
    "roleCounts": [
      {
        "roleCount": 2,
        "scopeId": "scopeId"
      }
    ]
  }, {
    "roleRelations" : [ {
      "scopeId" : "scopeId",
      "exposureOrder" : 6,
      "roleTags" : [ {
        "roleTagId" : "roleTagId"
      }, {
        "roleTagId" : "roleTagId"
      } ],
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "conditions" : [ {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      }, {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      } ],
      "regYmdt" : "2000-01-23T04:56:07.000+00:00",
      "roleGroup" : "roleGroup"
    }, {
      "scopeId" : "scopeId",
      "exposureOrder" : 6,
      "roleTags" : [ {
        "roleTagId" : "roleTagId"
      }, {
        "roleTagId" : "roleTagId"
      } ],
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "conditions" : [ {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      }, {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      } ],
      "regYmdt" : "2000-01-23T04:56:07.000+00:00",
      "roleGroup" : "roleGroup"
    } ],
    "description" : "description",
    "regYmdt" : "2000-01-23T04:56:07.000+00:00",
    "userId" : "userId",
    "roleCounts": [
      {
        "roleCount": 2,
        "scopeId": "scopeId"
      }
    ]
  } ]
}
SearchUser.Response
Name Type Required Description
totalItems Long Yes Total number
users List Yes User list
UserBundleProtocol
Name Type Required Description
description String No Description
regYmdt Date No User Creation Date
roleRelations List No List of roles assigned to the user
userId String Yes User ID
roleCounts List<UserRoleCountProtocol> No The number of roles assigned to users
UserBundleProtocol.UserRoleRelationBundleProtocol
Name Type Required Description
conditions List No Role Condition Attributes
description String No Role descriptions
exposureOrder Integer Yes Exposure order
regYmdt Date No At enrollment
roleApplyPolicyCode String Yes ALLOW, DENY
roleGroup String No Role group
roleId String Yes Role ID
roleName String No Role name
roleTags List No Role tag list
scopeId String Yes Scope ID
UserBundleProtocol.UserRoleCountProtocol
Name Type Required Description
scopeId String Yes Scope ID
roleCount Long Yes The number of roles for each scope ID
ConditionBundleProtocol
Name Type Required Description
attribute AttributeProtocol Yes Condition attribute
attributeId String Yes Condition attribute ID
attributeOperatorTypeCode String Yes ALL_CONTAINS, ANY_CONTAINS, NOT_CONTAINS, ANY_MATCH, NONE_MATCH, BETWEEN, BEYOND, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO, ALLOW, NOT_ALLOW, TRUE, FALSE
attributeValues List<String> No Condition attribute value
AttributeProtocol
Name Type Required Description
attributeCreationTypeCode String Yes COMMON_ATTRIBUTE, ROLE_ATTRIBUTE
attributeDataTypeCode String Yes STRING, NUMERIC, DAY_OF_WEEK, DATETIME, TIME, IPADDRESS, BOOLEAN
attributeId String Yes Condition attribute ID
attributeName String No Condition attribute name
description String No Condition attribute description
UserBundleProtocol.RoleTagProtocol
Name Type Required Description
roleTagId String No Role Tag ID

Edit users

PUT "/role/v3.0/appkeys/{appKey}/users/{userId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Path userId String Yes User ID
Request Body PutUserRequest PutUserRequest Yes User
PutUserRequest
Name Type Required Description
user PutUserRequest.UserProtocol Yes User
createUserIfNotExist Boolean No Whether to create if the user doesn't exist at the time of the request
PutUserRequest.UserProtocol
Name Type Required Description
description String No User description
roleRelations List No User-related Role
UserRoleRelationProtocol
Name Type Required Description
conditions List No Role Condition Attributes
roleApplyPolicyCode String No ALLOW, DENY
roleId String Yes Role ID
scopeId String Yes Scope ID
ConditionProtocol
Name Type Required Description
attributeId String Yes Condition attribute ID
attributeOperatorTypeCode String Yes ALL_CONTAINS, ANY_CONTAINS, NOT_CONTAINS, ANY_MATCH, NONE_MATCH, BETWEEN, BEYOND, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO, ALLOW, NOT_ALLOW, TRUE, FALSE
attributeValues List<String> No Condition attribute value

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Edit user scopes

PUT "/role/v3.0/appkeys/{appKey}/users/{userId}/scopes/{scopeId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes Secretkey
Path appKey String Yes Appkey
Path userId String Yes User ID
Path scopeId String Yes Scope ID
Request Body putUserScopeRequest PutUserScopeRequest Yes User
PutUserScopeRequest
Name Type Required Description
user PutUserScopeRequest.UserProtocol Yes User
createUserIfNotExist Boolean No Whether to create if the user doesn't exist at the time of the request
PutUserScopeRequest.UserProtocol
Name Type Required Description
description String No User description
roleRelations List<UserScopeRoleRelationProtocol> No Roles related to users
UserScopeRoleRelationProtocol
Name Type Required Description
conditions List<ConditionProtocol> No Role condition attributes
roleApplyPolicyCode String No ALLOW, DENY
roleId String Yes Role ID
ConditionProtocol
Name Type Required Description
attributeId String Yes Attribute ID
attributeOperatorTypeCode String Yes ALL_CONTAINS, ANY_CONTAINS, NOT_CONTAINS, ANY_MATCH, NONE_MATCH, BETWEEN, BEYOND, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO, ALLOW, NOT_ALLOW, TRUE, FALSE
attributeValues List<String> No Attributre value

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

User authentication

Method HTTP request Description
POST /role/v3.0/appkeys/{appKey}/users/{userId}/authorizations/resources Check if a user is authorized to access a resource
POST /role/v3.0/appkeys/{appKey}/users/{userId}/authorizations/roles Check if a user has access to a role

Check if a user is authorized to access a resource

POST "/role/v3.0/appkeys/{appKey}/users/{userId}/authorizations/resources"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Path userId String Yes User ID
Request Body PostAuthorizationResource.Request PostAuthorizationResource.Request Yes Resource List
PostAuthorizationResource.Request
Name Type Required Description
Resources List Yes Resource List
PostAuthorizationResource.ResourceProtocol
Name Type Required Description
attributes List No Condition attribute ID
authRequestId String No Request Authentication Identification Key
operationId String Yes Operation ID
resourceId String No Resource ID
resourcePath String No Resource Path
scopeId String No Scope ID
PostAuthorizationResource.AttributeProtocol
Name Type Required Description
attributeId String Yes Condition attribute ID
attributeValue String Yes Condition attribute value

Response Body

{
  "authorizations" : [ {
    "resourceId" : "resourceId",
    "scopeId" : "scopeId",
    "resourcePath" : "resourcePath",
    "authRequestId" : "authRequestId",
    "operationId" : "operationId",
    "attributes" : [ {
      "attributeId" : "attributeId",
      "attributeValue" : "attributeValue"
    }, {
      "attributeId" : "attributeId",
      "attributeValue" : "attributeValue"
    } ],
    "permission" : true
  }, {
    "resourceId" : "resourceId",
    "scopeId" : "scopeId",
    "resourcePath" : "resourcePath",
    "authRequestId" : "authRequestId",
    "operationId" : "operationId",
    "attributes" : [ {
      "attributeId" : "attributeId",
      "attributeValue" : "attributeValue"
    }, {
      "attributeId" : "attributeId",
      "attributeValue" : "attributeValue"
    } ],
    "permission" : true
  } ],
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
PostAuthorizationResource.Response
Name Type Required Description
authorizations List No List of permission check results
PostAuthorizationResource.AuthorizationWithResourceProtocol
Name Type Required Description
attributes List Yes Condition attribute ID
authRequestId String No Request Authentication Identification Key
operationId String Yes Operation ID
permission Boolean Yes Authorization status
resourceId String No Resource ID
resourcePath String No Resource Path
scopeId String Yes Scope ID
PostAuthorizationResource.AttributeProtocol
Name Type Required Description
attributeId String Yes Condition attribute ID
attributeValue String Yes Condition attribute value

Check if a user has access to a role

POST "/role/v3.0/appkeys/{appKey}/users/{userId}/authorizations/roles"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Path userId String Yes User ID
Request Body PostAuthorizationRole.Request PostAuthorizationRole.Request Yes
PostAuthorizationRole.Request
Name Type Required Description
roles List Yes Authentication request list
PostAuthorizationRole.AuthRoleProtocol
Name Type Required Description
attributes List No Condition attribute
authRequestId String No Authentication request identification key
roleId String Yes Role ID
scopeId String No Scope ID
PostAuthorizationRole.AttributeProtocol
Name Type Required Description
attributeId String Yes Condition attribute ID
attributeValue String Yes Condition attribute value

Response Body

{
  "authorizations" : [ {
    "scopeId" : "scopeId",
    "roleId" : "roleId",
    "authRequestId" : "authRequestId",
    "attributes" : [ {
      "attributeId" : "attributeId",
      "attributeValue" : "attributeValue"
    }, {
      "attributeId" : "attributeId",
      "attributeValue" : "attributeValue"
    } ],
    "permission" : true
  }, {
    "scopeId" : "scopeId",
    "roleId" : "roleId",
    "authRequestId" : "authRequestId",
    "attributes" : [ {
      "attributeId" : "attributeId",
      "attributeValue" : "attributeValue"
    }, {
      "attributeId" : "attributeId",
      "attributeValue" : "attributeValue"
    } ],
    "permission" : true
  } ],
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
PostAuthorizationRole.Response
Name Type Required Description
authorizations List No List of permission check results
PostAuthorizationRole.AuthorizationProtocol
Name Type Required Description
attributes List Yes Condition attribute ID
authRequestId String No Request Authentication Identification Key
permission Boolean Yes Authorization status
roleId String Yes Role ID
scopeId String Yes Scope ID
PostAuthorizationRole.AttributeProtocol
Name Type Required Description
attributeId String Yes Condition attribute ID
attributeValue String Yes Condition attribute value

Roles

Method HTTP request Description
POST /role/v3.0/appkeys/{appKey}/roles Create a role
DELETE /role/v3.0/appkeys/{appKey}/roles/{roleId} Delete a role
DELETE /role/v3.0/appkeys/{appKey}/roles Delete roles
GET /role/v3.0/appkeys/{appKey}/roles/{roleId}/deniable Whether the role is enabled or can be changed to DENY (not enabled)
GET /role/v3.0/appkeys/{appKey}/roles/{roleId} Single role lookup
GET /role/v3.0/appkeys/{appKey}/roles/id Get a list of all role IDs
POST /role/v3.0/appkeys/{appKey}/roles/{roleId}/attributes/search Get a list of all condition attributes that can be set in a role
POST /role/v3.0/appkeys/{appKey}/roles/{roleId}/containing-roles/search Retrieve a list of roles that include all sub-roles and permissions of a specific role
POST /role/v3.0/appkeys/{appKey}/roles/search Get a list of roles
PUT /role/v3.0/appkeys/{appKey}/roles/{roleId} Modify roles

Create a role

POST "/role/v3.0/appkeys/{appKey}/roles"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Request Body CreateRoleRequest CreateRoleRequest Yes
CreateRoleRequest
Name Type Required Description
role RoleProtocol No Roles
roleRelations List No List of role IDs associated with the condition attribute
roleTags List No Role tag list
RoleProtocol
Name Type Required Description
description String No Role descriptions
exposureOrder Integer Yes Exposure order
roleGroup String No Role group
roleId String Yes Role ID
roleName String No Role name
CreateRoleRequest.RoleRelationProtocol
Name Type Required Description
conditions List No Role Condition Attributes
relatedRoleId String Yes Role ID associated with the condition attribute
roleApplyPolicyCode String No ALLOW, DENY
ConditionProtocol
Name Type Required Description
attributeId String Yes Condition attribute ID
attributeOperatorTypeCode String Yes ALL_CONTAINS, ANY_CONTAINS, NOT_CONTAINS, ANY_MATCH, NONE_MATCH, BETWEEN, BEYOND, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO, ALLOW, NOT_ALLOW, TRUE, FALSE
attributeValues List<String> No Condition attribute value
CreateRoleRequest.RoleTagProtocol
Name Type Required Description
roleTagId String Yes Role Tag ID

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Deleting roles

DELETE "/role/v3.0/appkeys/{appKey}/roles/{roleId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Path roleId String Yes Role ID

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Delete roles

DELETE "/role/v3.0/appkeys/{appKey}/roles/{roleId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes Secretkey
Path appKey String Yes Appkey
Request Body roleIds List<String> Yes Role IDs

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Whether the role is enabled or can be changed to DENY (not enabled)

GET "/role/v3.0/appkeys/{appKey}/roles/{roleId}/deniable"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Path roleId String Yes Role ID

Response Body

{
  "deniable" : true,
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
GetDeniableResponse
Name Type Required Description
deniable Boolean No Whether the role is enabled or can be changed to DENY (not enabled)

Single role lookup

GET "/role/v3.0/appkeys/{appKey}/roles/{roleId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Path roleId String Yes Role ID

Response Body

{
  "role" : {
    "regDateTime" : "2000-01-23T04:56:07.000+00:00",
    "roleRelations" : [ {
      "regDateTime" : "2000-01-23T04:56:07.000+00:00",
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "roleTags" : [ {
        "roleTagId" : "roleTagId"
      }, {
        "roleTagId" : "roleTagId"
      } ],
      "conditions" : [ {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      }, {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      } ],
      "roleGroup" : "roleGroup"
    }, {
      "regDateTime" : "2000-01-23T04:56:07.000+00:00",
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "roleTags" : [ {
        "roleTagId" : "roleTagId"
      }, {
        "roleTagId" : "roleTagId"
      } ],
      "conditions" : [ {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      }, {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      } ],
      "roleGroup" : "roleGroup"
    } ],
    "exposureOrder" : 0,
    "roleTags" : [ {
      "roleTagId" : "roleTagId"
    }, {
      "roleTagId" : "roleTagId"
    } ],
    "roleId" : "roleId",
    "roleName" : "roleName",
    "description" : "description",
    "appKey" : "appKey",
    "attributes" : [ {
      "attributeId" : "attributeId",
      "description" : "description",
      "attributeName" : "attributeName"
    }, {
      "attributeId" : "attributeId",
      "description" : "description",
      "attributeName" : "attributeName"
    } ],
    "roleGroup" : "roleGroup"
  },
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
GetRoleResponse
Name Type Required Description
role RoleBundleProtocol Yes Roles
RoleBundleProtocol
Name Type Required Description
appKey String Yes Appkey
attributes List<AttributeProtocol> No Condition attributes
description String No Role descriptions
exposureOrder Integer Yes Exposure order
regDateTime Date Yes When the role was created
roleGroup String No Role group
roleId String Yes Role ID
roleName String No Role name
roleRelations List No List of relations roles
roleTags List No Role tag list
AttributeProtocol
Name Type Required Description
attributeCreationTypeCode String Yes COMMON_ATTRIBUTE, ROLE_ATTRIBUTE
attributeDataTypeCode String Yes STRING, NUMERIC, DAY_OF_WEEK, DATETIME, TIME, IPADDRESS, BOOLEAN
attributeId String Yes Condition attribute ID
attributeName String No Condition attribute name
description String No Condition attribute description
RoleBundleProtocol.RoleRelationProtocol
Name Type Required Description
conditions List No Role Condition Attributes
description String No Role descriptions
regDateTime Date Yes When the role was created
roleApplyPolicyCode String Yes ALLOW, DENY
roleGroup String No Role group
roleId String Yes Role ID
roleName String No Role name
roleTags List<RoleBundleProtocol.RoleTagProtocol> No Role tag list
ConditionBundleProtocol
Name Type Required Description
attribute AttributeProtocol Yes Condition attribute
attributeId String Yes Condition attribute ID
attributeOperatorTypeCode String Yes ALL_CONTAINS, ANY_CONTAINS, NOT_CONTAINS, ANY_MATCH, NONE_MATCH, BETWEEN, BEYOND, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO, ALLOW, NOT_ALLOW, TRUE, FALSE
attributeValues List<String> No Condition attribute value
AttributeProtocol
Name Type Required Description
attributeCreationTypeCode String Yes COMMON_ATTRIBUTE, ROLE_ATTRIBUTE
attributeDataTypeCode String Yes STRING, NUMERIC, DAY_OF_WEEK, DATETIME, TIME, IPADDRESS, BOOLEAN
attributeId String Yes Condition attribute ID
attributeName String No Condition attribute name
description String No Condition attribute description
RoleBundleProtocol.RoleTagProtocol
Name Type Required Description
roleTagId String No Role Tag ID

Get a list of all role IDs

GET "/role/v3.0/appkeys/{appKey}/roles/id"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Query roleIdPreLike String No Role ID (forward match)
Query page Integer No The page number you want to search (default 1)
Query itemsPerPage Integer No Number of searches per page for which you want results (default 10)
Query sort List<String> No Sort order (default id.roleId,ASC)

Response Body

{
  "totalItems" : 0,
  "roleIds" : [ "roleIds", "roleIds" ],
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
GetAllRoleIds.Response
Name Type Required Description
roleIds List<String> Yes List of role IDs
totalItems Long Yes Total number

Get a list of all condition attributes that can be set in a role

POST "/role/v3.0/appkeys/{appKey}/roles/{roleId}/attributes/search"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Path roleId String Yes Role ID
Query page Integer No The page number you want to search (default 1)
Query itemsPerPage Integer No Number of searches per page for which you want results (default 10)
Query sort List<String> No Sort order (default attributeCreationTypeCode,ASC&quot;,&quot;id.attributeId,ASC&quot)
Request Body SearchRoleAttributes.Request SearchRoleAttributes.Request Yes
SearchRoleAttributes.Request
Name Type Required Description
attributeIds List<String> No Condition attribute ID list (exact match)
attributeNameLike String No Condition attribute name (partial match)
attributeTagIds List<String> No Condition attribute tag ID list (exact match)

Response Body

{
  "totalItems" : 0,
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  },
  "attributes" : [ {
    "attributeId" : "attributeId",
    "description" : "description",
    "attributeName" : "attributeName"
  }, {
    "attributeId" : "attributeId",
    "description" : "description",
    "attributeName" : "attributeName"
  } ]
}
SearchRoleAttributes.Response
Name Type Required Description
attributes List<AttributeProtocol> Yes List of condition attributes that can be assigned to roles
totalItems Long Yes Total number
AttributeProtocol
Name Type Required Description
attributeCreationTypeCode String Yes COMMON_ATTRIBUTE, ROLE_ATTRIBUTE
attributeDataTypeCode String Yes STRING, NUMERIC, DAY_OF_WEEK, DATETIME, TIME, IPADDRESS, BOOLEAN
attributeId String Yes Condition attribute ID
attributeName String No Condition attribute name
attributeTagIds List<String> No List of condition attribute tag IDs
description String No Condition attribute description

Retrieve a list of roles that include all sub-roles and permissions of a specific role

POST "/role/v3.0/appkeys/{appKey}/roles/{roleId}/containing-roles/search"

Retrieves a list of upward-compatible role IDs that include all direct sub-roles of the base role ({roleId}).

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes Secret key
Path appKey String Yes Appkey
Path roleId String Yes Role ID that serves as a base
Request Body SearchContainingRoles.Request SearchContainingRoles.Request Yes
SearchContainingRoles.Request
Name Type Required Description
roleTagIds List<String> No Role tag ID list (OR condition)
roleGroups List<String> No Role group list (OR condition)

Request Example

{
  "roleTagIds" : [ "TAG_A", "TAG_B" ],
  "roleGroups" : [ "GROUP_1" ]
}

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "SUCCESS"
  },
  "totalItems" : 3,
  "roleIds" : [ "ROLE_ADMIN", "ROLE_SUPER", "ROLE_MANAGER" ]
}
SearchContainingRoles.Response
Name Type Required Description
roleIds List<String> Yes List of upward-compatible role IDs
totalItems Long Yes Total count

Get a list of roles

POST "/role/v3.0/appkeys/{appKey}/roles/search"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Query page Integer No The page number you want to search (default 1)
Query itemsPerPage Integer No Number of searches per page for which you want results (default 10)
Query sort List<String> No Sort order (default exposureOrder,ASC&quot;,&quot;id.roleId,ASC&quot)
Request Body GetRoles.Request GetRoles.Request Yes
GetRoles.Request
Name Type Required Description
attributeIds List<String> No Condition attribute ID list (exact match)
attributeTagIds List<String> No Condition attribute tag ID list (exact match)
descriptionLike String No Role description (partial match)
needAttributes Boolean No Whether to include condition attribute information in the response
needRoleRelations Boolean No Whether to include a list of role association IDs in the response
needRoleTags Boolean No Whether to include a list of role tag IDs in the response
relatedRoleIds List<String> No List of related role IDs (exact match)
roleGroup String No Role group(exact match)
roleGroupLike String No Role groups (partial match)
roleIdPreLike String No Role ID (forward match)
roleIds List<String> No Role ID list (exact match)
roleNameLike String No Role name (partial match)
roleTagIdExpr String No Role tag conditions (separator ';':OR, ',':AND)
roleTagIds List<String> No List of role tag IDs (exact match)

Response Body

{
  "totalItems" : 6,
  "roles" : [ {
    "regDateTime" : "2000-01-23T04:56:07.000+00:00",
    "roleRelations" : [ {
      "regDateTime" : "2000-01-23T04:56:07.000+00:00",
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "roleTags" : [ {
        "roleTagId" : "roleTagId"
      }, {
        "roleTagId" : "roleTagId"
      } ],
      "conditions" : [ {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      }, {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      } ],
      "roleGroup" : "roleGroup"
    }, {
      "regDateTime" : "2000-01-23T04:56:07.000+00:00",
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "roleTags" : [ {
        "roleTagId" : "roleTagId"
      }, {
        "roleTagId" : "roleTagId"
      } ],
      "conditions" : [ {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      }, {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      } ],
      "roleGroup" : "roleGroup"
    } ],
    "exposureOrder" : 0,
    "roleTags" : [ {
      "roleTagId" : "roleTagId"
    }, {
      "roleTagId" : "roleTagId"
    } ],
    "roleId" : "roleId",
    "roleName" : "roleName",
    "description" : "description",
    "appKey" : "appKey",
    "attributes" : [ {
      "attributeId" : "attributeId",
      "description" : "description",
      "attributeName" : "attributeName"
    }, {
      "attributeId" : "attributeId",
      "description" : "description",
      "attributeName" : "attributeName"
    } ],
    "roleGroup" : "roleGroup"
  }, {
    "regDateTime" : "2000-01-23T04:56:07.000+00:00",
    "roleRelations" : [ {
      "regDateTime" : "2000-01-23T04:56:07.000+00:00",
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "roleTags" : [ {
        "roleTagId" : "roleTagId"
      }, {
        "roleTagId" : "roleTagId"
      } ],
      "conditions" : [ {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      }, {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      } ],
      "roleGroup" : "roleGroup"
    }, {
      "regDateTime" : "2000-01-23T04:56:07.000+00:00",
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "conditions" : [ {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      }, {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      } ],
      "roleGroup" : "roleGroup"
    } ],
    "exposureOrder" : 0,
    "roleTags" : [ {
      "roleTagId" : "roleTagId"
    }, {
      "roleTagId" : "roleTagId"
    } ],
    "roleId" : "roleId",
    "roleName" : "roleName",
    "description" : "description",
    "appKey" : "appKey",
    "attributes" : [ {
      "attributeId" : "attributeId",
      "description" : "description",
      "attributeName" : "attributeName"
    }, {
      "attributeId" : "attributeId",
      "description" : "description",
      "attributeName" : "attributeName"
    } ],
    "roleGroup" : "roleGroup"
  } ],
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
GetRoles.Response
Name Type Required Description
roles List Yes Roles list
totalItems Long Yes Total number of roles
RoleBundleProtocol
Name Type Required Description
appKey String Yes Appkey
attributes List<AttributeProtocol> No Condition attributes
description String No Role descriptions
exposureOrder Integer Yes Exposure order
regDateTime Date Yes When the role was created
roleGroup String No Role group
roleId String Yes Role ID
roleName String No Role name
roleRelations List No List of related roles
roleTags List No Role tag list
AttributeProtocol
Name Type Required Description
attributeCreationTypeCode String Yes COMMON_ATTRIBUTE, ROLE_ATTRIBUTE
attributeDataTypeCode String Yes STRING, NUMERIC, DAY_OF_WEEK, DATETIME, TIME, IPADDRESS, BOOLEAN
attributeId String Yes Condition attribute ID
attributeName String No Condition attribute name
description String No Condition attribute description
RoleBundleProtocol.RoleRelationProtocol
Name Type Required Description
conditions List No Role Condition Attributes
description String No Role descriptions
regDateTime Date Yes When the role was created
roleApplyPolicyCode String Yes ALLOW, DENY
roleGroup String No Role group
roleId String Yes Role ID
roleName String No Role name
roleTags List<RoleBundleProtocol.RoleTagProtocol> No Role tag list
ConditionBundleProtocol
Name Type Required Description
attribute AttributeProtocol Yes Condition attribute
attributeId String Yes Condition attribute ID
attributeOperatorTypeCode String Yes ALL_CONTAINS, ANY_CONTAINS, NOT_CONTAINS, ANY_MATCH, NONE_MATCH, BETWEEN, BEYOND, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO, ALLOW, NOT_ALLOW, TRUE, FALSE
attributeValues List<String> No Condition attribute value
AttributeProtocol
Name Type Required Description
attributeCreationTypeCode String Yes COMMON_ATTRIBUTE, ROLE_ATTRIBUTE
attributeDataTypeCode String Yes STRING, NUMERIC, DAY_OF_WEEK, DATETIME, TIME, IPADDRESS, BOOLEAN
attributeId String Yes Condition attribute ID
attributeName String No Condition attribute name
description String No Condition attribute description
RoleBundleProtocol.RoleTagProtocol
Name Type Required Description
roleTagId String No Role Tag ID

Modify roles

PUT "/role/v3.0/appkeys/{appKey}/roles/{roleId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Path roleId String Yes Role ID
Request Body UpdateRoleRequest UpdateRoleRequest Yes
UpdateRoleRequest
Name Type Required Description
role RoleMetadataProtocol No Roles
roleRelations List No List of role IDs associated with the condition attribute
roleTags List No Role tag list
RoleMetadataProtocol
Name Type Required Description
description String No Role descriptions
exposureOrder Integer Yes Exposure order
roleGroup String No Role group
roleName String No Role name
UpdateRoleRequest.RoleRelationProtocol
Name Type Required Description
conditions List No Role Condition Attributes
relatedRoleId String Yes Role ID associated with the condition attribute
roleApplyPolicyCode String No ALLOW, DENY
ConditionProtocol
Name Type Required Description
attributeId String Yes Condition attribute ID
attributeOperatorTypeCode String Yes ALL_CONTAINS, ANY_CONTAINS, NOT_CONTAINS, ANY_MATCH, NONE_MATCH, BETWEEN, BEYOND, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO, ALLOW, NOT_ALLOW, TRUE, FALSE
attributeValues List<String> No Condition attribute value
UpdateRoleRequest.RoleTagProtocol
Name Type Required Description
roleTagId String Yes Role Tag ID

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Role tags

Method HTTP request Description
GET /role/v3.0/appkeys/{appKey}/roles/tags/id Get a list of all role tag IDs

Get a list of all role tag IDs

GET "/role/v3.0/appkeys/{appKey}/roles/tags/id"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Query roleTagIdPreLike String No Role Tag ID (forward match)
Query page Integer No The page number you want to search (default 1)
Query itemsPerPage Integer No Number of searches per page for which you want results (default 10)
Query sort List<String> No Sort order (default id.roleTagId,ASC)

Response Body

{
  "totalItems" : 0,
  "roleTagIds" : [ "roleTagIds", "roleTagIds" ],
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
GetAllRoleTagIds.Response
Name Type Required Description
roleTagIds List<String> No List of role tag IDs
totalItems Long Yes Total number
Method HTTP request Description
POST /role/v3.0/appkeys/{appKey}/roles/{roleId}/relations Create role-related relations
DELETE /role/v3.0/appkeys/{appKey}/roles/{roleId}/relations Delete role-related relations
PUT /role/v3.0/appkeys/{appKey}/roles/{roleId}/relations Edit role-related relations

POST "/role/v3.0/appkeys/{appKey}/roles/{roleId}/relations"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes Secretkey
Path appKey String Yes Appkey
Path roleId String Yes Role ID
Request Body CreateRoleRelationRequest CreateRoleRelationRequest Yes
CreateRoleRelationRequest
Name Type Required Description
roleRelations List<RoleRelationProtocol> Yes role-related relations
RoleRelationProtocol
Name Type Required Description
conditions List<ConditionProtocol> No Role condition attribute
relatedRoleId String Yes Role ID related to condition attribute
roleApplyPolicyCode String No ALLOW, DENY
ConditionProtocol
Name Type Required Description
attributeId String Yes Condition attribute ID
attributeOperatorTypeCode String Yes ALL_CONTAINS, ANY_CONTAINS, NOT_CONTAINS, ANY_MATCH, NONE_MATCH, BETWEEN, BEYOND, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO, ALLOW, NOT_ALLOW, TRUE, FALSE
attributeValues List<String> No Condition attribute value

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Delete role realated relations

DELETE "/role/v3.0/appkeys/{appKey}/roles/{roleId}/relations"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes Secretkey
Path appKey String Yes Appkey
Path roleId String Yes Role ID
Request Body DeleteRoleRelationRequest DeleteRoleRelationRequest Yes
DeleteRoleRelationRequest
Name Type Required Description
relatedRoleIds List<String> Yes Role-related relation IDs

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

PUT "/role/v3.0/appkeys/{appKey}/roles/{roleId}/relations"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes Secretkey
Path appKey String Yes Appkey
Path roleId String Yes Role ID
Request Body UpdateRoleRelationRequest UpdateRoleRelationRequest Yes
UpdateRoleRelationRequest
Name Type Required Description
roleRelations List<RoleRelationProtocol> Yes Role-related realtions
RoleRelationProtocol
Name Type Required Description
conditions List<ConditionProtocol> No Role condition attribute
relatedRoleId String Yes Role ID related to condition attribute
roleApplyPolicyCode String No ALLOW, DENY
ConditionProtocol
Name Type Required Description
attributeId String Yes Condition attribute ID
attributeOperatorTypeCode String Yes ALL_CONTAINS, ANY_CONTAINS, NOT_CONTAINS, ANY_MATCH, NONE_MATCH, BETWEEN, BEYOND, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO, ALLOW, NOT_ALLOW, TRUE, FALSE
attributeValues List<String> No Condition attribute value

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Scope

Method HTTP request Description
POST /role/v3.0/appkeys/{appKey}/scopes Create a scope
DELETE /role/v3.0/appkeys/{appKey}/scopes/{scopeId} Delete a scope
DELETE /role/v3.0/appkeys/{appKey}/scopes Delete scopes
GET /role/v3.0/appkeys/{appKey}/scopes/id Get a list of all scope IDs
GET /role/v3.0/appkeys/{appKey}/scopes/{scopeId} Get a single scope
POST /role/v3.0/appkeys/{appKey}/scopes/search Get a list of scopes
PUT /role/v3.0/appkeys/{appKey}/scopes/{scopeId} Modify scope

Create a scope

POST "/role/v3.0/appkeys/{appKey}/scopes"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Request Body CreateScope.Request CreateScope.Request Yes
CreateScope.Request
Name Type Required Description
description String No Scope description
scopeId String Yes Scope ID

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Delete a scope

DELETE "/role/v3.0/appkeys/{appKey}/scopes/{scopeId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes
Path scopeId String Yes

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Delete scopes

DELETE "/role/v3.0/appkeys/{appKey}/scopes"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes Secretkey
Path appKey String Yes Appkey
Request Body scopeIds List<String> Yes Scope IDs

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Get a list of all scope IDs

GET "/role/v3.0/appkeys/{appKey}/scopes/id"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes
Query scopeIdPreLike String No Scope ID (forward match)
Query page Integer No The page number you want to search (default 1)
Query itemsPerPage Integer No Number of searches per page for which you want results (default 10)
Query sort List<String> No Sort order (default id.scopeId,ASC)

Response Body

{
  "totalItems" : 0,
  "scopeIds" : [ "scopeIds", "scopeIds" ],
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
GetAllScopeIds.Response
Name Type Required Description
scopeIds List<String> No List of Scope IDs
totalItems Long Yes Total number

Get a single scope

GET "/role/v3.0/appkeys/{appKey}/scopes/{scopeId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes
Path scopeId String Yes

Response Body

{
  "scope" : {
    "scopeId" : "scopeId",
    "description" : "description"
  },
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
GetScope.Response
Name Type Required Description
scope ScopeProtocol No Scope
ScopeProtocol
Name Type Required Description
description String No Scope description
scopeId String Yes Scope ID

Get a list of scopes

POST "/role/v3.0/appkeys/{appKey}/scopes/search"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes
Query page Integer No The page number you want to search (default 1)
Query itemsPerPage Integer No Number of searches per page for which you want results (default 10)
Query sort List<String> No Sort order (default id.scopeId,ASC)
Request Body PostSearchScopes.Request PostSearchScopes.Request Yes
PostSearchScopes.Request
Name Type Required Description
descriptionLike String No Scope description (partial match)
scopeIdPreLike String No Scope ID (forward match)
scopeIds List<String> No List of scope IDs (exact match)

Response Body

{
  "totalItems" : 0,
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  },
  "scopes" : [ {
    "scopeId" : "scopeId",
    "description" : "description"
  }, {
    "scopeId" : "scopeId",
    "description" : "description"
  } ]
}
PostSearchScopes.Response
Name Type Required Description
scopes List No Scope list
totalItems Long No Total number of scopes
ScopeProtocol
Name Type Required Description
description String No Scope description
scopeId String Yes Scope ID

Modify scope

PUT "/role/v3.0/appkeys/{appKey}/scopes/{scopeId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes
Path scopeId String Yes
Request Body UpdateScope.Request UpdateScope.Request Yes
UpdateScope.Request
Name Type Required Description
description String No Description

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Resource

Method HTTP request Description
POST /role/v3.0/appkeys/{appKey}/resources Create Resources
DELETE /role/v3.0/appkeys/{appKey}/resources/{resourceId} Delete Resource
DELETE /role/v3.0/appkeys/{appKey}/resources Delete Resources
GET /role/v3.0/appkeys/{appKey}/resources/{resourceId} Single resource lookup
POST /role/v3.0/appkeys/{appKey}/resources/id Get a list of resource IDs
POST /role/v3.0/appkeys/{appKey}/resources/attributes/search Get a list of all condition attributes that can be set in a role
POST /role/v3.0/appkeys/{appKey}/resources/search Get a list of resources
PUT /role/v3.0/appkeys/{appKey}/resources/{resourceId} Modify Resources

Create Resources

POST "/role/v3.0/appkeys/{appKey}/resources"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Request Body CreateResource.Request CreateResource.Request Yes
CreateResource.Request
Name Type Required Description
description String No Resource descriptions
metadata String No Metadata
name String No Resource name
path String Yes Resource Path
priority Integer Yes Priority
resourceId String No Resource ID
uiPath String Yes Resource UI Path

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Delete Resource

DELETE "/role/v3.0/appkeys/{appKey}/resources/{resourceId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Path resourceId String Yes Resource ID

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Delete resources

DELETE "/role/v3.0/appkeys/{appKey}/resources"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes Secretkey
Path appKey String Yes Appkey
Request Body resourceIds List<String> Yes Resource IDs

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Single resource lookup

GET "/role/v3.0/appkeys/{appKey}/resources/{resourceId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Path resourceId String Yes Resource ID

Response Body

{
  "resource" : {
    "path" : "path",
    "metadata" : "metadata",
    "resourceId" : "resourceId",
    "name" : "name",
    "description" : "description",
    "priority" : -27519,
    "uiPath" : "uiPath"
  },
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
GetResource.Response
Name Type Required Description
resource ResourceProtocol No Resource
ResourceProtocol
Name Type Required Description
description String No Resource descriptions
metadata String No Metadata
name String No Resource name
path String Yes Resource Path
priority Integer Yes Priority
resourceId String No Resource ID
uiPath String Yes Resource UI Path

Get a list of resource IDs

POST "/role/v3.0/appkeys/{appKey}/resources/id"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Query page Integer No The page number you want to search (default 1)
Query itemsPerPage Integer No Number of searches per page for which you want results (default 10)
Query sort List<String> No Sort order (default id.resourceId,ASC)
Request Body GetAllResourceIds.Request GetAllResourceIds.Request Yes
GetAllResourceIds.Request
Name Type Required Description
operationIds List<String> No Resource ID (forward matching)
resourceIdPreLike String No User IDs that have access to the resource
roleIds List<String> No Role ID assigned to the resource
userIds List<String> No Operation ID assigned to the resource

Response Body

{
  "totalItems" : 0,
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  },
  "resourceIds" : [ "resourceIds", "resourceIds" ]
}
GetAllResourceIds.Response
Name Type Required Description
resourceIds List<String> Yes Resource ID list
totalItems Long Yes Total number

Get a list of all condition attributes that can be set in a role

POST "/role/v3.0/appkeys/{appKey}/resources/attributes/search"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Query page Integer No The page number you want to search (default 1)
Query itemsPerPage Integer No Number of searches per page for which you want results (default 10)
Query sort List<String> No Sort order (default id.attributeId,ASC)
Request Body SearchResourceAttributes.Request SearchResourceAttributes.Request Yes
SearchResourceAttributes.Request
Name Type Required Description
operationId String Yes Operation ID
resourceId String No Resource ID, or by ID only if both ID and Path are present
resourcePath String No Resource Path

Response Body

{
  "totalItems" : 0,
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  },
  "attributes" : [ {
    "attributeId" : "attributeId",
    "description" : "description",
    "attributeName" : "attributeName"
  }, {
    "attributeId" : "attributeId",
    "description" : "description",
    "attributeName" : "attributeName"
  } ]
}
SearchResourceAttributes.Response
Name Type Required Description
attributes List<AttributeProtocol> Yes List of condition attributes that can be assigned to resources
totalItems Long Yes Total number
AttributeProtocol
Name Type Required Description
attributeCreationTypeCode String Yes COMMON_ATTRIBUTE, ROLE_ATTRIBUTE
attributeDataTypeCode String Yes STRING, NUMERIC, DAY_OF_WEEK, DATETIME, TIME, IPADDRESS, BOOLEAN
attributeId String Yes Condition attribute ID
attributeName String No Condition attribute name
description String No Condition attribute description

Get a list of resources

POST "/role/v3.0/appkeys/{appKey}/resources/search"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Query page Integer No The page number you want to search (default 1)
Query itemsPerPage Integer No Number of searches per page for which you want results (default 10)
Query sort List<String> No Sort order (default uiPath,ASC)
Request Body PostSearchResources.Request PostSearchResources.Request Yes
PostSearchResources.Request
Name Type Required Description
operationIds List<String> No List of Operation IDs assigned to resources
resourceIdPreLike String No Resource ID (forward matching)
resourceIds List<String> No Resource ID list
resourcePath String No Resource Path (exact match)
resourcePathLike String No Resource Path (forward matching)
resourcePaths List<String> No Resource Path list (exact match)
resourceUiPath String No Resource UI Path (exact match)
resourceUiPaths List<String> No Resource UI Path list (exact match)
roleIds List<String> No List of role IDs assigned to the resource
scopeIds List<String> No List of scope IDs accessible to the resource
searchRoleOptionCode String No How to retrieve the list of accessible roles DIRECT_ROLE, INDIRECT_ROLE
userIds List<String> No List of user IDs that have access to the resource

Response Body

{
  "totalItems" : 0,
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  },
  "resources" : [ {
    "path" : "path",
    "metadata" : "metadata",
    "resourceId" : "resourceId",
    "name" : "name",
    "description" : "description",
    "priority" : -27519,
    "uiPath" : "uiPath"
  }, {
    "path" : "path",
    "metadata" : "metadata",
    "resourceId" : "resourceId",
    "name" : "name",
    "description" : "description",
    "priority" : -27519,
    "uiPath" : "uiPath"
  } ]
}
PostSearchResources.Response
Name Type Required Description
Resources List Yes Resource List
totalItems Long Yes Total number
ResourceProtocol
Name Type Required Description
description String No Resource descriptions
metadata String No Metadata
name String No Resource name
path String Yes Resource Path
priority Integer Yes Priority
resourceId String No Resource ID
uiPath String Yes Resource UI Path

Modify Resources

PUT "/role/v3.0/appkeys/{appKey}/resources/{resourceId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Path resourceId String Yes Resource ID
Request Body UpdateResource.Request UpdateResource.Request Yes
UpdateResource.Request
Name Type Required Description
description String No Resource descriptions
metadata String No Metadata
name String No Resource name
newResourceId String No Resource ID to change
path String Yes Resource Path
priority Integer Yes Priority
uiPath String Yes Resource UI Path

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Resource hierarchy

Method HTTP request Description
GET /role/v3.0/appkeys/{appKey}/resources/{resourceId}/sub-resources Viewing child resource pages on a UI PATH
POST /role/v3.0/appkeys/{appKey}/resources/hierarchy/search Get Resource Hierarchy

Viewing child resource pages on a UI PATH

GET "/role/v3.0/appkeys/{appKey}/resources/{resourceId}/sub-resources"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Path resourceId String Yes Resource ID
Query userId String No User ID
Query roleId String No Role ID
Query operationId String No Operation ID
Query scopeId String No Scope ID
Query depth Integer No Hierarchy depth of children in the Resource UI Path
Query limit Integer No The position of the list to return. default: INT_MAX
Query offset Integer No The starting position of the list to return. default: 0

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  },
  "resources" : [ {
    "path" : "path",
    "metadata" : "metadata",
    "resourceId" : "resourceId",
    "name" : "name",
    "description" : "description",
    "priority" : -27519,
    "uiPath" : "uiPath"
  }, {
    "path" : "path",
    "metadata" : "metadata",
    "resourceId" : "resourceId",
    "name" : "name",
    "description" : "description",
    "priority" : -27519,
    "uiPath" : "uiPath"
  } ],
  "totalItemCount" : 0
}
GetSubResources.Response
Name Type Required Description
Resources List No Resource List
totalItemCount Long No Total number of resources
ResourceProtocol
Name Type Required Description
description String No Resource descriptions
metadata String No Metadata
name String No Resource name
path String Yes Resource Path
priority Integer Yes Priority
resourceId String No Resource ID
uiPath String Yes Resource UI Path

Get Resource Hierarchy

POST "/role/v3.0/appkeys/{appKey}/resources/hierarchy/search"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Request Body SearchResourceHierarchy.Request SearchResourceHierarchy.Request Yes
SearchResourceHierarchy.Request
Name Type Required Description
operationIds List<String> No List of user IDs that have access to the resource
resourceIds List<String> No List of role IDs assigned to the resource
resourcePath String No List of operation IDs assigned to the resource
resourceUiPath String No List of scope IDs assigned to the user
roleIds List<String> No List of Root Resource IDs in the hierarchy
scopeIds List<String> No Root Resource Path in the hierarchy
userIds List<String> No Root Resource Ui Path in Hierarchy

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  },
  "resources" : [ {
    "path" : "path",
    "metadata" : "metadata",
    "resourceId" : "resourceId",
    "name" : "name",
    "description" : "description",
    "resources" : [ null, null ],
    "priority" : -27519,
    "uiPath" : "uiPath"
  }, {
    "path" : "path",
    "metadata" : "metadata",
    "resourceId" : "resourceId",
    "name" : "name",
    "description" : "description",
    "resources" : [ null, null ],
    "priority" : -27519,
    "uiPath" : "uiPath"
  } ]
}
SearchResourceHierarchy.Response
Name Type Required Description
Resources Set No Resource hierarchy list
SearchResourceHierarchy.ResourceHierarchyProtocol
Name Type Required Description
description String No Resource descriptions
metadata String No Metadata
name String No Resource name
path String Yes Resource Path
priority Integer Yes Priority
resourceId String No Resource ID
Resources Set No List of resources in the child hierarchy
uiPath String Yes Resource UI Path
SearchResourceHierarchy.ResourceHierarchyProtocol
Name Type Required Description
description String No Resource descriptions
metadata String No Metadata
name String No Resource name
path String Yes Resource Path
priority Integer Yes Priority
resourceId String No Resource ID
Resources Set No List of resources in the child hierarchy
uiPath String Yes Resource UI Path
SearchResourceHierarchy.ResourceHierarchyProtocol
Name Type Required Description
description String No Resource descriptions
metadata String No Metadata
name String No Resource name
path String Yes Resource Path
priority Integer Yes Priority
resourceId String No Resource ID
Resources Set No List of resources in the child hierarchy
uiPath String Yes Resource UI Path
SearchResourceHierarchy.ResourceHierarchyProtocol
Name Type Required Description
description String No Resource descriptions
metadata String No Metadata
name String No Resource name
path String Yes Resource Path
priority Integer Yes Priority
resourceId String No Resource ID
Resources Set No List of resources in the child hierarchy
uiPath String Yes Resource UI Path

(../Models/SearchResourceHierarchy.ResourceHierarchyProtocol.md)

Method HTTP request Description
POST /role/v3.0/appkeys/{appKey}/resources/{resourceId}/authorizations Add a resource role relation
GET /role/v3.0/appkeys/{appKey}/resources/{resourceId}/authorizations Get a list of resource role relations
DELETE /role/v3.0/appkeys/{appKey}/resources/{resourceId}/authorizations Delete a resource role relation

Add a resource role relation

POST "/role/v3.0/appkeys/{appKey}/resources/{resourceId}/authorizations"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Path resourceId String Yes Resource ID
Request Body AddAuthorization.Request AddAuthorization.Request Yes
AddAuthorization.Request
Name Type Required Description
operationId String Yes Operation ID
propagation Boolean No Whether to apply the specified role equally to all parent paths except Root.
roleId String Yes Role ID

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Get a list of resource role relations

GET "/role/v3.0/appkeys/{appKey}/resources/{resourceId}/authorizations"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Path resourceId String Yes Resource ID

Response Body

{
  "authorizations" : [ {
    "resourceId" : "resourceId",
    "roleId" : "roleId",
    "operationId" : "operationId"
  }, {
    "resourceId" : "resourceId",
    "roleId" : "roleId",
    "operationId" : "operationId"
  } ],
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
GetAuthorizations.Response
Name Type Required Description
authorizations List No Resource role relation list
ResourceAuthorizationProtocol
Name Type Required Description
operationId String Yes Operation ID
resourceId String Yes Resource ID
roleId String Yes Role Id

Delete a resource role relation

DELETE "/role/v3.0/appkeys/{appKey}/resources/{resourceId}/authorizations"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Path resourceId String Yes Resource ID
Query operationId String Yes Operation ID
Query roleId String Yes Role ID

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Operations

Method HTTP request Description
POST /role/v3.0/appkeys/{appKey}/operations Create an operation
DELETE /role/v3.0/appkeys/{appKey}/operations/{operationId} Delete operations
DELETE /role/v3.0/appkeys/{appKey}/operations Delete operations
GET /role/v3.0/appkeys/{appKey}/operations/{operationId} Single operation lookup
GET /role/v3.0/appkeys/{appKey}/operations/id Get all operation IDs
POST /role/v3.0/appkeys/{appKey}/operations/search Get Operations List (Conditions/Paging)
PUT /role/v3.0/appkeys/{appKey}/operations/{operationId} Modifying operations

Create an operation

POST "/role/v3.0/appkeys/{appKey}/operations"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Request Body CreateOperation.Request CreateOperation.Request Yes
CreateOperation.Request
Name Type Required Description
description String No Operation description
operationId String Yes Operation ID

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Delete operations

DELETE "/role/v3.0/appkeys/{appKey}/operations/{operationId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes
Path operationId String Yes

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Delete operatios

DELETE "/role/v3.0/appkeys/{appKey}/operations"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes Secretkey
Path appKey String Yes Appkey
Request Body operationIds List<String> Yes Operation IDs

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Single operation lookup

GET "/role/v3.0/appkeys/{appKey}/operations/{operationId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes
Path operationId String Yes

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  },
  "operation" : {
    "description" : "description",
    "operationId" : "operationId",
    "appKey" : "appKey"
  }
}
GetOperation.Response
Name Type Required Description
operation OperationResponseProtocol Yes Operations
OperationResponseProtocol
Name Type Required Description
appKey String No Appkey
description String No Operation description
operationId String Yes Operation ID

Get all operation IDs

GET "/role/v3.0/appkeys/{appKey}/operations/id"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes
Query operationIdPreLike String No Operation ID (forward matching)
Query page Integer No The page number you want to search (default 1)
Query itemsPerPage Integer No Number of searches per page for which you want results (default 10)
Query sort List<String> No Sort order (default id.operationId,ASC)

Response Body

{
  "totalItems" : 0,
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  },
  "operationIds" : [ "operationIds", "operationIds" ]
}
GetAllOperationIds.Response
Name Type Required Description
operationIds List<String> Yes Operation ID list
totalItems Long Yes Total number

Get Operations List (Conditions/Paging)

POST "/role/v3.0/appkeys/{appKey}/operations/search"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Query page Integer No The page number you want to search (default 1)
Query itemsPerPage Integer No Number of searches per page for which you want results (default 10)
Query sort List<String> No Sort order (default id.operationId,ASC)
Request Body PostSearchOperations.Request PostSearchOperations.Request Yes
PostSearchOperations.Request
Name Type Required Description
descriptionLike String No Operation description (partial match)
operationIdPreLike String No Operation ID (forward matching)
operationIds List<String> No Operation ID list (exact match)

Response Body

{
  "totalItems" : 0,
  "operations" : [ {
    "description" : "description",
    "operationId" : "operationId",
    "appKey" : "appKey"
  }, {
    "description" : "description",
    "operationId" : "operationId",
    "appKey" : "appKey"
  } ],
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
PostSearchOperations.Response
Name Type Required Description
operations List Yes List of operations
totalItems Long Yes Total number
OperationResponseProtocol
Name Type Required Description
appKey String No Appkey
description String No Operation description
operationId String Yes Operation ID

Modifying operations

PUT "/role/v3.0/appkeys/{appKey}/operations/{operationId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes
Path operationId String Yes
Request Body UpdateOperation.Request UpdateOperation.Request Yes
UpdateOperation.Request
Name Type Required Description
description String No Operation description

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Condition attribute

Method HTTP request Description
POST /role/v3.0/appkeys/{appKey}/attributes Create condition attribute
DELETE /role/v3.0/appkeys/{appKey}/attributes/{attributeId} Delete condition attribute
DELETE /role/v3.0/appkeys/{appKey}/attributes Delete condition attributes
GET /role/v3.0/appkeys/{appKey}/attributes/{attributeId} Single lookup of condition attribute
POST /role/v3.0/appkeys/{appKey}/attributes/id Get a list of condition attributes IDs
POST /role/v3.0/appkeys/{appKey}/attributes/search Get a list of condition attributes
PUT /role/v3.0/appkeys/{appKey}/attributes/{attributeId} Modify condition attributes

Create condition attribute

POST "/role/v3.0/appkeys/{appKey}/attributes"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Request Body CreateAttribute.Request CreateAttribute.Request Yes
CreateAttribute.Request
Name Type Required Description
attributeDataTypeCode String Yes STRING, NUMERIC, DAY_OF_WEEK, DATETIME, TIME, IPADDRESS, BOOLEAN
attributeId String Yes Condition attribute ID
attributeName String No Condition attribute name
attributeRoleRelationIds List<String> No List of role IDs associated with the condition attribute
attributeTagIds List<String> No List of condition attribute tag IDs
description String No Condition attribute description

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Delete condition attribute

DELETE "/role/v3.0/appkeys/{appKey}/attributes/{attributeId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Path attributeId String Yes Condition attribute ID
Query forceDelete Boolean No Force delete, default (false)

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Delete condition attributes

DELETE "/role/v3.0/appkeys/{appKey}/attributes"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes Secret key
Path appKey String Yes Appkey
Request Body attributeIds List<String> Yes Condition attribute IDs
Request Body forceDelete Boolean No Force delete, default value (false)

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Single lookup of condition attribute

GET "/role/v3.0/appkeys/{appKey}/attributes/{attributeId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Path attributeId String Yes Condition attribute ID

Response Body

{
  "attributeInUse" : true,
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  },
  "attribute" : {
    "attributeId" : "attributeId",
    "attributeRoleRelations" : [ {
      "attributeId" : "attributeId",
      "exposureOrder" : 0,
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "regYmdt" : "2000-01-23T04:56:07.000+00:00",
      "roleGroup" : "roleGroup"
    }, {
      "attributeId" : "attributeId",
      "exposureOrder" : 0,
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "regYmdt" : "2000-01-23T04:56:07.000+00:00",
      "roleGroup" : "roleGroup"
    } ],
    "attributeTags" : [ {
      "attributeId" : "attributeId",
      "attributeTagId" : "attributeTagId",
      "regYmdt" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "attributeId" : "attributeId",
      "attributeTagId" : "attributeTagId",
      "regYmdt" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "description" : "description",
    "attributeName" : "attributeName"
  }
}
GetAttribute.Response
Name Type Required Description
attribute AttributeBundleProtocol Yes Condition attribute
attributeInUse Boolean Yes Whether to use condition attributes
AttributeBundleProtocol
Name Type Required Description
attributeCreationTypeCode String Yes COMMON_ATTRIBUTE, ROLE_ATTRIBUTE
attributeDataTypeCode String Yes STRING, NUMERIC, DAY_OF_WEEK, DATETIME, TIME, IPADDRESS, BOOLEAN
attributeId String Yes Condition attribute ID
attributeName String No Condition attribute name
attributeRoleRelations List<AttributeRoleRelationProtocol> Yes List of role IDs associated with the condition attribute
attributeTags List<AttributeTagProtocol> Yes Condition attribute tag ID
description String No Condition attribute description
AttributeRoleRelationProtocol
Name Type Required Description
attributeId String Yes Condition attribute ID
description String No Role descriptions
exposureOrder Integer Yes Exposure order
regYmdt Date Yes When the role ID associated with the condition attribute was created
roleGroup String No Role group
roleId String Yes Role ID
roleName String No Role name
AttributeTagProtocol
Name Type Required Description
attributeId String Yes Condition attribute ID
attributeTagId String Yes Condition attribute tag ID
regYmdt Date Yes When the condition attribute tag was created

Get a list of condition attribute IDs

POST "/role/v3.0/appkeys/{appKey}/attributes/id"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Query page Integer No The page number you want to search (default 1)
Query itemsPerPage Integer No Number of searches per page for which you want results (default 10)
Query sort List<String> No Sort order (default id.attributeId,ASC)
Request Body SearchAttributes.Request SearchAttributes.Request Yes
SearchAttributes.Request
Name Type Required Description
attributeCreationTypeCodes List<AttributeCreationTypeCode> No Condition attribute creation types
attributeDataTypeCodes List<AttributeDataTypeCode> No Condition attribute data types
attributeIdPreLike String No Condition attribute tag ID list (front match)
attributeIds List<String> No Condition attribute ID list (exact match)
attributeTagIds List<String> No Condition attribute tag ID list (exact match)
descriptionLike String No Condition attribute descriptions (partial match)
roleIdPreLike String No Role ID (forward match)
roleIds List<String> No Role ID list (exact match)

Response Body

{
  "totalItems" : 0,
  "attributeIds" : [ "attributeIds", "attributeIds" ],
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
SearchAttributeIds.Response
Name Type Required Description
attributeIds List<String> Yes Condition attribute IDs
totalItems Long Yes Total number of roles

Get a list of condition attributes

POST "/role/v3.0/appkeys/{appKey}/attributes/search"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Query page Integer No The page number you want to search (default 1)
Query itemsPerPage Integer No Number of searches per page for which you want results (default 10)
Query sort List<String> No Sort order (default id.attributeId,ASC)
Request Body SearchAttributes.Request SearchAttributes.Request Yes
SearchAttributes.Request
Name Type Required Description
attributeCreationTypeCodes List<AttributeCreationTypeCode> No Condition attribute creation types
attributeDataTypeCodes List<AttributeDataTypeCode> No Condition attribute data types
attributeIdPreLike String No Condition attribute tag ID list (front match)
attributeIds List<String> No Condition attribute ID list (exact match)
attributeTagIds List<String> No Condition attribute tag ID list (exact match)
descriptionLike String No Condition attribute descriptions (partial match)
roleIdPreLike String No Role ID (forward match)
roleIds List<String> No Role ID list (exact match)

Response Body

{
  "totalItems" : 6,
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  },
  "attributes" : [ {
    "attributeId" : "attributeId",
    "attributeRoleRelations" : [ {
      "attributeId" : "attributeId",
      "exposureOrder" : 0,
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "regYmdt" : "2000-01-23T04:56:07.000+00:00",
      "roleGroup" : "roleGroup"
    }, {
      "attributeId" : "attributeId",
      "exposureOrder" : 0,
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "regYmdt" : "2000-01-23T04:56:07.000+00:00",
      "roleGroup" : "roleGroup"
    } ],
    "attributeTags" : [ {
      "attributeId" : "attributeId",
      "attributeTagId" : "attributeTagId",
      "regYmdt" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "attributeId" : "attributeId",
      "attributeTagId" : "attributeTagId",
      "regYmdt" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "description" : "description",
    "attributeName" : "attributeName"
  }, {
    "attributeId" : "attributeId",
    "attributeRoleRelations" : [ {
      "attributeId" : "attributeId",
      "exposureOrder" : 0,
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "regYmdt" : "2000-01-23T04:56:07.000+00:00",
      "roleGroup" : "roleGroup"
    }, {
      "attributeId" : "attributeId",
      "exposureOrder" : 0,
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "regYmdt" : "2000-01-23T04:56:07.000+00:00",
      "roleGroup" : "roleGroup"
    } ],
    "attributeTags" : [ {
      "attributeId" : "attributeId",
      "attributeTagId" : "attributeTagId",
      "regYmdt" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "attributeId" : "attributeId",
      "attributeTagId" : "attributeTagId",
      "regYmdt" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "description" : "description",
    "attributeName" : "attributeName"
  } ]
}
SearchAttributes.Response
Name Type Required Description
attributes List<AttributeBundleProtocol> Yes Condition attributes
totalItems Long Yes Total number of roles
AttributeBundleProtocol
Name Type Required Description
attributeCreationTypeCode String Yes COMMON_ATTRIBUTE, ROLE_ATTRIBUTE
attributeDataTypeCode String Yes STRING, NUMERIC, DAY_OF_WEEK, DATETIME, TIME, IPADDRESS, BOOLEAN
attributeId String Yes Condition attribute ID
attributeName String No Condition attribute name
attributeRoleRelations List<AttributeRoleRelationProtocol> Yes List of role IDs associated with the condition attribute
attributeTags List<AttributeTagProtocol> Yes Condition attribute tag ID
description String No Condition attribute description
AttributeRoleRelationProtocol
Name Type Required Description
attributeId String Yes Condition attribute ID
description String No Role descriptions
exposureOrder Integer Yes Exposure order
regYmdt Date Yes When the role ID associated with the condition attribute was created
roleGroup String No Role group
roleId String Yes Role ID
roleName String No Role name
AttributeTagProtocol
Name Type Required Description
attributeId String Yes Condition attribute ID
attributeTagId String Yes Condition attribute tag ID
regYmdt Date Yes When the condition attribute tag was created

Modify condition attributes

PUT "/role/v3.0/appkeys/{appKey}/attributes/{attributeId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Path attributeId String Yes Condition attribute ID
Request Body UpdateAttribute.Request UpdateAttribute.Request Yes
UpdateAttribute.Request
Name Type Required Description
attributeDataTypeCode String Yes STRING, NUMERIC, DAY_OF_WEEK, DATETIME, TIME, IPADDRESS, BOOLEAN
attributeName String No Condition attribute name
attributeRoleRelationIds List<String> No List of role IDs associated with the condition attribute
attributeTagIds List<String> No List of condition attribute tag IDs
description String No Condition attribute description

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Condition attribute data types

Method HTTP request Description
POST /role/v3.0/appkeys/{appKey}/attributes/data-types Get condition attribute data types
POST /role/v3.0/appkeys/{appKey}/attributes/condition/validate Validating condition values

Get condition attribute data types

POST "/role/v3.0/appkeys/{appKey}/attributes/data-types"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey

Response Body

{
  "dataTypes" : [ {
    "operators" : [ {
      "min" : 6,
      "max" : 0,
      "operatorTypeCode" : "operatorTypeCode"
    }, {
      "min" : 6,
      "max" : 0,
      "operatorTypeCode" : "operatorTypeCode"
    } ],
    "dataType" : "dataType"
  }, {
    "operators" : [ {
      "min" : 6,
      "max" : 0,
      "operatorTypeCode" : "operatorTypeCode"
    }, {
      "min" : 6,
      "max" : 0,
      "operatorTypeCode" : "operatorTypeCode"
    } ],
    "dataType" : "dataType"
  } ],
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
GetAttributeDataTypeResponse
Name Type Required Description
dataTypes List<GetAttributeDataTypeResponse.AttributeDataTypeProtocol> Yes Condition attribute data types
GetAttributeDataTypeResponse.AttributeDataTypeProtocol
Name Type Required Description
dataType String Yes Condition attribute data types
operators List<GetAttributeDataTypeResponse.AttributeOperatorTypeProtocol> Yes Operators available for condition attributes
GetAttributeDataTypeResponse.AttributeOperatorTypeProtocol
Name Type Required Description
max Integer Yes Maximum number of values an operator can take
min Integer Yes Minimum number of values an operator can take
operatorTypeCode String Yes Operator

Validating condition values

POST "/role/v3.0/appkeys/{appKey}/attributes/condition/validate"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Request Body ValidateConditionValuesRequest ValidateConditionValuesRequest Yes
ValidateConditionValuesRequest
Name Type Required Description
conditions List Yes Role Condition Attributes
ConditionProtocol
Name Type Required Description
attributeId String Yes Condition attribute ID
attributeOperatorTypeCode String Yes ALL_CONTAINS, ANY_CONTAINS, NOT_CONTAINS, ANY_MATCH, NONE_MATCH, BETWEEN, BEYOND, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO, ALLOW, NOT_ALLOW, TRUE, FALSE
attributeValues List<String> No Condition attribute value

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Condition attribute role associations

Method HTTP request Description
POST /role/v3.0/appkeys/{appKey}/attributes/{attributeId}/roles Create multiple roles associated with condition attributes
DELETE /role/v3.0/appkeys/{appKey}/attributes/{attributeId}/roles Delete multiple roles associated with condition attributes
POST /role/v3.0/appkeys/{appKey}/attributes/{attributeId}/roles/search Get roles associated with condition attributes

Create multiple roles associated with condition attributes

POST "/role/v3.0/appkeys/{appKey}/attributes/{attributeId}/roles"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Path attributeId String Yes Condition attribute ID
Request Body CreateAttributeRoleRelations.Request CreateAttributeRoleRelations.Request Yes
CreateAttributeRoleRelations.Request
Name Type Required Description
attributeRoleRelationIds List<String> Yes List of role IDs associated with the condition attribute

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Delete multiple roles associated with condition attributes

DELETE "/role/v3.0/appkeys/{appKey}/attributes/{attributeId}/roles"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Path attributeId String Yes Condition attribute ID
Request Body DeleteAttributeRoleRelations.Request DeleteAttributeRoleRelations.Request Yes
DeleteAttributeRoleRelations.Request
Name Type Required Description
attributeRoleRelationIds List<String> Yes List of role IDs associated with the condition attribute

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Get roles associated with condition attributes

POST "/role/v3.0/appkeys/{appKey}/attributes/{attributeId}/roles/search"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Path attributeId String Yes Condition attribute ID
Query page Integer No The page number you want to search (default 1)
Query itemsPerPage Integer No Number of searches per page for which you want results (default 10)
Query sort List<String> No Sort order (default attribute.id.attributeId,ASC)
Request Body SearchAttributeRoleRelations.Request SearchAttributeRoleRelations.Request Yes
SearchAttributeRoleRelations.Request
Name Type Required Description
roleIdPreLike String No Role ID associated with condition attributes (front match)
roleIds List<String> No Role IDs associated with condition attributes (exact match)
searchRoleOptionCode String No DIRECT_ROLE, INDIRECT_ROLE

Response Body

{
  "attributeRoleRelations" : [ {
    "attributeId" : "attributeId",
    "exposureOrder" : 0,
    "roleId" : "roleId",
    "roleName" : "roleName",
    "description" : "description",
    "regYmdt" : "2000-01-23T04:56:07.000+00:00",
    "roleGroup" : "roleGroup"
  }, {
    "attributeId" : "attributeId",
    "exposureOrder" : 0,
    "roleId" : "roleId",
    "roleName" : "roleName",
    "description" : "description",
    "regYmdt" : "2000-01-23T04:56:07.000+00:00",
    "roleGroup" : "roleGroup"
  } ],
  "totalItems" : 0,
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
SearchAttributeRoleRelations.Response
Name Type Required Description
attributeRoleRelations List<AttributeRoleRelationProtocol> Yes Roles associated with condition attributes
totalItems Long Yes Total number of roles
AttributeRoleRelationProtocol
Name Type Required Description
attributeId String Yes Condition attribute ID
description String No Role descriptions
exposureOrder Integer Yes Exposure order
regYmdt Date Yes When the role ID associated with the condition attribute was created
roleGroup String No Role group
roleId String Yes Role ID
roleName String No Role name

Condition Attribute Tag

Method HTTP request Description
POST /role/v3.0/appkeys/{appKey}/attributes/{attributeId}/tags Create condition attribute tag
DELETE /role/v3.0/appkeys/{appKey}/attributes/{attributeId}/tags Delete condition attribute tag
POST /role/v3.0/appkeys/{appKey}/attributes/tags/id Get a list of condition attribute tag IDs
POST /role/v3.0/appkeys/{appKey}/attributes/tags/search Get a list of condition attribute tags

Create condition attribute tag

POST "/role/v3.0/appkeys/{appKey}/attributes/{attributeId}/tags"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Path attributeId String Yes Condition attribute ID
Request Body CreateAttributeTags.Request CreateAttributeTags.Request Yes
CreateAttributeTags.Request
Name Type Required Description
attributeTagIds List<String> Yes List of condition attribute tag IDs

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Delete condition attribute tag

DELETE "/role/v3.0/appkeys/{appKey}/attributes/{attributeId}/tags"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Path attributeId String Yes Condition attribute ID
Request Body DeleteAttributeTags.Request DeleteAttributeTags.Request Yes
DeleteAttributeTags.Request
Name Type Required Description
attributeTagIds List<String> Yes List of condition attribute tag IDs

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Get a list of condition attribute tag IDs

POST "/role/v3.0/appkeys/{appKey}/attributes/tags/id"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Query page Integer No The page number you want to search (default 1)
Query itemsPerPage Integer No Number of searches per page for which you want results (default 10)
Query sort List<String> No Sort order (default id.attributeTagId,ASC)
Request Body SearchAttributeTagIds.Request SearchAttributeTagIds.Request Yes
SearchAttributeTagIds.Request
Name Type Required Description
attributeIdPreLike String No Condition attribute tag ID list (front match)
attributeIds List<String> No Condition attribute ID list (exact match)
attributeTagIdPreLike String No Condition attribute tag ID (front match)
attributeTagIds List<String> No Condition attribute tag ID list (exact match)

Response Body

{
  "attributeTagIds" : [ "attributeTagIds", "attributeTagIds" ],
  "totalItems" : 0,
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
SearchAttributeTagIds.Response
Name Type Required Description
attributeTagIds List<String> Yes List of condition attribute tag IDs
totalItems Long Yes Total number of roles

Get a list of condition attribute tags

POST "/role/v3.0/appkeys/{appKey}/attributes/tags/search"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Query page Integer No The page number you want to search (default 1)
Query itemsPerPage Integer No Number of searches per page for which you want results (default 10)
Query sort List<String> No Sort order (default id.attributeTagId,ASC)
Request Body SearchAttributeTags.Request SearchAttributeTags.Request Yes
SearchAttributeTags.Request
Name Type Required Description
attributeIdPreLike String No Condition attribute tag ID list (front match)
attributeIds List<String> No Condition attribute ID list (exact match)
attributeTagIdPreLike String No Condition attribute tag ID (front match)
attributeTagIds List<String> No Condition attribute tag ID list (exact match)

Response Body

{
  "totalItems" : 0,
  "attributeTags" : [ {
    "attributeId" : "attributeId",
    "attributeTagId" : "attributeTagId",
    "regYmdt" : "2000-01-23T04:56:07.000+00:00"
  }, {
    "attributeId" : "attributeId",
    "attributeTagId" : "attributeTagId",
    "regYmdt" : "2000-01-23T04:56:07.000+00:00"
  } ],
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
SearchAttributeTags.Response
Name Type Required Description
attributeTags List<AttributeTagProtocol> Yes Condition Attribute Tag List
totalItems Long Yes Total number of roles
AttributeTagProtocol
Name Type Required Description
attributeId String Yes Condition attribute ID
attributeTagId String Yes Condition attribute tag ID
regYmdt Date Yes When the condition attribute tag was created

Settings

Method HTTP request Description
PUT /role/v3.0/appkeys/{appKey}/config/cache-evict Purge the cache of the Role Service server and the Client SDK
GET /role/v3.0/appkeys/{appKey}/config Get settings
PUT /role/v3.0/appkeys/{appKey}/config Modify settings

Purge the cache of the server and client SDKs

PUT "/role/v3.0/appkeys/{appKey}/config/cache-evict"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

Get settings

GET "/role/v3.0/appkeys/{appKey}/config"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
GetTenantConfigResponse
Name Type Required Description
resourcePathTrailingSlashMatchPolicyCode String Yes IDENTICAL_PATH, NON_IDENTICAL_PATH

Modify settings

PUT "/role/v3.0/appkeys/{appKey}/config"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes SecretKey
Path appKey String Yes Appkey
Request Body UpdateConfig.Request UpdateConfig.Request Yes
UpdateConfig.Request
Name Type Required Description
cacheSize Integer No Authentication cache size based on resource identity
cacheSizeByPath Integer No Resource Hierarchy Lookup Cache Size
cacheSizeTree Integer No Resource Path-based authentication cache size
cacheTtl Integer No Cache data retention time (in seconds)
resourcePathTrailingSlashMatchPolicyCode String No IDENTICAL_PATH, NON_IDENTICAL_PATH

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
Table of Contents
TOP