Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Users can be accessed and modified through this API using four services: GET, POST, PUT, and PATCH. These four services allow for the retrieval, creation, complete update, and partial update of users.

Each function returns a JSON user object. The user object has these attributes:

AttributesTypeDescription
userIdLongThe id of the user
attributesList<Attribute>The list of attributes associated with the user
userNameStringThe user name of the user
passwordStringThe user's password. Note: this value is displayed as "*****" when retrieved.
groupsList<Long>The ids of the groups that the user is a member of
isLocalUserBooleanWhether or not the user was made in FlexDeploy or imported from outside
isActiveBooleanWhether or not the user is active
emailStringThe user's email
firstNameStringThe first name of the user
lastNameStringThe last name of the user

Additionally, each attribute in the list of attributes contains these attributes

AttributesTypeDescription
descriptionStringThe description of the attribute
attributeNameStringThe name of the attribute
attributeValueStringThe value of the attribute
attributeGroupStringThe group that the attribute is associated with
attributeDataTypeStringThe type of data that the value is

Back to Top


GET

There are two implementations of GET. One will find a user with the given Id and return the JSON representation of the user . The other will find a list of users matching the parameters supplied to it.

GET by ID

This GET service will find a user with the given Id and return the JSON representation of the object. 

API URL

http://host:port/flexdeploy/rest/administration/security/user/{Id}

Parameters

Parameter

Type

Required

Description

Id

URLYesThis is a URL parameter for the Id which is used to find and return a user

Example

If we had a user in our database with an Id of 10000 and had the following attributes

User - 10000
{
	"attributes": [
	{
		"description": "Notify on Approval Required",
		"attributeName": "SUBMITTER_PENDING_APPROVAL",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Scheduled",
		"attributeName": "SUBMITTER_SCHEDULED",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Failed",
		"attributeName": "SUBMITTER_FAILED",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Deploying",
		"attributeName": "SUBMITTER_READY",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Completed",
		"attributeName": "SUBMITTER_COMPLETED",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Rejected",
		"attributeName": "SUBMITTER_REJECTED",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	}
	],
	"userId": 10000,
	"userName": "username",
	"password": "password",
	"groups": [10010,10011],
	"isActive": true,
	"email": "email@company.com",
	"lastName": "Last",
	"firstName": "First",
	"isLocalUser": true
}

When we run a GET request at the following URL

http://host:port/flexdeploy/rest/administration/security/user/10000

The GET request would return the following JSON user object

User - 10000
{
	"attributes": [
	{
		"description": "Notify on Approval Required",
		"attributeName": "SUBMITTER_PENDING_APPROVAL",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Scheduled",
		"attributeName": "SUBMITTER_SCHEDULED",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Failed",
		"attributeName": "SUBMITTER_FAILED",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Deploying",
		"attributeName": "SUBMITTER_READY",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Completed",
		"attributeName": "SUBMITTER_COMPLETED",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Rejected",
		"attributeName": "SUBMITTER_REJECTED",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	}
	],
	"userId": 10000,
	"userName": "username",
	"password": "*****",
	"groups": [10010,10011],
	"isActive": true,
	"email": "email@company.com",
	"lastName": "Last",
	"firstName": "First",
	"isLocalUser": true
}

Back to Top

GET (Using Query Parameters)

This GET service will return a list of users in the form of JSON objects based on the query parameters user name, first name, last name and group id. Users are only returned if they match all of the specified query parameters. If no query parameters are given this request will return the entire list of users.

API URLs

http://host:port/flexdeploy/rest/administration/security/user?

Append the following character sequences to the above URL to specify Query parameters.
Use '&' between successive query parameters: 

userName={userName}

firstName={firstName} *

lastName={lastName} *

groupId={groupId}

Examples:
To search by user name only:

http://host:port/flexdeploy/rest/topology/administration/security/user?userName=fdadmin

To search by first name and last name:

