Me

Operations related to the logged in user

Get my user information

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/me

Get my user information by me (logged in user)

Authorizations

bearerAuthaccessToken

Responses

200

OK

application/json

Responseall of

and

401

Unauthorized

application/json

403

Forbidden

application/json

get

/me

HTTPcURLJavaScriptPython

GET /api/me HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "_id": "63ea10b94a472e003305232b",
  "username": "[email protected]",
  "language": "en",
  "region": "us",
  "firstName": "John",
  "lastName": "Doe",
  "status": 1,
  "attributes": {
    "iamUserId": "1234567890"
  },
  "avatarUrl": "text",
  "settings": {
    "mailOnBuildCompleted": true,
    "mailOnCodePushCompleted": true
  },
  "lastLoginAt": "2020-07-23T12:00:00.000Z",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z",
  "organization": {
    "_id": "63ea10b94a472e003305232b",
    "name": "Akinon",
    "slug": "hello-world",
    "description": "Akinon is a software company",
    "owner": "63ea10b94a472e003305232b",
    "isExecutive": false,
    "status": 1,
    "privileges": [
      "project:read",
      "project:write"
    ],
    "imageUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  },
  "roles": [
    {
      "_id": "63ea10b94a472e003305232b",
      "name": "Presentation",
      "description": "Presentation role",
      "organization": {
        "_id": "63ea10b94a472e003305232b",
        "name": "Akinon",
        "slug": "hello-world",
        "description": "Akinon is a software company",
        "owner": "63ea10b94a472e003305232b",
        "isExecutive": false,
        "status": 1,
        "privileges": [
          "project:read",
          "project:write"
        ],
        "imageUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
        "createdAt": "2020-07-23T12:00:00.000Z",
        "updatedAt": "2020-07-23T12:00:00.000Z"
      },
      "privileges": [
        "project:read",
        "project:write"
      ],
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z"
    },
    {
      "organization": "63ea10b94a472e003305232b"
    }
  ],
  "userType": "user"
}

Change my password

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/me

Change my password by me (logged in user)

Authorizations

bearerAuthaccessToken

Body

application/json

passwordstring · min: 3 · max: 255Required

The user old password

Example: 123456

newPasswordstring · min: 3 · max: 255Required

The user new password

Example: 123456

Responses

201

Created

No content

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post

/me

HTTPcURLJavaScriptPython

POST /api/me HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "password": 123456,
  "newPassword": 123456
}

No content

Update my user information

patch

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/me

Update my user information by me (logged in user)

Authorizations

bearerAuthaccessToken

Body

application/json

firstNamestring · min: 5 · max: 255Optional

The user first name

Example: John

lastNamestring · min: 5 · max: 255Optional

The user last name

Example: Doe

languagestring · min: 2 · max: 2Optional

The user language

Example: en

regionstring · min: 2 · max: 2Optional

The user region

Example: US

statusinteger · enumOptional

The status

Example: 1Possible values:

avatarUrlstringOptional

The user avatar URL

Example: https://akinon.s3.amazonaws.com/.../avatar.jpg

Responses

200

OK

application/json

Responseall of

and

401

Unauthorized

application/json

403

Forbidden

application/json

patch

/me

HTTPcURLJavaScriptPython

PATCH /api/me HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 211

{
  "firstName": "John",
  "lastName": "Doe",
  "language": "en",
  "region": "US",
  "status": 1,
  "avatarUrl": "https://akinon.s3.amazonaws.com/.../avatar.jpg",
  "settings": {
    "mailOnBuildCompleted": true,
    "mailOnCodePushCompleted": true
  }
}

