Users

https://api.spectrocloud.com/v1/users

summary:
Lists users
description:
Lists users the given user context
Parameters:
NameTypeDescriptionRequired
fieldsstringSet of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.nameno
filtersstringFilters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws Server will be restricted to certain fields based on the indexed data for each resource.no
orderBystringSpecify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1no
limitintegerlimit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.no
offsetintegeroffset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.no
continuestringcontinue token to paginate the subsequent data itemsno
200
OK
{
"items": [
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"emailId": "string",
"firstName": "string",
"lastName": "string",
"roles": [
"string"
]
},
"status": {
"activationLink": "string",
"isActive": "boolean",
"isPasswordResetting": "boolean",
"lastSignIn": "date-time"
}
}
],
"listmeta": {
"continue": "string",
"count": "integer",
"limit": "integer",
"offset": "integer"
}
}

https://api.spectrocloud.com/v1/users

summary:
Create User
description:
A user is created for the given user context
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"emailId": "string",
"firstName": "string",
"lastName": "string",
"loginMode": "string",
"roles": [
"string"
],
"teams": [
"string"
]
}
}
201
Created successfully
{
"uid": "string"
}

https://api.spectrocloud.com/v1/users/assets/locations

summary:
Returns the specified users location
description:
Returns a list of users location
Parameters:
NameTypeDescriptionRequired
filtersstringFilters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws Server will be restricted to certain fields based on the indexed data for each resource.no
orderBystringSpecify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1no
200
OK
{
"items": [
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"isDefault": "boolean",
"storage": "string",
"type": "string"
}
}
]
}

https://api.spectrocloud.com/v1/users/assets/locations/azure

summary:
Stores the specified Users assets Azure location
{
"metadata": {
"annotations": "object",
"labels": "object",
"name": "string"
},
"spec": {
"config": {
"containerName": "string",
"credentials": {
"clientId": "string",
"clientSecret": "string",
"subscriptionId": "string",
"tenantId": "string"
},
"resourceGroup": "string",
"sku": "string",
"storageName": "string"
},
"isDefault": "boolean",
"type": "string"
}
}
201
Created successfully
{
"uid": "string"
}

https://api.spectrocloud.com/v1/users/assets/locations/azure/{uid}

summary:
Returns the specified users Azure location
Path parameters:
NameTypeDescriptionRequired
uidstringyes
200
OK
{
"metadata": {
"annotations": "object",
"labels": "object",
"name": "string"
},
"spec": {
"config": {
"containerName": "string",
"credentials": {
"clientId": "string",
"clientSecret": "string",
"subscriptionId": "string",
"tenantId": "string"
},
"resourceGroup": "string",
"sku": "string",
"storageName": "string"
},
"isDefault": "boolean",
"type": "string"
}
}

https://api.spectrocloud.com/v1/users/assets/locations/azure/{uid}

summary:
Updates the specified users Azure location
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"metadata": {
"annotations": "object",
"labels": "object",
"name": "string"
},
"spec": {
"config": {
"containerName": "string",
"credentials": {
"clientId": "string",
"clientSecret": "string",
"subscriptionId": "string",
"tenantId": "string"
},
"resourceGroup": "string",
"sku": "string",
"storageName": "string"
},
"isDefault": "boolean",
"type": "string"
}
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/users/assets/locations/gcp

summary:
Stores the specified Users assets Gcp location
{
"metadata": {
"annotations": "object",
"labels": "object",
"name": "string"
},
"spec": {
"config": {
"bucketName": "string",
"credentials": {
"jsonCredentials": "string",
"jsonCredentialsFileUid": "string"
}
},
"isDefault": "boolean",
"type": "string"
}
}
201
Created successfully
{
"uid": "string"
}

https://api.spectrocloud.com/v1/users/assets/locations/gcp/{uid}

summary:
Returns the specified users Gcp location
Path parameters:
NameTypeDescriptionRequired
uidstringyes
200
OK
{
"metadata": {
"annotations": "object",
"labels": "object",
"name": "string"
},
"spec": {
"config": {
"bucketName": "string",
"credentials": {
"jsonCredentials": "string",
"jsonCredentialsFileUid": "string"
}
},
"isDefault": "boolean",
"type": "string"
}
}