http://host:port/flexdeploy/rest/topology/administration/security/user?firstName=John&lastName=Smith

To search by group id

http://host:port/flexdeploy/rest/topology/administration/security/user?groupId=11101

* searching by first and last name returns all users that contain the specified string in their first or last name

The query parameters are not case sensitive. Searching by userName=NAME is the same as searching by userName=name.

Parameters

AttributesTypeRequiredDescription
userIdLongNoThe id of the user. This id is set when creating and returned in the JSON.
attributesList<Attribute>NoThe list of attributes associated with the user. They will be defaulted if not provided
userNameStringYesThe user name of the user
passwordStringYesThe user's password. Note: this value is displayed as "*****" when retrieved.
groupsList<Long>NoThe ids of the groups that the user is a member of
isLocalUserBooleanNoWhether or not the user was made in FlexDeploy. Set to true upon creation.
isActiveBooleanNoWhether or not the user is active. Defaulted to true if not provided.
emailStringYesThe user's email
firstNameStringYesThe first name of the user
lastNameStringYesThe last name of the user

Example

If we had a user in our database with an Id of 10000 and had the following attributes

User - 10000
{
	"attributes": [
	{
		"description": "Notify on Approval Required",
		"attributeName": "SUBMITTER_PENDING_APPROVAL",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Scheduled",
		"attributeName": "SUBMITTER_SCHEDULED",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Failed",
		"attributeName": "SUBMITTER_FAILED",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Deploying",
		"attributeName": "SUBMITTER_READY",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Completed",
		"attributeName": "SUBMITTER_COMPLETED",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Rejected",
		"attributeName": "SUBMITTER_REJECTED",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	}
	],
	"userId": 10000,
	"userName": "username",
	"password": "password",
	"groups": [10010,10011],
	"isActive": true,
	"email": "email@company.com",
	"lastName": "Last",
	"firstName": "First",
	"isLocalUser": true
}


When we run a GET request at the following URL

http://host:port/flexdeploy/rest/administration/security/user?groupId=10010

The GET request would return the  following JSON environment object

User - 10000
[
{
	"attributes": [
	{
		"description": "Notify on Approval Required",
		"attributeName": "SUBMITTER_PENDING_APPROVAL",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Scheduled",
		"attributeName": "SUBMITTER_SCHEDULED",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Failed",
		"attributeName": "SUBMITTER_FAILED",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Deploying",
		"attributeName": "SUBMITTER_READY",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Completed",
		"attributeName": "SUBMITTER_COMPLETED",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Rejected",
		"attributeName": "SUBMITTER_REJECTED",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	}
	],
	"userId": 10000,
	"userName": "username",
	"password": "*****",
	"groups": [10010,10011],
	"isActive": true,
	"email": "email@company.com",
	"lastName": "Last",
	"firstName": "First",
	"isLocalUser": true
}
]


Back to Top



POST

This POST service will create a new user with the same attributes as the given JSON object.

Parameters

AttributesTypeRequiredDescription
userIdLongNoThe id of the user. This id is set when creating and returned in the JSON.
attributesList<Attribute>NoThe list of attributes associated with the user. They will be defaulted if not provided
userNameStringYesThe user name of the user
passwordStringYesThe user's password. Note: this value is displayed as "*****" when retrieved.
groupsList<Long>NoThe ids of the groups that the user is a member of
isLocalUserBooleanNoWhether or not the user was made in FlexDeploy. Set to true upon creation.
isActiveBooleanNoWhether or not the user is active. Defaulted to true if not provided.
emailStringYesThe user's email
firstNameStringYesThe first name of the user
lastNameStringYesThe last name of the user

Example

If the POST request receives the following JSON user object,

User - 10000
{
	"userName": "username",
	"password": "password",
	"email": "email@company.com",
	"lastName": "Last",
	"firstName": "First"
}

The following user object will then be created as a new row in the database.

