Skip to main content

Assign an API key to another user

POST 

/auth/api_keys/:id/assignment

Assigns an API key to a user. This controls what they are authorized to do in Mission Control.

Request

Path Parameters

    id stringrequired

    The id of the API Key

Body

required

    user_id string

    uuid for User.

Responses

200: Successful response

Schema

    data

    object

    id string

    uuid.

    description string

    Human readable identifier.

    secret string

    Secret used to authenticate API Key.

    backup_secret string

    Secondary secret which may also be used to authenticate API Key.

    status string

    Status of the API Key.

    permission_groups string[]

    Array of ids of Permission Groups on the API Key.

    admin boolean

    True if the API Key has admin rights, false otherwise.

    record_type string

    Record type.

    created_at string

    Timestamp of resource creation.

    updated_at string

    Timestamp of last resource update.

401: Authentication error

Schema

    errors

    object[]

  • Array [

  • code string

    an application-specific error code, expressed as a stringified integer.

    title string

    a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

    detail string

    a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

    pointer string

    JSON pointer to the field which is causing the error.

  • ]

403: Authorization error

Schema

    errors

    object[]

  • Array [

  • code string

    an application-specific error code, expressed as a stringified integer.

    title string

    a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

    detail string

    a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

    pointer string

    JSON pointer to the field which is causing the error.

  • ]

404: Resource not found

Schema

    errors

    object[]

  • Array [

  • code string

    an application-specific error code, expressed as a stringified integer.

    title string

    a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

    detail string

    a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

    pointer string

    JSON pointer to the field which is causing the error.

  • ]

422: Invalid parameters supplied in request. See HTTP response body for details.

Schema

    errors

    object[]

  • Array [

  • code string

    an application-specific error code, expressed as a stringified integer.

    title string

    a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

    detail string

    a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

    pointer string

    JSON pointer to the field which is causing the error.

  • ]

Loading...