https://api.spectrocloud.com/v1/users/assets/locations/gcp/{uid}

summary:
Updates the specified users Gcp location
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"metadata": {
"annotations": "object",
"labels": "object",
"name": "string"
},
"spec": {
"config": {
"bucketName": "string",
"credentials": {
"jsonCredentials": "string",
"jsonCredentialsFileUid": "string"
}
},
"isDefault": "boolean",
"type": "string"
}
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/users/assets/locations/minio

summary:
Stores the specified users assets minio location
{
"metadata": {
"annotations": "object",
"labels": "object",
"name": "string"
},
"spec": {
"config": {
"bucketName": "string",
"caCert": "string",
"credentials": {
"accessKey": "string",
"credentialType": "string",
"policyARNs": [
"string"
],
"secretKey": "string",
"settings": {
"disablePropertiesRequest": "boolean"
},
"sts": {
"arn": "string",
"externalId": "string"
}
},
"region": "string",
"s3ForcePathStyle": "boolean",
"s3Url": "string",
"useRestic": "boolean"
},
"isDefault": "boolean",
"type": "string"
}
}
201
Created successfully
{
"uid": "string"
}

https://api.spectrocloud.com/v1/users/assets/locations/minio/{uid}

summary:
Returns the specified users minio location
Path parameters:
NameTypeDescriptionRequired
uidstringyes
200
OK
{
"metadata": {
"annotations": "object",
"labels": "object",
"name": "string"
},
"spec": {
"config": {
"bucketName": "string",
"caCert": "string",
"credentials": {
"accessKey": "string",
"credentialType": "string",
"policyARNs": [
"string"
],
"secretKey": "string",
"settings": {
"disablePropertiesRequest": "boolean"
},
"sts": {
"arn": "string",
"externalId": "string"
}
},
"region": "string",
"s3ForcePathStyle": "boolean",
"s3Url": "string",
"useRestic": "boolean"
},
"isDefault": "boolean",
"type": "string"
}
}

https://api.spectrocloud.com/v1/users/assets/locations/minio/{uid}

summary:
Updates the specified users minio location
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"metadata": {
"annotations": "object",
"labels": "object",
"name": "string"
},
"spec": {
"config": {
"bucketName": "string",
"caCert": "string",
"credentials": {
"accessKey": "string",
"credentialType": "string",
"policyARNs": [
"string"
],
"secretKey": "string",
"settings": {
"disablePropertiesRequest": "boolean"
},
"sts": {
"arn": "string",
"externalId": "string"
}
},
"region": "string",
"s3ForcePathStyle": "boolean",
"s3Url": "string",
"useRestic": "boolean"
},
"isDefault": "boolean",
"type": "string"
}
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/users/assets/locations/s3

summary:
Stores the specified Users assets s3 location
{
"metadata": {
"annotations": "object",
"labels": "object",
"name": "string"
},
"spec": {
"config": {
"bucketName": "string",
"caCert": "string",
"credentials": {
"accessKey": "string",
"credentialType": "string",
"policyARNs": [
"string"
],
"secretKey": "string",
"settings": {
"disablePropertiesRequest": "boolean"
},
"sts": {
"arn": "string",
"externalId": "string"
}
},
"region": "string",
"s3ForcePathStyle": "boolean",
"s3Url": "string",
"useRestic": "boolean"
},
"isDefault": "boolean",
"type": "string"
}
}
201
Created successfully
{
"uid": "string"
}

https://api.spectrocloud.com/v1/users/assets/locations/s3/{uid}

summary:
Returns the specified users s3 location
Path parameters:
NameTypeDescriptionRequired
uidstringyes
204
The resource was deleted successfully

https://api.spectrocloud.com/v1/users/assets/locations/s3/{uid}

