Sign in
latestOpenAPI 3.0.02026-08-0819201.1 MB

411f9f98c01e

auth secrets

Creates an auth secret

You need workspaces.auth_secret.create permission to access this resource. If related auth client has type oauth2 then credentials object must contain properties access_token, refresh_token, otherwise if the type is other, then you can put in credentials any data that you want.

post/workspaces/{workspace_id}/secrets

Path parameters

workspace_idstring required

Workspace identifier

Request body

Example request

{
  "data": {
    "id": "5b4f337bff4304610483ba67",
    "links": {
      "self": "/v2/workspaces/5b4f337bff4304610483ba67/secrets/5b4f337bff4304610483ba67"
    },
    "attributes": {
      "name": "Secret name",
      "credentials": {
        "access_token": "ya29.a0AfH6SMC9aSZhds2dg3VpULECqzajjDE0qlyGDFfgxnBn8cwfj9cg_THWIpxPUSMsDcn70Obx_WwxXBQYfT8edbAIRJIsCiueyki6iTWA_DADbEx3n5vRU-pCXjSTav9s7Q",
        "refresh_token": "1//09cZWQ81C9F_-CgYIARAkSNwF-L9IrvRAYXy5RuPko6rRwzxfYPVykQep6cK7rUdHHSXIhiRw3fbZf3ReCI4DNuQStH_4JL2Y",
        "expires_in": 60,
        "additional_params": "access_type:offline,prompt:consent",
        "scope": "https://www.googleapis.com/auth/spreadsheets",
        "fields": {
          "base_url": "https://example.com"
        }
      },
      "type": "oauth2",
      "error": "Auth secret refreshing error"
    },
    "relationships": {
      "workspace": {
        "data": {
          "id": "5b4f337bff4304610483ba67"
        },
        "links": {
          "self": "/v2/workspaces/5b4f337bff4304610483ba67"
        }
      },
      "user": {
        "data": {
          "id": "5b4f337bff4304610483ba67"
        },
        "links": {
          "self": "/v2/users/5b4f337bff4304610483ba67"
        }
      },
      "auth_client": {
        "data": {
          "id": "5b4f337bff4304610483ba67"
        },
        "links": {
          "self": "/v2/tenants/5b4f337bff4304610483ba67/auth-clients/5b4f337bff4304610483ba67"
        }
      }
    }
  }
}

Response

Created

metaobject required

Example response

{
  "data": {
    "id": "5b4f337bff4304610483ba67",
    "links": {
      "self": "/v2/workspaces/5b4f337bff4304610483ba67/secrets/5b4f337bff4304610483ba67"
    },
    "attributes": {
      "name": "Secret name",
      "credentials": {
        "access_token": "ya29.a0AfH6SMC9aSZhds2dg3VpULECqzajjDE0qlyGDFfgxnBn8cwfj9cg_THWIpxPUSMsDcn70Obx_WwxXBQYfT8edbAIRJIsCiueyki6iTWA_DADbEx3n5vRU-pCXjSTav9s7Q",
        "refresh_token": "1//09cZWQ81C9F_-CgYIARAkSNwF-L9IrvRAYXy5RuPko6rRwzxfYPVykQep6cK7rUdHHSXIhiRw3fbZf3ReCI4DNuQStH_4JL2Y",
        "expires_in": 60,
        "additional_params": "access_type:offline,prompt:consent",
        "scope": "https://www.googleapis.com/auth/spreadsheets",
        "fields": {
          "base_url": "https://example.com"
        }
      },
      "type": "oauth2",
      "error": "Auth secret refreshing error"
    },
    "relationships": {
      "workspace": {
        "data": {
          "id": "5b4f337bff4304610483ba67"
        },
        "links": {
          "self": "/v2/workspaces/5b4f337bff4304610483ba67"
        }
      },
      "user": {
        "data": {
          "id": "5b4f337bff4304610483ba67"
        },
        "links": {
          "self": "/v2/users/5b4f337bff4304610483ba67"
        }
      },
      "auth_client": {
        "data": {
          "id": "5b4f337bff4304610483ba67"
        },
        "links": {
          "self": "/v2/tenants/5b4f337bff4304610483ba67/auth-clients/5b4f337bff4304610483ba67"
        }
      }
    }
  }
}