Paths
/portal/users/register
Sign-Up to the portal
This call allows an unauthenticated caller to request to join a portal. Once the sign-up procedure is complete, the user will be active and will be the owner of a new developer organization. If the user registry is LDAP, then the only required fields are username and password. If they do not specify an organization then a developer organization will be created with a default name of ''firstName lastName''.If the user registry is a Local User Registry then all fields are required and the username must be the email address of the new user.
No response was specified
User has been created.
User already registered or username and/or password incorrect.
Authentication failed. Valid username and password are required.
Self-service onboarding is disabled for this portal.
Resource not found.
An internal error has occurred.
/portal/users
Get list of users matching the search criteria
Get list of users matching the search criteria. The result is a list of usernames from the user registry.
Search filter
Retrieved list of users matching the specified search crtieria.
Too many search results. Refine the search filter and try again.
Authentication failed. Valid username and password are required.
User must be an owner of a developer organization in the same environment to search for users.
Resource not found.
An internal error has occurred.
Definitions
{
"required": [
"username",
"password",
"organization",
"lastName",
"firstName"
],
"properties": {
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"organization": {
"type": "string"
},
"password": {
"type": "string"
},
"username": {
"type": "string",
"description": "username = Email address"
}
}
}
{
"required": [
"id",
"name",
"email",
"firstName",
"lastName",
"lastLoginTime",
"status",
"additionalFields",
"url"
],
"properties": {
"additionalFields": {
"additionalProperties": {
"type": "object"
}
},
"email": {
"type": "string"
},
"firstName": {
"type": "string"
},
"id": {
"type": "string"
},
"lastLoginTime": {
"type": "string",
"format": "date-time"
},
"lastName": {
"type": "string"
},
"name": {
"type": "string"
},
"organization": {
"$ref": "#\/definitions\/PortalOrgPostResponse"
},
"status": {
"type": "string"
},
"url": {
"type": "string"
}
}
}
{
"required": [
"id",
"name",
"url"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
}
}
}
{
"required": [
"username"
],
"properties": {
"username": {
"type": "string"
}
}
}