User - 10000
{
	"attributes": [
	{
		"description": "Notify on Approval Required",
		"attributeName": "SUBMITTER_PENDING_APPROVAL",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Scheduled",
		"attributeName": "SUBMITTER_SCHEDULED",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Failed",
		"attributeName": "SUBMITTER_FAILED",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Deploying",
		"attributeName": "SUBMITTER_READY",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Completed",
		"attributeName": "SUBMITTER_COMPLETED",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Rejected",
		"attributeName": "SUBMITTER_REJECTED",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	}
	],
	"userId": 10000,
	"userName": "username",
	"password": "*****",
	"groups": [],
	"isActive": true,
	"email": "email@company.com",
	"lastName": "Last",
	"firstName": "First",
	"isLocalUser": true
}

Back to Top


PUT

This PUT service will update all attributes of a user with the given Id based on the attributes of a JSON object parameters. Attributes that are not provided will become their default values.

Parameters

AttributesTypeRequiredDescription
IdURLYesThe PUT will be performed on the user with the specified id that is found in the URL.
userIdLongNoThe id of the user. This Id is ignored in PUT, but it is returned as the proper user Id.
attributesList<Attribute>NoThe list of attributes associated with the user. They will be defaulted if not provided
userNameStringYesThe user name of the user
passwordStringYesThe user's password. Note: this value is displayed as "*****" when retrieved.
groupsList<Long>NoThe ids of the groups that the user is a member of
isLocalUserBooleanNoWhether or not the user was made in FlexDeploy. Cannot be changed.
isActiveBooleanNoWhether or not the user is active. Defaulted to true if not provided.
emailStringYesThe user's email
firstNameStringYesThe first name of the user
lastNameStringYesThe last name of the user

Example

If we had a user in our database with an Id of 10000 and had the following attributes

User - 10000
{
	"attributes": [
	{
		"description": "Notify on Approval Required",
		"attributeName": "SUBMITTER_PENDING_APPROVAL",
		"attributeValue": "false",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Scheduled",
		"attributeName": "SUBMITTER_SCHEDULED",
		"attributeValue": "false",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Failed",
		"attributeName": "SUBMITTER_FAILED",
		"attributeValue": "false",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Deploying",
		"attributeName": "SUBMITTER_READY",
		"attributeValue": "false",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Completed",
		"attributeName": "SUBMITTER_COMPLETED",
		"attributeValue": "false",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Rejected",
		"attributeName": "SUBMITTER_REJECTED",
		"attributeValue": "false",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	}
	],
	"userId": 10000,
	"userName": "username",
	"password": "password",
	"groups": [],
	"isActive": true,
	"email": "email@company.com",
	"lastName": "Last",
	"firstName": "First",
	"isLocalUser": true
}

When we run a PUT request at the following URL

http://host:port/flexdeploy/administration/security/user/10000

And the PUT request receives the following JSON user object,

User - 10000
{
	"attributes": [
	{
		"description": "Notify on Approval Required",
		"attributeName": "SUBMITTER_PENDING_APPROVAL",
		"attributeValue": "false",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	}
	],
	"userName": "newusername",
	"password": "password",
	"groups": [],
	"isActive": true,
	"email": "newemail@company.com",
	"lastName": "Lastname",
	"firstName": "Firstname"
}

The PUT request would then update the environment with Id 11101 and return the  following JSON environment object

User - 10000
{
	"attributes": [
	{
		"description": "Notify on Approval Required",
		"attributeName": "SUBMITTER_PENDING_APPROVAL",
		"attributeValue": "false",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Scheduled",
		"attributeName": "SUBMITTER_SCHEDULED",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Failed",
		"attributeName": "SUBMITTER_FAILED",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Deploying",
		"attributeName": "SUBMITTER_READY",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Completed",
		"attributeName": "SUBMITTER_COMPLETED",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Rejected",
		"attributeName": "SUBMITTER_REJECTED",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	}
	],
	"userId": 10000,
	"userName": "newusername",
	"password": "*****",
	"groups": [],
	"isActive": true,
	"email": "newemail@company.com",
	"lastName": "Lastname",
	"firstName": "Firstname",
	"isLocalUser": true
}


