as_admin.h File Reference

#include <aerospike/aerospike.h>
#include <aerospike/as_config.h>
#include <aerospike/as_key.h>

Include dependency graph for as_admin.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	as_privilege
struct	as_role
struct	as_user

Macros
#define	AS_ROLE_SIZE   64

Enumerations
enum	as_privilege_code {   AS_PRIVILEGE_USER_ADMIN = 0, AS_PRIVILEGE_SYS_ADMIN = 1, AS_PRIVILEGE_DATA_ADMIN = 2, AS_PRIVILEGE_UDF_ADMIN = 3,   AS_PRIVILEGE_SINDEX_ADMIN = 4, AS_PRIVILEGE_READ = 10, AS_PRIVILEGE_READ_WRITE = 11, AS_PRIVILEGE_READ_WRITE_UDF = 12,   AS_PRIVILEGE_WRITE = 13, AS_PRIVILEGE_TRUNCATE = 14 }

Functions
AS_EXTERN as_status	aerospike_change_password (aerospike *as, as_error *err, const as_policy_admin *policy, const char *user_name, const char *password)
AS_EXTERN as_status	aerospike_create_role (aerospike *as, as_error *err, const as_policy_admin *policy, const char *role, as_privilege **privileges, int privileges_size)
AS_EXTERN as_status	aerospike_create_role_quotas (aerospike *as, as_error *err, const as_policy_admin *policy, const char *role, as_privilege **privileges, int privileges_size, const char **whitelist, int whitelist_size, int read_quota, int write_quota)
AS_EXTERN as_status	aerospike_create_role_whitelist (aerospike *as, as_error *err, const as_policy_admin *policy, const char *role, as_privilege **privileges, int privileges_size, const char **whitelist, int whitelist_size)
AS_EXTERN as_status	aerospike_create_user (aerospike *as, as_error *err, const as_policy_admin *policy, const char *user_name, const char *password, const char **roles, int roles_size)
AS_EXTERN as_status	aerospike_drop_role (aerospike *as, as_error *err, const as_policy_admin *policy, const char *role)
AS_EXTERN as_status	aerospike_drop_user (aerospike *as, as_error *err, const as_policy_admin *policy, const char *user_name)
AS_EXTERN as_status	aerospike_grant_privileges (aerospike *as, as_error *err, const as_policy_admin *policy, const char *role, as_privilege **privileges, int privileges_size)
AS_EXTERN as_status	aerospike_grant_roles (aerospike *as, as_error *err, const as_policy_admin *policy, const char *user_name, const char **roles, int roles_size)
AS_EXTERN as_status	aerospike_query_role (aerospike *as, as_error *err, const as_policy_admin *policy, const char *role_name, as_role **role)
AS_EXTERN as_status	aerospike_query_roles (aerospike *as, as_error *err, const as_policy_admin *policy, as_role ***roles, int *roles_size)
AS_EXTERN as_status	aerospike_query_user (aerospike *as, as_error *err, const as_policy_admin *policy, const char *user_name, as_user **user)
AS_EXTERN as_status	aerospike_query_users (aerospike *as, as_error *err, const as_policy_admin *policy, as_user ***users, int *users_size)
AS_EXTERN as_status	aerospike_revoke_privileges (aerospike *as, as_error *err, const as_policy_admin *policy, const char *role, as_privilege **privileges, int privileges_size)
AS_EXTERN as_status	aerospike_revoke_roles (aerospike *as, as_error *err, const as_policy_admin *policy, const char *user_name, const char **roles, int roles_size)
AS_EXTERN as_status	aerospike_set_password (aerospike *as, as_error *err, const as_policy_admin *policy, const char *user_name, const char *password)
AS_EXTERN as_status	aerospike_set_quotas (aerospike *as, as_error *err, const as_policy_admin *policy, const char *role, int read_quota, int write_quota)
AS_EXTERN as_status	aerospike_set_whitelist (aerospike *as, as_error *err, const as_policy_admin *policy, const char *role, const char **whitelist, int whitelist_size)
as_status	as_authenticate (struct as_cluster_s *cluster, as_error *err, struct as_socket_s *sock, struct as_node_s *node, struct as_session_s *session, uint32_t socket_timeout, uint64_t deadline_ms)
uint32_t	as_authenticate_set (struct as_cluster_s *cluster, struct as_session_s *session, uint8_t *buffer)
as_status	as_cluster_login (struct as_cluster_s *cluster, as_error *err, struct as_socket_s *sock, uint64_t deadline_ms, struct as_node_info_s *node_info)
AS_EXTERN void	as_role_destroy (as_role *role)
AS_EXTERN void	as_roles_destroy (as_role **roles, int roles_size)
AS_EXTERN void	as_user_destroy (as_user *user)
AS_EXTERN void	as_users_destroy (as_user **users, int users_size)

Function Documentation

as_status as_authenticate ( struct as_cluster_s *  cluster, as_error *  err, struct as_socket_s *  sock, struct as_node_s *  node, struct as_session_s *  session, uint32_t  socket_timeout, uint64_t  deadline_ms  )

private

Authenticate user with a server node. This is done automatically after socket open. Do not use this method directly.

uint32_t as_authenticate_set ( struct as_cluster_s *  cluster, struct as_session_s *  session, uint8_t *  buffer  )

private

Write authentication command to buffer. Return buffer length.

as_status as_cluster_login ( struct as_cluster_s *  cluster, as_error *  err, struct as_socket_s *  sock, uint64_t  deadline_ms, struct as_node_info_s *  node_info  )

private

Login to node on node discovery. Do not use this method directly.