summary:
Returns the specified users s3 location
Path parameters:
NameTypeDescriptionRequired
uidstringyes
200
OK
{
"metadata": {
"annotations": "object",
"labels": "object",
"name": "string"
},
"spec": {
"config": {
"bucketName": "string",
"caCert": "string",
"credentials": {
"accessKey": "string",
"credentialType": "string",
"policyARNs": [
"string"
],
"secretKey": "string",
"settings": {
"disablePropertiesRequest": "boolean"
},
"sts": {
"arn": "string",
"externalId": "string"
}
},
"region": "string",
"s3ForcePathStyle": "boolean",
"s3Url": "string",
"useRestic": "boolean"
},
"isDefault": "boolean",
"type": "string"
}
}

https://api.spectrocloud.com/v1/users/assets/locations/s3/{uid}

summary:
Updates the specified users s3 location
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"metadata": {
"annotations": "object",
"labels": "object",
"name": "string"
},
"spec": {
"config": {
"bucketName": "string",
"caCert": "string",
"credentials": {
"accessKey": "string",
"credentialType": "string",
"policyARNs": [
"string"
],
"secretKey": "string",
"settings": {
"disablePropertiesRequest": "boolean"
},
"sts": {
"arn": "string",
"externalId": "string"
}
},
"region": "string",
"s3ForcePathStyle": "boolean",
"s3Url": "string",
"useRestic": "boolean"
},
"isDefault": "boolean",
"type": "string"
}
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/users/assets/locations/{type}/{uid}/default

summary:
Update the default backup location
Path parameters:
NameTypeDescriptionRequired
uidstringyes
typestringyes
204
The resource was updated successfully

https://api.spectrocloud.com/v1/users/assets/locations/{uid}

summary:
Deletes the specified users location
Path parameters:
NameTypeDescriptionRequired
uidstringyes
204
The resource was deleted successfully

https://api.spectrocloud.com/v1/users/assets/sshkeys

summary:
Returns the specified Users assets ssh keys
description:
Returns a list of users assets ssh keys
Parameters:
NameTypeDescriptionRequired
filtersstringFilters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws Server will be restricted to certain fields based on the indexed data for each resource.no
orderBystringSpecify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1no
200
OK
{
"items": [
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"publicKey": "string"
}
}
]
}

https://api.spectrocloud.com/v1/users/assets/sshkeys

summary:
Stores the specified Users assets ssh
{
"metadata": {
"annotations": "object",
"labels": "object",
"name": "string"
},
"spec": {
"publicKey": "string"
}
}
201
Created successfully
{
"uid": "string"
}

https://api.spectrocloud.com/v1/users/assets/sshkeys/{uid}

summary:
Returns the specified Users ssh key
Path parameters:
NameTypeDescriptionRequired
uidstringyes
204
The resource was deleted successfully

https://api.spectrocloud.com/v1/users/assets/sshkeys/{uid}

summary:
Returns the specified Users ssh key
Path parameters:
NameTypeDescriptionRequired
uidstringyes
200
OK
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"publicKey": "string"
}
}

https://api.spectrocloud.com/v1/users/assets/sshkeys/{uid}

summary:
Updates the specified Users ssh key
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"publicKey": "string"
}
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/users/assets/vsphere/dnsMapping

summary:
Returns the specified vsphere dns mapping
Parameters:
NameTypeDescriptionRequired
gatewayUidstringyes
datacenterstringyes
networkstringyes
200
OK
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"datacenter": "string",
"dnsName": "string",
"network": "string",
"networkUrl": "string",
"privateGatewayUid": "string"
}
}

https://api.spectrocloud.com/v1/users/assets/vsphere/dnsMappings

summary:
Returns the specified vsphere dns mappings
description:
Returns a list of vsphere dns mappings
Parameters:
NameTypeDescriptionRequired
filtersstringFilters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws Server will be restricted to certain fields based on the indexed data for each resource.no
orderBystringSpecify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1no
200
OK
{
"items": [
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"datacenter": "string",
"dnsName": "string",
"network": "string",
"networkUrl": "string",
"privateGatewayUid": "string"
}
}
]
}

https://api.spectrocloud.com/v1/users/assets/vsphere/dnsMappings

