Interface IAdministeredIdentitiesMeApiKeys

Namespace

Meraki.Api.Interfaces.General.Administered

Assembly

Meraki.Api.dll

I Administered Identities Me Api Keys

public interface IAdministeredIdentitiesMeApiKeys

Methods

GenerateAdministeredIdentitiesMeApiKeysAsync(string, CancellationToken)

Generates an API key for an identity. For users who have access to more than one organization, the change will take up to five minutes to propagate. If one of the organizations is currently under maintenance, the change may not propagate fully until after the maintenance has been completed.

[Post("/administered/identities/me/api/keys/generate")]
Task<AdministeredIdentitiesMeGeneratedApiKey> GenerateAdministeredIdentitiesMeApiKeysAsync(string organizationId, CancellationToken cancellationToken = default)

Parameters

organizationId string

cancellationToken CancellationToken

Returns

Task<AdministeredIdentitiesMeGeneratedApiKey>

Exceptions

ApiException

Thrown when fails to make API call

GetAdministeredIdentitiesMeApiKeysAsync(string, CancellationToken)

List the non-sensitive metadata associated with the API keys that belong to the user

[Get("/administered/identities/me/api/keys")]
Task<List<AdministeredIdentitiesMeApiKey>> GetAdministeredIdentitiesMeApiKeysAsync(string organizationId, CancellationToken cancellationToken = default)

Parameters

organizationId string

cancellationToken CancellationToken

Returns

Task<List<AdministeredIdentitiesMeApiKey>>

Exceptions

ApiException

Thrown when fails to make API call

RevokeAdministeredIdentitiesMeApiKeysAsync(string, string, CancellationToken)

Revokes an identity's API key, using the last four characters of the key. For users who have access to more than one organization, the change will take up to five minutes to propagate. If one of the organizations is currently under maintenance, the change may not propagate fully until after the maintenance has been completed.

[Post("/administered/identities/me/api/keys/{suffix}/revoke")]
Task RevokeAdministeredIdentitiesMeApiKeysAsync(string organizationId, string suffix, CancellationToken cancellationToken = default)

Parameters

organizationId string

suffix string

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call