createUser
Create user
Details
- Method:
POST - Path:
/rest/api/3/user - Operation ID:
createUser
Parameters
{
"applicationKeys": {
"description": "Deprecated, do not use.",
"required": false,
"location": "body",
"type": "array"
},
"displayName": {
"description": "This property is no longer available. If the user has an Atlassian account, their display name is not changed. If the user does not have an Atlassian account, they are sent an email asking them set up an account.",
"required": false,
"location": "body",
"type": "string"
},
"emailAddress": {
"description": "The email address for the user.",
"required": true,
"location": "body",
"type": "string"
},
"key": {
"description": "This property is no longer available. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
"required": false,
"location": "body",
"type": "string"
},
"name": {
"description": "This property is no longer available. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
"required": false,
"location": "body",
"type": "string"
},
"password": {
"description": "This property is no longer available. If the user has an Atlassian account, their password is not changed. If the user does not have an Atlassian account, they are sent an email asking them set up an account.",
"required": false,
"location": "body",
"type": "string"
},
"products": {
"description": "Products the new user has access to. Valid products are: jira-core, jira-servicedesk, jira-product-discovery, jira-software. To create a user without product access, set this field to be an empty array.",
"required": true,
"location": "body",
"type": "array"
},
"self": {
"description": "The URL of the user.",
"required": false,
"location": "body",
"type": "string"
}
}Response Schema
{
"additionalProperties": false,
"description": "A user with details as permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions:\n\n * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank).\n * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values.\n * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values.",
"properties": {
"accountId": {
"description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests.",
"maxLength": 128,
"type": "string"
},
"accountType": {
"description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk",
"enum": [
"atlassian",
"app",
"customer",
"unknown"
],
"readOnly": true,
"type": "string"
},
"active": {
"description": "Whether the user is active.",
"readOnly": true,
"type": "boolean"
},
"appType": {
"description": "The app type of the user account when accountType is 'app'. Can take the following values:\n\n * `service` Service Account\n * `agent` Rovo Agent Account\n * `unknown` Unknown app type",
"readOnly": true,
"type": "string"
},
"applicationRoles": {
"allOf": [
{
"$ref": "#/components/schemas/SimpleListWrapperApplicationRole"
}
],
"description": "The application roles the user is assigned to.",
"readOnly": true
},
"avatarUrls": {
"allOf": [
{
"$ref": "#/components/schemas/AvatarUrlsBean"
}
],
"description": "The avatars of the user.",
"readOnly": true
},
"displayName": {
"description": "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"readOnly": true,
"type": "string"
},
"emailAddress": {
"description": "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"readOnly": true,
"type": "string"
},
"expand": {
"description": "Expand options that include additional user details in the response.",
"readOnly": true,
"type": "string",
"xml": {
"attribute": true
}
},
"groups": {
"allOf": [
{
"$ref": "#/components/schemas/SimpleListWrapperGroupName"
}
],
"description": "The groups that the user belongs to.",
"readOnly": true
},
"key": {
"description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
"type": "string"
},
"locale": {
"description": "The locale of the user. Depending on the user’s privacy setting, this may be returned as null.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
"type": "string"
},
"self": {
"description": "The URL of the user.",
"format": "uri",
"readOnly": true,
"type": "string"
},
"timeZone": {
"description": "The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned.",
"readOnly": true,
"type": "string"
}
},
"type": "object",
"xml": {
"name": "user"
}
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('jira')
# Call this tool
result = await agent.call_tool('createUser', {
# Add required parameters here
})