{
  "_id": "63ea10b94a472e003305232b",
  "username": "[email protected]",
  "language": "en",
  "region": "us",
  "firstName": "John",
  "lastName": "Doe",
  "status": 1,
  "attributes": {
    "iamUserId": "1234567890"
  },
  "avatarUrl": "text",
  "settings": {
    "mailOnBuildCompleted": true,
    "mailOnCodePushCompleted": true
  },
  "lastLoginAt": "2020-07-23T12:00:00.000Z",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z",
  "organization": {
    "_id": "63ea10b94a472e003305232b",
    "name": "Akinon",
    "slug": "hello-world",
    "description": "Akinon is a software company",
    "owner": "63ea10b94a472e003305232b",
    "isExecutive": false,
    "status": 1,
    "privileges": [
      "project:read",
      "project:write"
    ],
    "imageUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  },
  "roles": [
    {
      "_id": "63ea10b94a472e003305232b",
      "name": "Presentation",
      "description": "Presentation role",
      "organization": {
        "_id": "63ea10b94a472e003305232b",
        "name": "Akinon",
        "slug": "hello-world",
        "description": "Akinon is a software company",
        "owner": "63ea10b94a472e003305232b",
        "isExecutive": false,
        "status": 1,
        "privileges": [
          "project:read",
          "project:write"
        ],
        "imageUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
        "createdAt": "2020-07-23T12:00:00.000Z",
        "updatedAt": "2020-07-23T12:00:00.000Z"
      },
      "privileges": [
        "project:read",
        "project:write"
      ],
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z"
    },
    {
      "organization": "63ea10b94a472e003305232b"
    }
  ],
  "userType": "user"
}

Get my public keys

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/me/public-keys

Get my public keys by me (logged in user)

Authorizations

bearerAuthaccessToken

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/me/public-keys

HTTPcURLJavaScriptPython

GET /api/me/public-keys HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[]

Create a public key

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/me/public-keys

Create a public key by me (logged in user)

Authorizations

bearerAuthaccessToken

Body

application/json

labelstring · min: 3 · max: 100Required

The public key label

Example: My public key

publicKeystring · min: 1024 · max: 16384Required

The public key

Example: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDQ4QXQ...

filePathstringOptional

The public key file path

Responses

201

Created

application/json

400

Bad Request

application/json

post

/me/public-keys

HTTPcURLJavaScriptPython

POST /api/me/public-keys HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "label": "My public key",
  "publicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDQ4QXQ...",
  "filePath": "text"
}

{
  "_id": "63ea10b94a472e003305232b",
  "label": "My public key",
  "status": 1,
  "publicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDQ4QXQ...",
  "awsPublicKeyId": "text",
  "filePath": "text",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Get a public key

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/me/public-keys/{publicKeyId}

Get a public key by me (logged in user)

Authorizations

bearerAuthaccessToken

Path parameters

publicKeyIdstringRequired

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/me/public-keys/{publicKeyId}

HTTPcURLJavaScriptPython

GET /api/me/public-keys/{publicKeyId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "_id": "63ea10b94a472e003305232b",
  "label": "My public key",
  "status": 1,
  "publicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDQ4QXQ...",
  "awsPublicKeyId": "text",
  "filePath": "text",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Delete a public key

delete

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/me/public-keys/{publicKeyId}

Delete a public key by me (logged in user)

Authorizations

bearerAuthaccessToken

Path parameters

publicKeyIdstringRequired

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

Responses

204

No Content

No content

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

delete

/me/public-keys/{publicKeyId}

HTTPcURLJavaScriptPython

DELETE /api/me/public-keys/{publicKeyId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get user access tokens

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/me/tokens

Get user access tokens by me (logged in user)

Authorizations

bearerAuthaccessToken

Responses

200

OK

application/json

Responseany of

401

Unauthorized

application/json

403

Forbidden

application/json

get

/me/tokens

HTTPcURLJavaScriptPython

GET /api/me/tokens HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "_id": "63ea10b94a472e003305232b",
    "name": "My Token",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
    "privileges": [
      "project:read"
    ],
    "userId": "63ea10b94a472e003305232b",
    "organizationId": "63ea10b94a472e003305232b",
    "expiresOn": "2020-07-23T12:00:00.000Z",
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  }
]

Create a user access token

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/me/tokens

Create a user access token by me (logged in user)

Authorizations

bearerAuthaccessToken

Body

application/json

namestringRequired

The access token name

Example: My Token

lifetimestring · enumRequired

The token lifetime

Possible values:

privilegesstring[]Optional

The token privileges

Example: organization:user:read

Responses

201

OK

application/json

400

Bad Request

application/json

post

/me/tokens

HTTPcURLJavaScriptPython

POST /api/me/tokens HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "name": "My Token",
  "lifetime": "one-week",
  "privileges": [
    "organization:user:read"
  ]
}

{
  "_id": "63ea10b94a472e003305232b",
  "name": "My Token",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
  "privileges": [
    "project:read"
  ],
  "userId": "63ea10b94a472e003305232b",
  "organizationId": "63ea10b94a472e003305232b",
  "expiresOn": "2020-07-23T12:00:00.000Z",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Delete a user access token

delete

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/me/tokens/{tokenId}

Delete a user access token by me (logged in user)

Authorizations

bearerAuthaccessToken

Path parameters

tokenIdstringRequired

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

Responses

204

No Content

No content

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

delete

/me/tokens/{tokenId}

HTTPcURLJavaScriptPython

DELETE /api/me/tokens/{tokenId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content