Powered by Algolia

    Users

    https://api.spectrocloud.com/v1alpha1/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. 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
    continuestringcontinue token for the datasetno
    200
    OK
    {
    "items": [
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "emailId": "string",
    "firstName": "string",
    "lastName": "string",
    "roles": [
    "string"
    ]
    },
    "status": {
    "isActive": "boolean",
    "lastSignIn": "date-time"
    }
    }
    ],
    "listmeta": {
    "continue": "string",
    "count": "integer"
    }
    }

    https://api.spectrocloud.com/v1alpha1/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",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "emailId": "string",
    "firstName": "string",
    "lastName": "string",
    "roles": [
    "string"
    ],
    "teams": [
    "string"
    ]
    }
    }
    201
    Created successfully
    {
    "uid": "string"
    }

    https://api.spectrocloud.com/v1alpha1/users/assets/certificates

    summary:
    Returns the specified Users assets certificates
    description:
    Returns a list of users assets certificates
    Parameters:
    NameTypeDescriptionRequired
    limitintegerlimit is a maximum number of responses to return for a list call. 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
    continuestringcontinue token for the datasetno
    componentTypestringno
    componentUidstringno
    200
    OK
    {
    "items": [
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "componentType": "string",
    "componentUid": "string",
    "crt": "string",
    "crtFileName": "string",
    "key": "string",
    "keyFileName": "string"
    }
    }
    ],
    "listmeta": {
    "continue": "string",
    "count": "integer"
    }
    }

    https://api.spectrocloud.com/v1alpha1/users/assets/certificates

    summary:
    Stores the specified Users assets certificate
    Parameters:
    NameTypeDescriptionRequired
    crtFilefileno
    keyFilefileno
    componentTypestringno
    componentUidstringno
    201
    Created successfully
    {
    "uid": "string"
    }

    https://api.spectrocloud.com/v1alpha1/users/assets/certificates/{uid}

    summary:
    Returns the specified Users certificate key
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    200
    OK
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "componentType": "string",
    "componentUid": "string",
    "crt": "string",
    "crtFileName": "string",
    "key": "string",
    "keyFileName": "string"
    }
    }

    https://api.spectrocloud.com/v1alpha1/users/assets/certificates/{uid}

    summary:
    Updates the specified Users certificate
    Parameters:
    NameTypeDescriptionRequired
    crtFilefileno
    keyFilefileno
    componentTypestringno
    componentUidstringno
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    204
    The resource was updated successfully

    https://api.spectrocloud.com/v1alpha1/users/assets/certificates/{uid}

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

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

    summary:
    Returns the specified Users assets ssh keys
    description:
    Returns a list of users assets ssh keys
    Parameters:
    NameTypeDescriptionRequired
    limitintegerlimit is a maximum number of responses to return for a list call. 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
    continuestringcontinue token for the datasetno
    200
    OK
    {
    "items": [
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "publicKey": "string"
    }
    }
    ],
    "listmeta": {
    "continue": "string",
    "count": "integer"
    }
    }

    https://api.spectrocloud.com/v1alpha1/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/v1alpha1/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",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "publicKey": "string"
    }
    }

    https://api.spectrocloud.com/v1alpha1/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",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "publicKey": "string"
    }
    }
    204
    The resource was updated successfully

    https://api.spectrocloud.com/v1alpha1/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/v1alpha1/users/me

    summary:
    Returns the specified User ACL information
    description:
    Returns a User with permissions with scopes
    200
    OK
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "emailId": "string",
    "firstName": "string",
    "lastName": "string",
    "roles": [
    "string"
    ]
    },
    "status": {
    "activationLink": "string",
    "isActive": "boolean",
    "isContractAccepted": "boolean",
    "projectPermissions": "object",
    "tenant": {
    "orgName": "string",
    "tenantUid": "string"
    },
    "tenantPermissions": "object"
    }
    }

    https://api.spectrocloud.com/v1alpha1/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/v1alpha1/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

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

    summary:
    Returns the specified User Summary list
    description:
    Returns a list of user summaries
    Parameters:
    NameTypeDescriptionRequired
    limitintegerlimit is a maximum number of responses to return for a list call. 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
    continuestringcontinue token for the datasetno
    200
    OK
    {
    "items": [
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "emailId": "string",
    "firstName": "string",
    "lastName": "string",
    "projects": [
    {
    "name": "string",
    "uid": "string"
    }
    ],
    "roles": [
    {
    "name": "string",
    "uid": "string"
    }
    ],
    "teams": [
    {
    "name": "string",
    "uid": "string"
    }
    ]
    },
    "status": {
    "isActive": "boolean",
    "lastSignIn": "date-time"
    }
    }
    ],
    "listmeta": {
    "continue": "string",
    "count": "integer"
    }
    }

    https://api.spectrocloud.com/v1alpha1/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",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "emailId": "string",
    "firstName": "string",
    "lastName": "string",
    "roles": [
    "string"
    ]
    },
    "status": {
    "isActive": "boolean",
    "lastSignIn": "date-time"
    }
    }

    https://api.spectrocloud.com/v1alpha1/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",
    "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/v1alpha1/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/v1alpha1/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/v1alpha1/users/{uid}/activationlink

    summary:
    Returns the specified User activation link to reset the password
    description:
    API to get the user activation link to reset the password
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    200
    OK
    {
    "activationLink": "string"
    }

    https://api.spectrocloud.com/v1alpha1/users/{uid}/contract/accept

    summary:
    User to accept the contract agreement
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    204
    Ok reponse without content

    https://api.spectrocloud.com/v1alpha1/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/v1alpha1/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/v1alpha1/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/v1alpha1/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/v1alpha1/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/v1alpha1/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