User¶

Overview¶

An administrator of a BIG-IQ can use the User API to list, create, or remove users on the BIG-IQ. By default, a new user has no access to resources on the BIG-IQ until added to system roles. An administrator can add a user to an RBAC role on the BIG-IQ using the User Role API.

REST Endpoint: /mgmt/shared/authz/users¶

Requests¶

GET /mgmt/shared/authz/users¶

Request Parameters¶

None

Query Parameters¶

None

Response¶

The JSON in the body of a GET response can contain the following parameters.

HTTP/1.1 200 OK

Name	Type	Description
items	array	An array of objects which list the BIG-IQ users.
displayName	string	A name for the user which can be displayed.
name	string	The user name.
selfLink	string	The URL of the user.

Permissions¶

Role	Allow
admin	Yes

POST /mgmt/shared/authz/users¶

To create a user, you can send a POST request to the collection.

Request Parameters¶

The JSON in the body of a POST request can contain the following parameters.

Name	Type	Required	Description
displayName	string	True	A name for the user which can be displayed.
name	string	True	The user name.
password	string	True	A password for the user.
password2	string	True	Repeat password for the user.

Query Parameters¶

None

Response¶

The JSON in the body of the response can contain the following parameters.

HTTP/1.1 200 OK

Name	Type	Description
displayName	string	A name for the user which can be displayed.
name	string	The user name.
selfLink	string	The URL of the user.

Permissions¶

Role	Allow
admin	Yes

DELETE /mgmt/shared/authz/users/<user_name>¶

To remove a user from the BIG-IQ you can send a DELETE request to the specific user endpoint. The placeholder <user_name> represents the value of name.

Request Parameters¶

None

Query Parameters¶

None

Response¶

The JSON in the body of the response contains the same JSON as the response to the GET for the deleted user.

HTTP/1.1 200 OK

Permissions¶

Role	Allow
admin	Yes

Examples¶

POST to create a new user¶

To create a new user, send a POST to the collection endpoint.

POST https://<BIG-IQ>/mgmt/shared/authz/users

The JSON in the body of the POST can contain the following parameters.

{
    "name": "user_name",
    "displayName": "firstname lastname",
    "password": "pass1",
    "password2": "pass2"
}

Response¶

The JSON in the response can look similar to the following example.

HTTP/1.1 200 OK

{
    "name": "user_name",
    "displayName": "firstname lastname",
    "selfLink": "https://localhost/mgmt/shared/authz/users/<user_name>"
    "generation": 1,
    "kind": "shared:authz:users:usersworkerstate"
    "lastUpdateMicros": 1581123863107550
}

GET to retrieve single user¶

To retrieve a single existing user, you can send a GET request to the endpoint and specify the user by name. In the following example, the placeholder <user_name> represents the value of name. To retrieve a list of all existing users, send a GET to the collection endpoint.

GET https://<BIG-IQ>/mgmt/shared/authz/users/<user_name>

Response¶

The JSON in the response can look similar to the following example.

HTTP/1.1 200 OK

{
    "name": "user_name",
    "displayName": "firstname lastname",
    "selfLink": "https://localhost/mgmt/shared/authz/users/<user_name>"
    "generation": 1,
    "kind": "shared:authz:users:usersworkerstate"
    "lastUpdateMicros": 1581123863107550
}

DELETE to delete a user¶

To delete an existing user, you can send a DELETE request to the endpoint and specify the user by name. In the following example, the placeholder <user_name> represents the value of name.

DELETE https://<BIG-IQ>/mgmt/shared/authz/users/<user_name>

Response¶

The JSON in the response contains the same JSON as the response to a GET for the deleted user.

HTTP/1.1 200 OK

{
    "name": "user_name",
    "displayName": "firstname lastname",
    "selfLink": "https://localhost/mgmt/shared/authz/users/<user_name>"
    "generation": 1,
    "kind": "shared:authz:users:usersworkerstate"
    "lastUpdateMicros": 1581123863107550
}

Previous Next