summary:
Stores the vsphere dns mapping
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"datacenter": "string",
"dnsName": "string",
"network": "string",
"networkUrl": "string",
"privateGatewayUid": "string"
}
}
201
Created successfully
{
"uid": "string"
}

https://api.spectrocloud.com/v1/users/assets/vsphere/dnsMappings/{uid}

summary:
Deletes the vsphere dns mapping
Path parameters:
NameTypeDescriptionRequired
uidstringyes
204
The resource was deleted successfully

https://api.spectrocloud.com/v1/users/assets/vsphere/dnsMappings/{uid}

summary:
Returns the specified vsphere dns mapping
Path parameters:
NameTypeDescriptionRequired
uidstringyes
200
OK
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"datacenter": "string",
"dnsName": "string",
"network": "string",
"networkUrl": "string",
"privateGatewayUid": "string"
}
}

https://api.spectrocloud.com/v1/users/assets/vsphere/dnsMappings/{uid}

summary:
Updates the specified vsphere dns mapping
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"datacenter": "string",
"dnsName": "string",
"network": "string",
"networkUrl": "string",
"privateGatewayUid": "string"
}
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/users/config/scar

summary:
Get the system Spectro repository. Restricted to edge services
200
(empty)
{
"endpoint": "string",
"password": "string",
"username": "string"
}

https://api.spectrocloud.com/v1/users/kubectl/session/{sessionUid}

summary:
gets users kubectl session
description:
gets users kubectl session
Parameters:
NameTypeDescriptionRequired
sessionUidstringyes
200
OK
{
"clusterUid": "string",
"creationTime": "string",
"isActive": "boolean",
"podIp": "string",
"podName": "string",
"port": "string",
"projectUid": "string",
"sessionUid": "string",
"shellyCluster": "string",
"tenantClusterEndpoint": "string",
"userName": "string",
"userUid": "string"
}

https://api.spectrocloud.com/v1/users/meta

summary:
Retrieves a list of users metadata
200
An array of users metadata items
{
"items": [
{
"emailId": "string",
"name": "string",
"uid": "string"
}
]
}

https://api.spectrocloud.com/v1/users/password/change

summary:
User password change request using the user emailId
description:
User password change request via current password and emailId
{
"currentPassword": "string",
"emailId": "string",
"newPassword": "string"
}
204
Ok reponse without content

https://api.spectrocloud.com/v1/users/password/reset

summary:
User password reset request using the email id
description:
User password request will be sent to the supplied emailId
{
"emailId": "string"
}
204
Ok reponse without content

deprecated

https://api.spectrocloud.com/v1/users/summary

summary:
Returns the specified user summary list
description:
Deprecated, Use Post api - Returns a list of user summaries
Parameters:
NameTypeDescriptionRequired
limitintegerlimit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.no
offsetintegeroffset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.no
continuestringcontinue token to paginate the subsequent data itemsno
200
OK
{
"items": [
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"emailId": "string",
"firstName": "string",
"lastName": "string",
"projects":deprecated [
{
"name": "string",
"uid": "string"
}
],
"projectsCount": "integer",
"roles": [
{
"name": "string",
"uid": "string"
}
],
"teams": [
{
"name": "string",
"uid": "string"
}
]
},
"status": {
"activationLink": "string",
"isActive": "boolean",
"isPasswordResetting": "boolean",
"lastSignIn": "date-time"
}
}
],
"listmeta": {
"continue": "string",
"count": "integer",
"limit": "integer",
"offset": "integer"
}
}

https://api.spectrocloud.com/v1/users/summary

