mongodb-atlas-api-client
npm
Atlas Admin API v2
Preparing search index...
CustomDbRole
Interface CustomDbRole
interface
CustomDbRole
{
create
(
role
:
CreateCustomDbRoleRequest
,
options
?:
AtlasClientOptions
,
)
:
Promise
<
AtlasError
|
GetCustomDbRoleResponse
>
;
delete
(
rolename
:
string
,
options
?:
AtlasClientOptions
,
)
:
Promise
<
void
|
AtlasError
>
;
get
(
rolename
:
string
,
options
?:
AtlasClientOptions
,
)
:
Promise
<
AtlasError
|
GetCustomDbRoleResponse
>
;
getAll
(
options
?:
AtlasClientOptions
,
)
:
Promise
<
AtlasError
|
GetAllCustomDbRolesResponse
>
;
update
(
rolename
:
string
,
role
:
UpdateCustomDbRoleRequest
,
options
?:
AtlasClientOptions
,
)
:
Promise
<
AtlasError
|
GetCustomDbRoleResponse
>
;
}
Index
Methods
create
delete
get
get
All
update
Methods
create
create
(
role
:
CreateCustomDbRoleRequest
,
options
?:
AtlasClientOptions
,
)
:
Promise
<
AtlasError
|
GetCustomDbRoleResponse
>
Parameters
role
:
CreateCustomDbRoleRequest
Optional
options
:
AtlasClientOptions
Returns
Promise
<
AtlasError
|
GetCustomDbRoleResponse
>
delete
delete
(
rolename
:
string
,
options
?:
AtlasClientOptions
,
)
:
Promise
<
void
|
AtlasError
>
Parameters
rolename
:
string
Optional
options
:
AtlasClientOptions
Returns
Promise
<
void
|
AtlasError
>
get
get
(
rolename
:
string
,
options
?:
AtlasClientOptions
,
)
:
Promise
<
AtlasError
|
GetCustomDbRoleResponse
>
Parameters
rolename
:
string
Optional
options
:
AtlasClientOptions
Returns
Promise
<
AtlasError
|
GetCustomDbRoleResponse
>
get
All
getAll
(
options
?:
AtlasClientOptions
,
)
:
Promise
<
AtlasError
|
GetAllCustomDbRolesResponse
>
Parameters
Optional
options
:
AtlasClientOptions
Returns
Promise
<
AtlasError
|
GetAllCustomDbRolesResponse
>
update
update
(
rolename
:
string
,
role
:
UpdateCustomDbRoleRequest
,
options
?:
AtlasClientOptions
,
)
:
Promise
<
AtlasError
|
GetCustomDbRoleResponse
>
Parameters
rolename
:
string
role
:
UpdateCustomDbRoleRequest
Optional
options
:
AtlasClientOptions
Returns
Promise
<
AtlasError
|
GetCustomDbRoleResponse
>
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Methods
create
delete
get
get
All
update
npm
Atlas Admin API v2
mongodb-atlas-api-client
Loading...