Back to Top


PATCH

This PATCH service will update an existing user with the information passed through a JSON object. If an attribute of the JSON is null it will not be updated in the user. Groups that are included in a PATCH will be added, but existing groups will still remain.


Parameters

AttributesTypeRequiredDescription
IdURLYesThe PUT will be performed on the user with the specified id that is found in the URL.
userIdLongNoThe id of the user. This Id is ignored in PUT, but it is returned as the proper user Id.
attributesList<Attribute>NoThe list of attributes associated with the user. Only provided attributes will be changed.
userNameStringNoThe user name of the user
passwordStringNoThe user's password. Note: this value is displayed as "*****" when retrieved.
groupsList<Long>NoThe ids of the groups that the user is a member of
isLocalUserBooleanNoWhether or not the user was made in FlexDeploy.
isActiveBooleanNoWhether or not the user is active.
emailStringNoThe user's email
firstNameStringNoThe first name of the user
lastNameStringNoThe last name of the user

Example

If we had an environment in our database with an Id of 11101 and had the following attributes

User - 10000
{
	"attributes": [
	{
		"description": "Notify on Approval Required",
		"attributeName": "SUBMITTER_PENDING_APPROVAL",
		"attributeValue": "false",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Scheduled",
		"attributeName": "SUBMITTER_SCHEDULED",
		"attributeValue": "false",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Failed",
		"attributeName": "SUBMITTER_FAILED",
		"attributeValue": "false",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Deploying",
		"attributeName": "SUBMITTER_READY",
		"attributeValue": "false",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Completed",
		"attributeName": "SUBMITTER_COMPLETED",
		"attributeValue": "false",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Rejected",
		"attributeName": "SUBMITTER_REJECTED",
		"attributeValue": "false",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	}
	],
	"userId": 10000,
	"userName": "username",
	"password": "password",
	"groups": [10001],
	"isActive": true,
	"email": "email@company.com",
	"lastName": "Last",
	"firstName": "First",
	"isLocalUser": true
}

When we run a PATCH request at the following URL

http://host:port/flexdeploy/administration/security/user/10000

And the PATCH request receives the following JSON user object,

User - 10000
{
	"attributes": [
	{
		"description": "Notify on Approval Required",
		"attributeName": "SUBMITTER_PENDING_APPROVAL",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	}
	],
	"password": "newPassword",
	"groups": [10010]
}

The PATCH request would then update the user with Id 10000 and return the  following JSON user object

User - 10000
{
	"attributes": [
	{
		"description": "Notify on Approval Required",
		"attributeName": "SUBMITTER_PENDING_APPROVAL",
		"attributeValue": "true",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Scheduled",
		"attributeName": "SUBMITTER_SCHEDULED",
		"attributeValue": "false",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Failed",
		"attributeName": "SUBMITTER_FAILED",
		"attributeValue": "false",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Deploying",
		"attributeName": "SUBMITTER_READY",
		"attributeValue": "false",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Completed",
		"attributeName": "SUBMITTER_COMPLETED",
		"attributeValue": "false",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	},
	{
		"description": "Notify on Request Rejected",
		"attributeName": "SUBMITTER_REJECTED",
		"attributeValue": "false",
		"attributeGroup": "EMAIL_COMMUNICATION",
		"attributeDataType": "Boolean"
	}
	],
	"userId": 10000,
	"userName": "username",
	"password": "*****",
	"groups": [10001, 10010],
	"isActive": true,
	"email": "email@company.com",
	"lastName": "Last",
	"firstName": "First",
	"isLocalUser": true
}

Back to Top



  • No labels