summary:
Retrieves a list of users summary with provided filter spec
{
"filter": {
"emailId": {
"beginsWith": "string",
"contains": "string",
"eq": "string",
"ignoreCase": "boolean",
"ne": "string"
},
"name": {
"beginsWith": "string",
"contains": "string",
"eq": "string",
"ignoreCase": "boolean",
"ne": "string"
}
},
"sort": [
{
"field": "string",
"order": "string"
}
]
}
200
An array of users summary items
{
"items": [
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"emailId": "string",
"firstName": "string",
"lastName": "string",
"projects":deprecated [
{
"name": "string",
"uid": "string"
}
],
"projectsCount": "integer",
"roles": [
{
"name": "string",
"uid": "string"
}
],
"teams": [
{
"name": "string",
"uid": "string"
}
]
},
"status": {
"activationLink": "string",
"isActive": "boolean",
"isPasswordResetting": "boolean",
"lastSignIn": "date-time"
}
}
]
}

https://api.spectrocloud.com/v1/users/system/macros

summary:
Delete the macros for the system user by macro name
{
"macros": [
{
"name": "string",
"value": "string"
}
]
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/users/system/macros

summary:
List the macros of the system
200
OK
{
"macros": [
{
"name": "string",
"value": "string"
}
]
}

https://api.spectrocloud.com/v1/users/system/macros

summary:
Update the macros for the system user by macro name
{
"macros": [
{
"name": "string",
"value": "string"
}
]
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/users/system/macros

summary:
Create or add new macros for the system user
{
"macros": [
{
"name": "string",
"value": "string"
}
]
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/users/system/macros

summary:
Update the macros of the system
{
"macros": [
{
"name": "string",
"value": "string"
}
]
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/users/{uid}

summary:
Deletes the specified User
description:
Deletes the specified User for given uid
Path parameters:
NameTypeDescriptionRequired
uidstringyes
204
The resource was deleted successfully

https://api.spectrocloud.com/v1/users/{uid}

summary:
Returns the specified User
description:
Returns a User for the specified uid.
Path parameters:
NameTypeDescriptionRequired
uidstringyes
200
OK
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"emailId": "string",
"firstName": "string",
"lastName": "string",
"roles": [
"string"
]
},
"status": {
"activationLink": "string",
"isActive": "boolean",
"isPasswordResetting": "boolean",
"lastSignIn": "date-time"
}
}

https://api.spectrocloud.com/v1/users/{uid}

summary:
Patches the specified User
description:
User is patched for the specified information
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"items": {
"from": "string",
"op": "string",
"path": "string",
"value": "object"
}
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/users/{uid}

summary:
Update User
description:
A user is created for the given user context
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"emailId": "string",
"firstName": "string",
"lastName": "string",
"roles": [
"string"
]
}
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/users/{uid}/password/change

summary:
User password change request using the user uid
description:
User password change request via current password
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"currentPassword": "string",
"newPassword": "string"
}
204
Ok reponse without content

https://api.spectrocloud.com/v1/users/{uid}/password/reset

summary:
User password reset request using the user uid
description:
User password reset request, will send the password reset option through the emailId
Path parameters:
NameTypeDescriptionRequired
uidstringyes
204
Ok reponse without content

https://api.spectrocloud.com/v1/users/{uid}/projects

summary:
Returns the specified User Projects and Roles information
description:
Returns a User with projects and roles
Path parameters:
NameTypeDescriptionRequired
uidstringyes
200
OK
{
"projects": [
{
"inheritedRoles": [
{
"name": "string",
"uid": "string"
}
],
"name": "string",
"roles": [
{
"name": "string",
"uid": "string"
}
],
"uid": "string"
}
]
}

https://api.spectrocloud.com/v1/users/{uid}/projects

summary:
Updates the projects and roles for user
description:
User is updated with projects and roles
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"projects": [
"object"
]
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/users/{uid}/roles

summary:
Returns the specified individual and team roles for a user
description:
Returns roles clubbed from team
Path parameters:
NameTypeDescriptionRequired
uidstringyes
200
OK
{
"inheritedRoles": [
{
"name": "string",
"uid": "string"
}
],
"roles": [
{
"name": "string",
"uid": "string"
}
]
}

https://api.spectrocloud.com/v1/users/{uid}/roles

summary:
Updates the roles for user
description:
User is updated with roles
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"roles": [
"string"
]
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/users/{uid}/status/loginMode

summary:
Users status login mode
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"loginMode": "string"
}
204
The resource was updated successfully