Use this object to manage CA AppLogic user accounts.
|
Method |
Description |
|
Retrieve list of users |
|
|
Retrieve information for a user |
|
|
Create a user |
|
|
Destroy a user |
|
|
Set information for a user |
|
|
Unlock a user |
|
|
Retrieve the new object ACL definition associated to a user |
|
|
Replace the entire new object ACL definition associated to a user |
|
|
Replace portion of a new object ACL definition associated to a user |
Retrieve list of users for a grid
/api/v2/user/list?vdc=controller-name
Name of the target virtual data center
synchronous
GET
Retrieve list of users.
GET http://192.168.123.200/api/v2/user/list?vdc=mygrid
<users>
<user>
<loginenabled>1</loginenabled>
<loginname>ak</loginname>
<realname></realname>
<scope>local</scope>
</user>
<user>
<loginenabled>1</loginenabled>
<loginname>api</loginname>
<realname></realname>
<scope>local</scope>
</user>
</users>
{
"user" : [
{
"realname" : "",
"loginenabled" : "1",
"loginname" : "api",
"scope" : "local"
},
{
"realname" : "",
"loginenabled" : "1",
"loginname" : "ak",
"scope" : "local"
}
]
}
Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.
Retrieve information for a user
/api/v2/user/info?user=user&vdc=controller-name
Username
Name of the target virtual data center
synchronous
GET
Retrieve information for a user named test@CA.com.
GET http://192.168.123.200/api/v2/user/info?user=test@CA.com&vdc=mygrid
<opt>
<user0>
<loginenabled>1</loginenabled>
<loginname>ak</loginname>
<realname></realname>
<scope>local</scope>
</user0>
</opt>
{
"user1" : {
"realname" : "",
"loginenabled" : "1",
"loginname" : "api",
"scope" : "local"
}
Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.
Missing required arguments (user). - Argument user=username missing in the request.
unknown@CA.NOSPAM.com does not exist. - Invalid user specified in the request.
Create a user
/api/v2/user/create?user=user&pwd=password&vdc=controller-name
Username
User password
Name of the target virtual data center
A comma-separated list of groups the user must become a member of
The first group in the list becomes the user’s primary group.
User profile property settings
User’s password
A public SSH key to install as the user’s access key to the CLI.
Must be either RSA or DSA base-64 encoded.
Note: See User Management in the Command Line Shell Reference for descriptions of the options available for this command.
synchronous
GET
Create a user named test@CA.com.
GET http://192.168.123.200/api/v2/user/create?user=test@CA.com&pwd=password&vdc=mygrid
<message></message>
{
"message" :""
}
Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.
Missing required arguments (user). - Argument user=username missing in the request.
Missing required arguments (pwd). - Argument pwd=password missing in the request.
unknown@CA.NOSPAM.com already exists. - User specified in the request already exists.
Destroy a user
/api/v2/user/destroy?user=user&vdc=controller-name
Username
Name of the target virtual data center
synchronous
GET
Destroy a user named test@CA.com.
GET http://192.168.123.200/api/v2/user/destroy?user=test@3teraCAvdc=mygrid
<message></message>
{
"message" :""
}
Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.
Missing required arguments (user). - Argument user=username missing in the request.
unknown@CA.NOSPAM.com does not exist. - Invalid user specified in the request.
Set information for a user
/api/v2/user/set?user=user&vdc=controller-name
Name of the user
Name of the target virtual data center
A comma-separated list of groups the user must become a member of
The first group in the list becomes the user’s primary group.
User profile property settings
User’s password
A public SSH key to install as the user’s access key to the CLI.
Must be either RSA or DSA base-64 encoded.
Note: See User Management in the Command Line Shell Reference for descriptions of the options available for this command.
synchronous
GET
Set real name for a user named test@CA.com.
GET http://192.168.123.200/api/v2/user/set?user=test@CA.com&realname=John&vdc=mygrid
<message></message>
{
"message" :""
}
Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.
Missing required arguments (user). - Argument user=username missing in the request.
unknown@CA.NOSPAM.com does not exist. - Invalid user specified in the request.
Unlock a user
/api/v2/user/unlock?user=user&vdc=controller-name
Username
Name of the target virtual data center
synchronous
GET
Unlock user named test@CA.com.
GET http://192.168.123.200/api/v2/user/unlock?user=test@3teraCAvdc=mygrid
<message></message>
{
"message" :""
}
Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.
Missing required arguments (user). - Argument user=username missing in the request.
unknown@CA.NOSPAM.com does not exist. - Invalid user specified in the request.
Display the new object ACL definition associated to a user, or display that portion of the new object ACL definition which relates to a particular principal.
/api/v2/user/get_newobj_acl?user=user&principal=principal&vdc=vdc
Name of the user. Prepend the user name with / to indicate a global user.
A URL-encoded principal
Name of the target virtual data center
synchronous
GET
GET http://192.168.123.200/api/v2/user/get_newobj_acl?user=apiuser&principal=&vdc=mygrid
<acl>
<entries>
<entry>
<full>1</full>
<id>a5cb10bc-7291-4a86-84f8-74419fc9ae63</id>
</entry>
</entries>
<owner>
<id></id>
</owner>
</acl>
{
"acl" : {
"owner" : {
"id" : ""
},
"entries" : [
{
"id" : "a5cb10bc-7291-4a86-84f8-74419fc9ae63",
"full" : 1
}
]
}
}
Entity vdc vdc not found - A VDC name was specified that is not configured in the WS_API application.
Entity not found - There is no principal name match for 'principal'
Missing required arguments (user). - Argument user=user missing in the request.
Note: This API is available with WS_API_r10-1.0.10-1 and above.
Replace the entire new object ACL definition associated to a user.
/api/v2/user/put_newobj_acl?user=user&acl=<ACLs>&vdc=controller-name
Name of the user; prepend the user name with / to indicate a global user.
URL-encoded list of principals separated with a slash (/)
A URL-encoded principal
Name of the target virtual data center
synchronous
GET
GET http://192.168.123.200/api/v2/user/put_newobj_acl?user=apiusr&acl=apiusrp%3Downer%2Ftest%403tera.com%3Dconfigure&vdc=mygrid
{
"message" : ""
}
<message></message>
Entity vdc mygrid not found
- A VDC name was specified that is not configured in the WS_API application.
Entity not found - There is no principal name match for 'principal'
Missing required arguments (acl). - Argument acl=<ACL> missing in the request.
Missing required arguments (user). - Argument user=user missing in the request.
Note: This API is available with WS_API_r6-1.0.6-1 and above.
Replace that portion of a new object ACL definition associated to a user which relates to the owner or a principal entry.
/api/v2/user/modify_newobj_acl?user=user&acl=<ACLs>&vdc=controller-name
Name of the user; prepend the user name with / to indicate a global user.
URL-encoded list of principals separated with a slash (/)
Name of the target virtual data center
synchronous
GET
GET http://192.168.123.200/api/v2/user/modify_newobj_acl?user=apiusr&acl=apiusr%3Downer%2Ftest%403tera.com%3Dconfigure&vdc=mygrid
<message></message>
{
"message" : ""
}
Entity vdc controller-name not found - A VDC name was specified that is not configured in the WS_API application.
Entity not found - There is no principal name match for 'principal'
Missing required arguments (acl). - Argument acl=<ACL> missing in the request.
Missing required arguments (user). - Argument user=user missing in the request.
Note: This API is available with WS_API_r10-1.0.10-1 and above.
|
Copyright © 2013 CA Technologies.
All rights reserved.
|
|